Developer guide#

Development installation#

If you have postgres available, (perhaps with brew install postgresql on macOS), you can prepare an editable installation and run the tests:

make setup
. .venv/bin/activate
pytest redun

# Other targets
make lint
make format

Release#

Release Steps#

  1. Prepare a release branch and make a PR from this branch with an updated:

    • version in pyproject.toml and redun._version.py - new version number should follow semantic versioning rules (see semver.org for details)

    • CHANGELOG - use release_notes.py script to generate the release notes (see that script for usage)

    • uv.lock - run uv lock to update the lockfile after changing the version

  2. Merge the release branch to main

  3. Create and push a new version tag: make release