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

README.md: Add note about Python version

This commit is contained in:
Alan Orth 2019-07-29 12:15:09 +03:00
parent 8e3e7a3573
commit 3554c2991f
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9

View File

@ -1,7 +1,7 @@
# CSV Metadata Quality [![builds.sr.ht status](https://builds.sr.ht/~alanorth/csv-metadata-quality.svg)](https://builds.sr.ht/~alanorth/csv-metadata-quality?) # CSV Metadata Quality [![builds.sr.ht status](https://builds.sr.ht/~alanorth/csv-metadata-quality.svg)](https://builds.sr.ht/~alanorth/csv-metadata-quality?)
A simple but opinionated metadata quality checker and fixer designed to work with CSVs in the DSpace ecosystem. Supports multi-value fields using the standard DSpace value separator ("||"). Despite the name it does support reading Excel files. A simple but opinionated metadata quality checker and fixer designed to work with CSVs in the DSpace ecosystem. Supports multi-value fields using the standard DSpace value separator ("||"). Despite the name it does support reading Excel files.
Written and tested using Python 3.7. CSV and Excel support comes from the [Pandas](https://pandas.pydata.org/) library. Requires Python 3.6 or greater. CSV and Excel support comes from the [Pandas](https://pandas.pydata.org/) library.
## Functionality ## Functionality
@ -44,6 +44,8 @@ To validate and clean a CSV file you must specify input and output files using t
$ python -m csv_metadata_quality -i data/test.csv -o /tmp/test.csv $ python -m csv_metadata_quality -i data/test.csv -o /tmp/test.csv
``` ```
You can enable "unsafe fixes" with the `--unsafe-fixes` option. This will attempt
## Todo ## Todo
- Reporting / summary - Reporting / summary