https://github.com/nes-lab/shepherd-webapi
Interface between the Testbed Instance and the User
https://github.com/nes-lab/shepherd-webapi
Last synced: 6 months ago
JSON representation
Interface between the Testbed Instance and the User
- Host: GitHub
- URL: https://github.com/nes-lab/shepherd-webapi
- Owner: nes-lab
- License: mit
- Created: 2021-04-06T12:11:27.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-12-12T12:45:03.000Z (7 months ago)
- Last Synced: 2026-01-19T11:38:35.920Z (6 months ago)
- Language: Python
- Homepage: https://testbed.nes-lab.org
- Size: 2.95 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Shepherd-WebAPI
[](https://pypi.org/project/shepherd_client)
[](https://github.com/nes-lab/shepherd-webapi/actions/workflows/quality_assurance.yaml)
**Testbed-WebAPI**:
**Main Documentation**:
**Source Code**:
**Main Project**:
---
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`:
```Shell
uv venv
uv pip install .
```
### Testbench & Static Analysis
**Warning**: ☠☠☠ Don't run unittests (`pytest`) on a production system as it will delete the database! ☠☠☠
```Shell
pre-commit run -a
pytest
# or
pytest --stepwise
```
### Code Coverage
```shell
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
```Shell
bump2version --allow-dirty --new-version 2025.10.1 patch
# ⤷ format: year.month.patch_release
```