ESCAPE OSSR library
Project description
The ESCAPE OSSR library
The eOSSR is the Python library to programmatically manage the ESCAPE OSSR. In particular, it includes:
- an API to access the Zenodo and the OSSR, retrieve records and publish content
- functions to map and convert metadata from CodeMeta to Zenodo metadata shema
- functions to validate their
codemeta.json
file against OSSR requirements - functions to help developers automatically publish to Zenodo and contribute to the OSSR, in particular using their continuous integration (see also code snippets)
Code: https://gitlab.com/escape-ossr/eossr
Documentation: https://escape-ossr.gitlab.io/eossr/
Former stable versions
Install
For users
pip install eossr
You can also run it with docker:
docker run -it registry.gitlab.com/escape-ossr/eossr:latest
Visit our registry to see the available docker containers.
Note that latest
tag always point to the latest stable released container. For reproducible results, use a tagged version.
For developers
git clone https://gitlab.com/escape-ossr/eossr.git
cd eossr
pip install -e .
Running tests
To run tests locally, run:
pip install -e ".[tests]"
pytest eossr
Some tests will be skiped if SANDBOX_ZENODO_TOKEN
is not defined in your environment variables.
If you want to run these tests, you will need to create a sandbox zenodo token and add it to your env:
export SANDBOX_ZENODO_TOKEN="your_sandbox_token"
Online CodeMeta validator for the OSSR
The eOSSR powers an online validator for your CodeMeta metadata and to convert it to Zenodo metadata:
License
See LICENSE
Cite
To cite this library, please cite our ADASS proceedings:
@misc{https://doi.org/10.48550/arxiv.2212.00499,
doi = {10.48550/ARXIV.2212.00499},
url = {https://arxiv.org/abs/2212.00499},
author = {Vuillaume, Thomas and Garcia, Enrique and Tacke, Christian and Gal, Tamas},
keywords = {Instrumentation and Methods for Astrophysics (astro-ph.IM), FOS: Physical sciences, FOS: Physical sciences},
title = {The eOSSR library},
publisher = {arXiv},
year = {2022},
copyright = {arXiv.org perpetual, non-exclusive license}
}
If you used the library in a workflow, please cite the version used as well, using the cite section in the Zenodo page (right column, below the Versions
section).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.