A Python package to validate RO-Crate packages.
Note: this software is still work in progress. Feel free to try it out, report positive and negative feedback. Do send a note (e.g., by opening an Issue) before starting to develop patches you would like to contribute. The implementation of validation code for additional RO-Crate profiles would be particularly welcome.
Follow these steps to set up the project:
git clone https://github.com/crs4/rocrate-validator.git
cd rocrate-validator
Set up a Python virtual environment using venv
:
python3 -m venv .venv
source .venv/bin/activate
Or using virtualenv
:
virtualenv .venv
source .venv/bin/activate
This step, while optional, is recommended for isolating your project dependencies. If skipped, Poetry will automatically create a virtual environment for you.
Ensure you have Poetry installed. If not, follow the instructions here. Then, install the project:
poetry install
After installation, you can use the main command rocrate-validator
to validate ROCrates.
Run the validator using the following command:
poetry run rocrate-validator validate <path_to_rocrate>
Replace <path_to_rocrate>
with the path to the RO-Crate you want to validate.
Type poetry run rocrate-validator --help
for more information.
Activate the virtual environment:
source .venv/bin/activate
Then, run the validator using the following command:
rocrate-validator validate <path_to_rocrate>
Replace <path_to_rocrate>
with the path to the RO-Crate you want to validate.
Type rocrate-validator --help
for more information.
To run the tests, use the following command:
poetry run pytest
This project is licensed under the terms of the Apache License 2.0. See the LICENSE file for details.
This work has been partially funded by the following sources:
<img alt="Co-funded by the EU" src="https://raw.githubusercontent.com/crs4/rocrate-validator/develop/docs/img/eu-logo/EN_Co-fundedbytheEU_RGB_POS.png" width="250" align="right"/>