Skip to content

Developer Notes

If you would like to contribute, please read CONTRIBUTING.md.

Development Install and Unit Tests

First, create a StepUp Core development installation. The following commands assume you create stepup-core and step-reprep source trees as subdirectories of the same parent.

Clone the StepUp RepRep repository and create a virtual environment using the following commands

git clone git@github.com:reproducible-reporting/stepup-reprep.git
cd stepup-reprep
pre-commit install
python -m venv venv

Put the following two lines in .envrc:

source venv/bin/activate
export XDG_CACHE_HOME="${VIRTUAL_ENV}/cache"

Finally, run the following commands:

direnv allow
pip install -U pip
pip install -e .[dev]
pip install -e ../stepup-core[dev]  # optional
pytest -vv

Documentation

The documentation is created with MkDocs.

Edit the documentation markdown files with a live preview by running:

mkdocs serve

(Keep this running.) Then open the live preview in your browser: http://127.0.0.1:8000/ and edit Markdown files in your IDE.

Please, use Semantic Line Breaks because it results in cleaner file diffs when editing documentation.

How to Make a Release

  • Mark the release in changelog.md.
  • Make a new commit and tag it with vX.Y.Z.
  • Trigger the PyPI GitHub Action: git push origin main --tags.