1
0
mirror of https://github.com/ilri/csv-metadata-quality.git synced 2024-12-22 12:12:18 +01:00

README.md: Add usage section

This commit is contained in:
Alan Orth 2019-07-29 11:30:06 +03:00
parent aabb57321c
commit ac127e7f8a
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9

View File

@ -31,6 +31,19 @@ $ source venv/bin/activate
$ pip install -r requirements.txt
```
## Usage
Run CSV Metadata Quality with the `--help` flag to see available options:
```
$ python -m csv_metadata_quality --help
```
To validate and clean a CSV file you must specify input and output files using the `-i` and `-o` options. For example, using the included test file:
```
$ python -m csv_metadata_quality -i data/test.csv -o /tmp/test.csv
```
## Todo
- Reporting / summary