Fast & simple summary for large CSV files


Keywords
csvinsight
License
MIT
Install
pip install csvinsight==0.4.0

Documentation

csvinsight

image

Build Status

Documentation Status

Updates

Fast & simple summary for large CSV files

Features

  • Calculates basic stats for each column: max, min, mean length; number of non-empty values
  • Calculates exact number of unique values and the top 20 most frequent values
  • Supports non-orthogonal data (list fields)
  • Works with very large files: does not load the entire CSV into memory
  • Fast splitting of CSVs into columns, one file per column
  • Multiprocessing-enabled

Example Usage

Given a CSV file:

bash-3.2$ cat tests/sampledata.csv
name|age|fave_color
Alexey|33|red;yellow
Boris|31|blue
Valentina|0|

you can obtain a CsvInsight report with:

bash-3.2$ csvi tests/sampledata.csv --list-fields fave_color
CSV Insight Report
Total # Rows: 3
Column counts:
        3  columns ->  3 rows

Report Format:
Column Number. Column Header -> Uniques: # ; Fills: # ; Fill Rate:
Field Length: min #, max #, average:
 Top n field values -> Dupe Counts


1. name -> Uniques: 3 ; Fills: 3 ; Fill Rate: 100.0%
    Field Length:  min 5, max 9, avg 6.67
        Counts      Percent  Field Value
        1           33.33 %  Valentina
        1           33.33 %  Boris
        1           33.33 %  Alexey

2. age -> Uniques: 3 ; Fills: 3 ; Fill Rate: 100.0%
    Field Length:  min 1, max 2, avg 1.67
        Counts      Percent  Field Value
        1           33.33 %  33
        1           33.33 %  31
        1           33.33 %  0

3. fave_color -> Uniques: 4 ; Fills: 3 ; Fill Rate: 75.0%
    Field Length:  min 0, max 6, avg 3.25
        Counts      Percent  Field Value
        1           25.00 %  yellow
        1           25.00 %  red
        1           25.00 %  blue
        1           25.00 %  NULL

Since CSV comes in different flavors, you may need to tweak the underlying CSV parser's parameters to read your file successfully. CSVInsight handles this via CSV dialects. For example, to read a comma-separated file, you would use the following command:

bash-3.2$ csvi your/file.csv --dialect delimiter=,

You may combine as many dialect parameters as needed:

bash-3.2$ csvi your/file.csv --dialect delimiter=, quoting=QUOTE_NONE

For a full list of dialect parameters, see the documentation for Python's csv module. Constant values like QUOTE_NONE are resolved automagically.

Once you've discovered the winning parameter combination for your file, save it to a YAML file:

list_fields:
  - fave_color
  - another_field_name
list_separator: ;
dialect:
  - "delimiter=|"
  - "quoting=QUOTE_NONE"

You can then invoke CSVI as follows:

bash-3.2$ csvi your/file.csv --config your/config.yaml

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.