Metadata-Version: 2.4
Name: hermesbaby
Version: 2026.10.18.54
Summary: The Software and Systems Engineers' Typewriter
Author-email: Alexander Mann-Wahrenberg <alexander.mannwahrenberg@gmail.com>
License-Expression: LicenseRef-HermesBaby
Requires-Python: <4.0,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: licenses/LICENSE-CC-BY-SA-40
License-File: licenses/LICENSE-MIT
Requires-Dist: atlassian-python-api<4.0.0,>=3.41.14
Requires-Dist: beautifulsoup4<5.0.0,>=4.12.3
Requires-Dist: cookiecutter<3.0.0,>=2.6.0
Requires-Dist: gitpython<4.0.0,>=3.1.43
Requires-Dist: jupyter-sphinx<0.6.0,>=0.5.3
Requires-Dist: kconfiglib<15.0.0,>=14.1.0
Requires-Dist: windows-curses<3.0,>=2.3; sys_platform == "win32"
Requires-Dist: myst-nb<2.0.0,>=1.1.0
Requires-Dist: pandas<3.0.0,>=2.2.2
Requires-Dist: pillow<13.0.0,>=10.3.0
Requires-Dist: pip-system-certs<5.0,>=4.0
Requires-Dist: pyad<0.7.0,>=0.6.0
Requires-Dist: pywin32; sys_platform == "win32"
Requires-Dist: pytz<2025.0,>=2024.1
Requires-Dist: pyyaml<7.0.0,>=6.0.1
Requires-Dist: robotframeworklexer<2.0,>=1.1
Requires-Dist: setuptools>=70.0.0
Requires-Dist: sphinx
Requires-Dist: sphinx-autobuild<2025.0.0,>=2024.10.3
Requires-Dist: sphinx-intl<3.0.0,>=2.3.1
Requires-Dist: sphinx-copybutton<0.6.0,>=0.5.2
Requires-Dist: sphinx-datatables<0.3.0,>=0.2.1
Requires-Dist: sphinx-design<0.7.0,>=0.6.0
Requires-Dist: sphinx-material<0.0.37,>=0.0.36
Requires-Dist: sphinx-mdinclude<0.7.0,>=0.6.1
Requires-Dist: sphinx-tags<0.4.0,>=0.3.1
Requires-Dist: sphinx-toolbox<4.0.0,>=3.7.0
Requires-Dist: sphinxcontrib-bibtex<3.0.0,>=2.6.2
Requires-Dist: sphinxcontrib-datatemplates<0.12.0,>=0.11.0
Requires-Dist: sphinxcontrib-details-directive<0.2.0,>=0.1.0
Requires-Dist: sphinxcontrib-mermaid<0.10.0,>=0.9.2
Requires-Dist: sphinxcontrib-plantuml<0.30,>=0.29
Requires-Dist: sphinxcontrib-svg2pdfconverter<3.0.0,>=2.0.0
Requires-Dist: sphinxext-rediraffe<0.3.0,>=0.2.7
Requires-Dist: typer<0.16.0,>=0.15.1
Requires-Dist: tzlocal<6.0,>=5.2
Requires-Dist: mlx-traceability<12.0.0,>=11.7.0
Requires-Dist: myst-parser<5.0.0,>=4.0.0
Requires-Dist: linkify-it-py<3.0.0,>=2.0.3
Requires-Dist: sphinxcontrib-xlsxtable<2.0.0,>=1.1.1
Requires-Dist: sphinx-inline-svg<0.3.0,>=0.2.0
Dynamic: license-file

<!---
################################################################
#                                                              #
#  This file is part of HermesBaby                             #
#                       the software engineer's typewriter     #
#                                                              #
#      https://github.com/hermesbaby                           #
#                                                              #
#  Copyright (c) 2024 Alexander Mann-Wahrenberg (basejumpa)    #
#                                                              #
#  License(s)                                                  #
#                                                              #
#  - MIT for contents used as software                         #
#  - CC BY-SA-4.0 for contents used as method or otherwise     #
#                                                              #
################################################################
-->

# 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](https://basejumpa.github.io/blog/2025-08-Docs-As-Code-In-Engineering)

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

```bash
python3 -m pip install uv
uv tool update-shell

uv tool install hermesbaby
```

Using `pipx` is common as well  :

```bash
python3 -m pip install pipx
pipx ensurepath

python3 -m pipx install hermesbaby
```

You update it later via:

```bash
uv tool update hermesbaby
```

respectively, in case you work with `pipx`:

```bash
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:

```bash
hb
```

Check environment for prerequisites

```bash
hb tools check
```

Start your first new virtual piece of writing

```bash
hb new --list-templates
hb new --template hello some_dir
cd some_dir
hb html-live
```

CTRL-C.

Start editing

```bash
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](https://github.com/bats-core/bats-core). To run them manually, ensure you have [uv](https://docs.astral.sh/uv/) installed and run `uv sync --all-groups`.

```bash
# Enable the virtual environment:
uv sync --all-groups
# 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
uv run 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:
uv run tests/e2e/bats/bin/bats tests/e2e/ -x
```
