developer_guide.md

Developer Guide

Environment

Poetry setup

If you do not already have poetry installed, install it following the Poetry installation documentation.

Then install dependencies from poetry.lock:

cd ro-crate-uploader
poetry install

Activate the virtual environment:

poetry shell

Zenodo access token setup

Configure Zenodo access token(s) as in user guide - Set up a Zenodo personal access token.

Run tests

Beware that tests can make Zenodo uploads using your access token.

In the root directory:

pytest

Publish a release

1. Update the version in pyproject.toml
2. Make a git tag for the release and push it to GitHub
3. Run poetry build
4. Run poetry publish -u <username> -p <password_or_api_key>
5. Create a release on GitHub, including the build artifacts