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

README.md: Update installation and usage instructions

Browse Source 
It is much easier now that I have created a proper package.
This commit is contained in:
Alan Orth 2019-07-31 17:41:18 +03:00
parent cec1a34dfe
commit fd3861e7cd
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -23,6 +23,7 @@ $ git clone https://git.sr.ht/~alanorth/csv-metadata-quality
$ cd csv-metadata-quality $ cd csv-metadata-quality
$ pipenv install $ pipenv install
$ pipenv shell $ pipenv shell
$ pip install .
``` ```
Otherwise, if you don't have pipenv, you can use a vanilla Python virtual environment: Otherwise, if you don't have pipenv, you can use a vanilla Python virtual environment:
@ -33,19 +34,20 @@ $ cd csv-metadata-quality
$ python3 -m venv venv $ python3 -m venv venv
$ source venv/bin/activate $ source venv/bin/activate
$ pip install -r requirements.txt $ pip install -r requirements.txt
$ pip install .
``` ```
## Usage ## Usage
Run CSV Metadata Quality with the `--help` flag to see available options: Run CSV Metadata Quality with the `--help` flag to see available options:
``` ```
$ python -m csv_metadata_quality --help $ 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: 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 $ csv-metadata-quality -i data/test.csv -o /tmp/test.csv
``` ```
## Unsafe Fixes ## Unsafe Fixes