0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-10 12:47:04 +00:00

Files

T

kevinveenbirkenbachandClaude Opus 5 ebd7d2e72b refactor(meta): centralize category/distro SPOTs

categories.yml moves from roles/ to the repository-root meta/, joining packages.yml. utils/roles/categories.py owns its location plus the tree-walking helpers that were stranded in entity/name.py, so no caller spells the path or duplicates the lookup.

meta/distros.yml becomes the SPOT for every distribution: os_family, Galaxy platform name, dev-environment base image, and the pkgmgr/pkgmgr-virgin/environment reference templates. It replaces seven scattered copies (DISTRO_FAMILY, VALID_DISTROS, _DISTROS, _CANONICAL_PLATFORMS, two shell arrays, a Makefile literal). INFINITO_DISTROS is no longer a static default but generated by utils/env/handlers/infinito/distros.py; the shell consumers read it through the env layer.

Drops dead CLI surface found along the way: --categories-file and --roles-dir on the provision CLI plus three unused parameters of generate_dynamic_inventory, and the positional roles_file of the invokable categories command.

tests/lint/repository/test_distros_spot.py pins the copies that cannot call the SPOT (workflow literals, docs table) and forbids composing a pkgmgr reference outside it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-07-28 16:15:56 +02:00

handlers

refactor(meta): centralize category/distro SPOTs

2026-07-28 16:15:56 +02:00

__init__.py

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

builder.py

feat(tooling): operator alias, shortcut, skill, cheat and onboard system

2026-07-10 18:43:35 +02:00

loader.py

fix(env): teach drift test about dynamic handler reads + nocheck loader sentinel

2026-05-21 14:55:10 +02:00

parser.py

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

README.md

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

runtime.py

feat(env): SPOT env-pipeline + INFINITO_* namespace

2026-05-20 20:40:34 +02:00

writer.py

fix(env): write .env atomically via a temp file and rename

2026-07-19 03:49:25 +02:00

README.md

utils/env 📐

This directory hosts the Python implementation behind make dotenv. For the general rules that govern READMEs in code directories see documentation.md. For the per-variable defaults that this code consumes see default.env.

Purpose 🎯

The package converts the committed default.env plus a small runtime context into the gitignored .env at the repo root. Every module here belongs to one of four roles: parse, resolve, orchestrate, write.

Structure 🗂️

File	Role
`parser.py`	Read default.env into `(values, comments)` tuples.
`runtime.py`	Resolve host-context lookups (disk, RAM, hostname, GHA/Act flags, `/proc/version`, helper-script invocation).
`builder.py`	Thin orchestrator that defines `EnvBuilder`, `BuildContext`, and `build_env()`. Walks the handler registry.
`writer.py`	Serialise an `EnvBuilder` into a docker-compose-compatible `.env` on disk.
`handlers/`	One module per dynamically-computed variable. See handlers README.

The CLI entry point lives at __main__.py under cli/meta/env/. Shell consumers source load.sh under scripts/meta/env/.

File Naming 🏷️

Module names MUST stay lowercase snake_case.
Pure passthrough or simple parser/writer helpers MUST live directly under utils/env/.
Per-variable computation MUST live under handlers/ (see handlers README for the naming convention used there).
Test files live in tests/unit/utils/env/ and mirror the module name with a test_ prefix.

Import Rules 🔗

parser.py, runtime.py, and writer.py MUST NOT import from builder.py or handlers/.
builder.py MUST NOT import individual handler modules; it MUST go through the ORDERED_HANDLERS list exposed by handlers/__init__.py.
Handler modules MUST NOT import each other (see handlers README).