mirror of
https://github.com/ilri/csv-metadata-quality.git
synced 2024-11-18 20:17:04 +01:00
README.md: Improve
Reorganize functionality section and add installation section.
This commit is contained in:
parent
a8a41d60b6
commit
aabb57321c
34
README.md
34
README.md
@ -3,19 +3,33 @@ A simple but opinionated metadata quality checker and fixer designed to work wit
|
|||||||
|
|
||||||
Written and tested using Python 3.7. CSV and Excel support comes from the [Pandas](https://pandas.pydata.org/) library.
|
Written and tested using Python 3.7. CSV and Excel support comes from the [Pandas](https://pandas.pydata.org/) library.
|
||||||
|
|
||||||
## Checks
|
## Functionality
|
||||||
Supports checking the validity of the following metadata elements:
|
|
||||||
|
|
||||||
- ISSN
|
- Read/write CSV files ✓
|
||||||
- ISBN
|
- Read Excel files ✓
|
||||||
- Multi-value separators ("||")
|
- Validate dates, ISSNs, ISBNs, and multi-value separators ("||") ✓
|
||||||
- Dates
|
- Fix leading, trailing, and excessive whitespace ✓
|
||||||
|
- Fix invalid multi-value separators ("|") using `--unsafe-fixes` ✓
|
||||||
|
|
||||||
## Fixes
|
## Installation
|
||||||
Supports fixing the following metadata issues:
|
The easiest way to install CSV Metadata Quality is with [pipenv](https://github.com/pypa/pipenv):
|
||||||
|
|
||||||
- Leading, trailing, and excessive whitespace
|
```
|
||||||
- Invalid multi-value separators ("|") using `--unsafe-fixes`
|
$ git clone https://git.sr.ht/~alanorth/csv-metadata-quality
|
||||||
|
$ cd csv-metadata-quality
|
||||||
|
$ pipenv install
|
||||||
|
$ pipenv shell
|
||||||
|
```
|
||||||
|
|
||||||
|
Otherwise, if you don't have pipenv, you can use a vanilla Python virtual environment:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git clone https://git.sr.ht/~alanorth/csv-metadata-quality
|
||||||
|
$ cd csv-metadata-quality
|
||||||
|
$ python3 -m venv venv
|
||||||
|
$ source venv/bin/activate
|
||||||
|
$ pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user