Shepherd-WebAPI

Testbed-WebAPI: https://shepherd.cfaed.tu-dresden.de:8000

Main Documentation: https://nes-lab.github.io/shepherd

Source Code: https://github.com/nes-lab/shepherd-webapi

Main Project: https://github.com/nes-lab/shepherd

---

This repo contains:

• shepherd-client-sources in /shepherd_client
• shepherd-server-sources in /shepherd_server

Development & Release

The project contains a config for dev-environment in the root pyproject.toml. It can be activated via uv:

uv venv
uv pip install .

Testbench & Static Analysis

Warning: ☠☠☠ Don't run unittests (pytest) on a production system as it will delete the database! ☠☠☠

pre-commit run -a

pytest
# or
pytest --stepwise

Code Coverage

coverage run -m pytest

coverage html
# or simpler
coverage report

Release-Procedure

• increase version number by executing bump2version (see cmds below)
• update changelog in CHANGELOG.md
• run unittests locally
  • additionally every push gets automatically tested by GitHub workflows
• install and run pre-commit for QA-Checks, see steps above
• move code from dev-branch to main by PR
• add tag to commit - reflecting current version number - i.e. v25.5.1
  • GitHub automatically creates a release
• update release-text with latest Changelog (from CHANGELOG.md)
• rebase dev-branch

bump2version --allow-dirty --new-version 2025.10.1 patch
# ⤷ format: year.month.patch_release