Developer Notes¶

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

Development environment¶

If you break your development environment, you can discard it by running git clean -dfX and repeating the instructions below.

A local installation for testing and development can be installed using the following commands:

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

Put the following lines in .envrc:

source venv/bin/activate
export XDG_CACHE_HOME="${VIRTUAL_ENV}/cache"
export STEPUP_DEBUG="1"
export STEPUP_SYNC_RPC_TIMEOUT="30"

Finally, run the following commands:

direnv allow
pip install -U pip
pip install -e .
pip install -e ../stepup-core[dev] --config-settings editable_mode=strict  # optional

We use pytest, so you can run the tests as follows:

pytest -vv

The documentation is created using MkDocs. mike is used to manage documentation of different versions

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

mkdocs serve

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

Please, use Semantic Line Breaks because it facilitates reviewing documentation changes.

If you wish to regenerate the output of the examples, run stepup in the docs directory:

cd docs
stepup

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

Mark the release in docs/changelog.md. Do not forget to extend the links at the bottom of the file.
Make a new commit and tag it with vX.Y.Z.
Trigger the PyPI GitHub Action: git push origin main --tags.