0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-09 20:26:33 +00:00

Files

T

kevinveenbirkenbachandClaude Opus 5 79ba511bb7 fix(env): keep the .env generator stdlib-only

The env generator runs on the bare bootstrap python, before any
dependency is installed. utils/distros.py reached PyYAML through
utils.cache.yaml, so `python -m cli.meta.env` died with
ModuleNotFoundError on every dev-runtime image that ships python3
without PyYAML.

utils/yaml_bootstrap.load_block reads the block-YAML subset the SPOT
files use with stdlib only. It raises BootstrapYamlError on anything it
cannot parse identically to yaml.safe_load, so meta/distros.yml fails
loud instead of drifting.

The per-line regex lint meant to guard this is gone: one hop of
indirection defeated it and it stayed green while the invariant was
broken. It is replaced by a test that runs the real generator with
every non-stdlib import blocked.

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

2026-07-28 19:47:01 +02:00

handlers

fix(env): keep the .env generator stdlib-only

2026-07-28 19:47:01 +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

…

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