csv-metadata-quality-web/README.md

36 lines
1.5 KiB
Markdown
Raw Normal View History

<h1 align="center">Online DSpace CSV Metadata Quality Checker</h1>
<p align="center">
<a href="https://github.com/ilri/csv-metadata-quality-web/actions"><img alt="Build Status" src="https://github.com/ilri/csv-metadata-quality-web/workflows/Build/badge.svg"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
2021-12-08 19:35:27 +01:00
<p align="center">
<img width="600" alt="Screenshot of csv-metadata-quality-web on Heroku" src="screenshot.png">
</p>
2021-03-14 12:54:03 +01:00
You can try [the hosted version](https://fierce-ocean-30836.herokuapp.com) or host it yourself (see below).
2021-12-08 19:19:33 +01:00
## Usage
Create a Python 3.7+ virtual environment and install the dependencies:
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
## Running Locally
$ gunicorn csv_metadata_quality_web.main
And then visit http://localhost:8000/ in your browser.
## Deploying to Heroku
Install the heroku command line tools, add a heroku git remote, and push:
$ git push heroku
## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
The license allows you to use and modify the work for personal and commercial purposes, but if you distribute the work you must provide users with a means to access the source code for the version you are distributing. Read more about the [GPLv3 at TL;DR Legal](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).