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

• v1.0:
• v0.6:
• v0.5:
• v0.4:
• v0.3.3:
• v0.2 :

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

If using this library, please cite the ESCAPE OSSR project using:

@Article{ 10.12688/openreseurope.15692.2,
AUTHOR = { Vuillaume, T and Al-Turany, M and Füßling, M and Gal, T and Garcia, E and Graf, K and Hughes, G and Kettenis, M and Kresan, D and Schnabel, J and Tacke, C and Verkouter, M},
TITLE = {The ESCAPE Open-source Software and Service Repository [version 2; peer review: 5 approved]
},
JOURNAL = {Open Research Europe},
VOLUME = {3},
YEAR = {2023},
NUMBER = {46},
DOI = {10.12688/openreseurope.15692.2}
}

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).