HermesBaby
The Software and Systems Engineers' Typewriter
Meant to be the authoring environment to get our work done.
Purpose
Using HermesBaby to Enable Docs-as-Code in Corporate Environments
HermesBaby provides a curated toolbox and clean command-line interface that operationalizes the Docs-as-Code approach across engineering organizations. It is designed to simplify both the authoring experience for engineers and the integration into corporate environments — including CI/CD, documentation portals, and internal security policies.
For document authors, HermesBaby makes Docs-as-Code accessible:
- Projects are scaffolded from templates in seconds.
- Authoring happens in the same environment used for code development.
- Build, preview, and publish commands are cleanly separated and easy to use.
- Kconfig-based configuration offers clarity and traceability without clutter.
At the same time, HermesBaby is built for integration at scale:
- It works seamlessly with CI pipelines and version-controlled repositories.
- It supports custom toolchains and validates external dependencies automatically.
- It installs and configures required build tools, linters, and extensions — even in headless or air-gapped environments.
- It ensures predictable and compliant deployments via SSH-based publishing and access control via
.htaccess.
HermesBaby doesn't just promote structured authoring — it makes documentation controllable, auditable, and cyber-secure. Its infrastructure-aware design allows teams to:
- Verify toolchains before use.
- Lock down deployment keys and paths.
- Comply with internal policies and regulatory requirements.
By lowering the barrier to entry for engineers while raising the bar on control and compliance, HermesBaby bridges the cultural and technical gap between grassroots Docs-as-Code practices and enterprise-grade documentation workflows.
See also: «Article» Engineering Mechatronic Product Lines using the Docs-as-Code Approach
Installation
While it's possible to install it globally via pip, it's recommended to install it via uv tool to keep your system clean and tidy since hermesbaby brings many Python packages with it.
python3 -m pip install uv
uv tool update-shell
uv tool install hermesbaby
Using pipx is common as well :
python3 -m pip install pipx
pipx ensurepath
python3 -m pipx install hermesbaby
You update it later via:
uv tool update hermesbaby
respectively, in case you work with pipx:
python3 -m pipx upgrade hermesbaby
First usage
Close the gaps by installing the missing tools. You may use the help hermesbaby gave you to do so.
Beside hermesbaby there is a second, shorter alias:
hb
Check environment for prerequisites
hb tools check
Start your first new virtual piece of writing
hb new --list-templates
hb new --template hello some_dir
cd some_dir
hb html-live
CTRL-C.
Start editing
git init .
code .
Click Statusbar / html-live
Apply changes to some docs/*/index.md ... and so on.
Happy coding specifications ;-) "
Development and Testing
Running End-to-End (E2E) Tests
The E2E tests are written using BATS. To run them manually, ensure you have the project dependencies installed via Poetry.
# Enable the virtual environment:
poetry install --with dev
# Set up the development environment after you have cloned the repository:
# a) Windows (in git-bash):
source ./.venv/Scripts/activate
# b) Linux / macOS:
# source ./.venv/bin/activate
# Enter the TDD-Loop:
# 1) Run not all tests but the tests focussing on the feature you want to implement, e.g. for bibliographies:
cd "$(pwd -P)" # Necessary in git-bash on Windows
tests/e2e/bats/bin/bats tests/e2e/test-bibliographies.bats -x --show-output-of-passing-tests
# 2) edit your files
code .
# Go to 1) and repeat until you are happy with the implementation.
# After the 2nd run, you can compare the outputs with using Beyond Compare:
bcomp tests/data/bibliographies/out_1 tests/data/bibliographies/out &
# After you are done, you can run all tests to check if everything is fine:
tests/e2e/bats/bin/bats tests/e2e/ -x
1 maintainer
Metadata
1 maintainer
Release files for hermesbaby 2026.9.14.52
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hermesbaby-2026.9.14.52.tar.gz | 103.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hermesbaby-2026.9.14.52-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 206.4 MB
Release files / hermesbaby-2026.9.14.52.tar.gz
| Download URL | hermesbaby-2026.9.14.52.tar.gz |
|---|---|
| Size | 103.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5813460fd33b021d8c0d5213667ec050adf6ceb80618ad21057f2ef5b733325c
|
|
BLAKE2b-256 checksum How to use checksums |
f5c1fef19892f4c95eeaee78d43c48ede3b52ed42af668dca65aeb474e54918a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.12.3 Linux/6.17.0-1022-azure
|
Release files / hermesbaby-2026.9.14.52-py3-none-any.whl
| Download URL | hermesbaby-2026.9.14.52-py3-none-any.whl |
|---|---|
| Size | 103.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e25d277adbb57faa0bedd7806da1297a667121d907b0c70379516e984aff694f
|
|
BLAKE2b-256 checksum How to use checksums |
9e77861c410a8e4b53143a68739770566ad5d5da8ba9754812637995a6dce4e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.12.3 Linux/6.17.0-1022-azure
|
