CSV Schema Definition and Validation

Install

pip install csv-schema

Usage

usage: csv-schema [-h] [--version] {validate-config,validate-csv,generate-config} ...

CSV Schema

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

Commands:
  {validate-config,validate-csv,generate-config}
    validate-config     Validates the CSV schema JSON configuration file.
    validate-csv        Validates a CSV file against a schema.
    generate-config     Generate a CSV schema JSON configuration file.

Definition

The CSV file schema definition is defined in a JSON file in the following format.

File Definition:

{
  "name": null,
  "description": null,
  "filename": {
    "regex": null
  },
  "columns": []
}

filename

{
  "regex": null
}

Column Definitions:

string

{
  "type": "string",
  "name": null,
  "required": true,
  "null_or_empty": false,
  "regex": null,
  "min": null,
  "max": null
}

integer

{
  "type": "integer",
  "name": null,
  "required": true,
  "null_or_empty": false,
  "regex": null,
  "min": null,
  "max": null
}

decimal

{
  "type": "decimal",
  "name": null,
  "required": true,
  "null_or_empty": false,
  "regex": null,
  "min": null,
  "max": null,
  "precision": 2
}

enum

{
  "type": "enum",
  "name": null,
  "required": true,
  "null_or_empty": false,
  "values": []
}

Development

Setup

pipenv --three
pipenv shell
make pip_install
make build
make install_local

See Makefile for all commands.

Update README Definitions

The schema definition is auto generated by running scripts/generate_md_help.py. Copy/paste the output into the README.md file.

Testing

• Create and activate a virtual environment:
• Run the tests: make test