HERMES - Template

Support namespace package template to interface a new device or algorithm in HERMES.

Installation

Provide additional installation requirements (e.g. any OEM SDK, settings in a 3rd party app, etc.).

From PyPI

pip install pysio-hermes-<pkg_name>

From source

git clone https://github.com/maximyudayev/hermes-<pkg_name>.git
pip install -e hermes-<pkg_name>

Usage

Using the device/algorithm follows the standard configuration file specification process of HERMES nodes.

Building

Building and releasing packages is easy with UV. Install git-changelog to auto-generate release notes from commit history: uv tool install git-changelog ruff.

1. Run auto-formatter: ruff format .
2. Commit all changes for the next release
3. Bump the package version with UV: uv version --bump <[major,minor,patch]>
4. Use the new version number to update the CHANGELOG.md: git-changelog --bump <above_version> -c angular -s :all:
5. Commit the updates as: git commit -m "release: v<above_version>"
6. Tag the release commit: git tag <above_version>
7. Build the package: uv build
8. Publish on PyPi: uv publish --token <your_pypi_token>

Citation

When using any parts of this repository outside of its intended use, please cite the parent project HERMES.