Metadata-Version: 2.3
Name: hermesbaby
Version: 2025.8.31.37
Summary: The Software and Systems Engineers' Typewriter
License: MIT for contents used as software, CC BY-SA-4.0 for contents used as method or otherwise
Author: basejumpa
Author-email: alexander.mannwahrenberg@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: atlassian-python-api (>=3.41.14,<4.0.0)
Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
Requires-Dist: cookiecutter (>=2.6.0,<3.0.0)
Requires-Dist: gitpython (>=3.1.43,<4.0.0)
Requires-Dist: jupyter-sphinx (>=0.5.3,<0.6.0)
Requires-Dist: kconfiglib (>=14.1.0,<15.0.0)
Requires-Dist: linkify-it-py (>=2.0.3,<3.0.0)
Requires-Dist: mlx-traceability (>=11.7.0,<12.0.0)
Requires-Dist: myst-nb (>=1.1.0,<2.0.0)
Requires-Dist: myst-parser (>=4.0.0,<5.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: pillow (>=10.3.0,<11.0.0)
Requires-Dist: pip-system-certs (>=4.0,<5.0)
Requires-Dist: pyad (>=0.6.0,<0.7.0)
Requires-Dist: pytz (>=2024.1,<2025.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: robotframeworklexer (>=1.1,<2.0)
Requires-Dist: setuptools (>=70.0.0)
Requires-Dist: sphinx (==7.2.6)
Requires-Dist: sphinx-autobuild (>=2024.10.3,<2025.0.0)
Requires-Dist: sphinx-copybutton (>=0.5.2,<0.6.0)
Requires-Dist: sphinx-datatables (>=0.2.1,<0.3.0)
Requires-Dist: sphinx-design (>=0.6.0,<0.7.0)
Requires-Dist: sphinx-material (>=0.0.36,<0.0.37)
Requires-Dist: sphinx-mdinclude (>=0.6.1,<0.7.0)
Requires-Dist: sphinx-needs (>=5.1.0,<6.0.0)
Requires-Dist: sphinx-tags (>=0.3.1,<0.4.0)
Requires-Dist: sphinx-toolbox (>=3.7.0,<4.0.0)
Requires-Dist: sphinxcontrib-bibtex (>=2.6.2,<3.0.0)
Requires-Dist: sphinxcontrib-datatemplates (>=0.11.0,<0.12.0)
Requires-Dist: sphinxcontrib-details-directive (>=0.1.0,<0.2.0)
Requires-Dist: sphinxcontrib-drawio (>=0.0.17,<0.0.18)
Requires-Dist: sphinxcontrib-mermaid (>=0.9.2,<0.10.0)
Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.30)
Requires-Dist: sphinxcontrib-svg2pdfconverter (>=1.2.2,<2.0.0)
Requires-Dist: sphinxext-rediraffe (>=0.2.7,<0.3.0)
Requires-Dist: sphinxfeed-lsaffre (>=0.3.5,<0.4.0)
Requires-Dist: typer (>=0.15.1,<0.16.0)
Requires-Dist: tzlocal (>=5.2,<6.0)
Requires-Dist: windows-curses (>=2.3,<3.0) ; sys_platform == "win32"
Project-URL: Homepage, https://github.com/hermesbaby
Description-Content-Type: text/markdown

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

## Installation

Two options are available: System-wide or project-wise

### System-wide

While it's possible to install it globally via `pip`, it's recommended to install it via `pipx` to keep your system clean and tidy since `hermesbaby` brings many Python packages with it.

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

### Project-wise

Let's assume your project is managed with Poetry you would add `hermesbaby` similar to

```bash
poetry add hermesbaby
```

or

```bash
poetry add hermesbaby --group dev
```

## 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 check tools
```

Start your first new virtual piece of writing

```bash
hb new --template arc42
cd arc42
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 ;-) "

