Metadata submission service to handle submissions of EGA metadata, either as XML files or via form submissions. Submissions through graphical frontend and POST are supported. Service also validates submitted metadata objects against EGA XSD metadata models and saves objects to database.
Requirements:
- Python 3.7+
- MongoDB
- Docker + docker-compose
For quick testing, launch both server and database with Docker by running docker-compose up --build (add -d flag to run containers in background). Server can then be found from http://localhost:5430.
For more detailed setup, do following:
- Install project by running:
pip install .in project root - Setup mongodb and env variables via desired way, details:
- Server expects to find mongodb instance running, specified with following environment variables:
MONGO_INITDB_ROOT_USERNAME, username for admin user to mondogdb instanceMONGO_INITDB_ROOT_PASSWORD, password for admin user to mondogdb instanceMONGODB_HOST, host and port for mongodb instance (e.g.localhost:27017)
- Out of the box, metadata submitter is configured with default values from MongoDB Docker image
- Suitable mongodb instance can be launched with Docker by running
docker-compose up database
- Server expects to find mongodb instance running, specified with following environment variables:
- After installing and setting up database, server can be launched with
metadata_submitter
If you also need frontend for development, check out frontend repository.
Tests can be run with tox automation: just run tox on project root (remember to install it first with pip install tox).
Production version can be built and run with following docker commands:
docker build --no-cache . -t metadata-submitter
docker run -p 5430:5430 metadata-submitter
Frontend is built and added as static files to backend while building.
Metadata submission interface is released under MIT, see LICENSE.
If you want to contribute to a project and make it better, your help is very welcome. For more info about how to contribute, see CONTRIBUTING.