adrinaline 0.1.0__tar.gz

adrinaline-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: ci
+
+# Checks run on PRs only; branch protection requires an up-to-date branch,
+# so the commit that lands on main is the one that was tested.
+on:
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.14"
+      - run: uv sync --locked
+      - run: uv run cz check --rev-range origin/${{ github.base_ref }}..HEAD
+      - run: uv run ruff check
+      - run: uv run ruff format --check
+      - run: uv run ty check
+      - run: uv run pytest -q
+      - run: uv run adr check --strict

adrinaline-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths: ["docs/**", "src/**", "README.md", "zensical.toml"]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/configure-pages@v6
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.14"
+      - run: uv run --locked --group docs zensical build --clean
+      - uses: actions/upload-pages-artifact@v5
+        with:
+          path: site
+      - uses: actions/deploy-pages@v5
+        id: deployment

adrinaline-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: release
+
+# Every push to main releases if its commits warrant a bump (feat, fix, breaking).
+# The version lives only in the git tag (hatch-vcs); nothing is committed back.
+on:
+  push:
+    branches: [main]
+
+concurrency: release
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.14"
+      - name: Next version
+        id: next
+        run: |
+          set +e
+          next=$(uv run cz bump --get-next --yes)
+          code=$?
+          set -e
+          if [ "$code" = 21 ]; then exit 0; fi  # nothing to release
+          [ "$code" = 0 ] || exit "$code"
+          echo "tag=v$next" >> "$GITHUB_OUTPUT"
+      - if: steps.next.outputs.tag
+        run: git tag "${{ steps.next.outputs.tag }}"
+      - if: steps.next.outputs.tag
+        run: uv build
+      - if: steps.next.outputs.tag
+        run: uv publish
+      - if: steps.next.outputs.tag
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ steps.next.outputs.tag }}
+        run: |
+          git push origin "$TAG"
+          uv run cz changelog "$TAG" --dry-run | gh release create "$TAG" --title "$TAG" --notes-file -

adrinaline-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

adrinaline-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

adrinaline-0.1.0/AGENTS.md

@@ -0,0 +1,7 @@
+# Agent instructions
+
+- Run `adr prime` at the start of every session and follow the ADRs it lists.
+- Python 3.14 with uv. Before finishing: `uv run ruff check && uv run ruff format --check && uv run ty check && uv run pytest -q`.
+- The specification is `docs/SPEC.md`; implementation plans are in `docs/superpowers/plans/`.
+- Work on a short-lived branch, open a PR with `gh pr create`, then `gh pr merge --auto --rebase`; it merges once CI is green. Never push to `main`.
+- Commit messages are Conventional Commits and decide the next version (ADR 0006): `feat` → minor, `fix` → patch, `docs`/`ci`/`chore`/`test`/`refactor` → no release.

adrinaline-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Max Wolf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

adrinaline-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.5
+Name: adrinaline
+Version: 0.1.0
+Summary: Git-native Architecture Decision Records for humans and coding agents
+Project-URL: Repository, https://github.com/maximiliancw/adrinaline
+Project-URL: Issues, https://github.com/maximiliancw/adrinaline/issues
+Author: Max Wolf
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.14
+Requires-Dist: pydantic>=2.14.1
+Requires-Dist: ruamel-yaml>=0.19.1
+Description-Content-Type: text/markdown
+
+# adrinaline
+
+ADRs in a line: git-native Architecture Decision Records for humans and coding agents.
+
+`adr` keeps decisions as Markdown files with YAML frontmatter in your repository, numbers them sequentially, links them into a graph, ties them to the code they govern, and answers every question in plain text or JSON.
+
+## Install
+
+```bash
+uv tool install adrinaline   # provides `adr` (and `adrinaline`)
+# or run without installing:
+uvx adrinaline --help
+```
+
+Requires Python 3.14+ and git.
+
+## Quick start
+
+```bash
+adr init                                   # docs/adr/.template.md + 0001-record-architecture-decisions.md
+adr new "Use PostgreSQL" --tag storage     # docs/adr/0002-use-postgresql.md (proposed)
+adr accept 2
+adr new "Use PostgreSQL 17" --supersedes 2 --accepted
+adr list
+adr graph --format mermaid                 # paste into any GitHub/GitLab Markdown file
+adr check                                  # CI-friendly validation
+```
+
+## Tie decisions to code
+
+Add `scope` globs to an ADR's frontmatter:
+
+```yaml
+scope: ["src/db/**", "migrations/**"]
+```
+
+Then:
+
+```bash
+adr for src/db/pool.py                     # which decisions govern this file?
+adr check --diff origin/main --strict      # CI gate: changed files governed by ADRs in force
+```
+
+## History
+
+Every read command accepts `--at REF`:
+
+```bash
+adr list --at v1.2 --status accepted       # what was in force at release 1.2?
+adr log 7                                  # git history of ADR 0007
+```
+
+## For coding agents
+
+Add one line to `AGENTS.md` (or your agent's equivalent):
+
+```markdown
+Run `adr prime` at the start of every session and follow the ADRs it lists.
+```
+
+`adr prime --budget 400` limits the briefing to about 400 words, picking the most important and most relevant decisions first (the top-scored ADR is always shown). `adr skill` prints a skill that teaches agents when and how to write ADRs; redirect it into your agent's skill directory (for example `adr skill > .claude/skills/adr/SKILL.md`). Every command accepts `--json` and returns a stable error envelope with exit code 3 on domain errors. Global flags (`--json`, `--dir`, `-q`, `--at`) work before or after the subcommand.
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `adr init` | Create the ADR directory, template and ADR 0001 |
+| `adr new TITLE` | Create an ADR (`--supersedes`, `--amends`, `--depends-on`, `--relates-to`, `--body-file -`) |
+| `adr show REF` / `adr list` / `adr index` | Read ADRs |
+| `adr accept` / `reject` / `deprecate` / `supersede` | Change status |
+| `adr link` / `unlink` | Manage relations |
+| `adr graph [REF]` | Text, Mermaid, DOT or JSON graph; `--reverse` for impact, `--rank` for keystones (text or JSON only) |
+| `adr for PATH` | ADRs governing a file |
+| `adr check` | Validate everything |
+| `adr renumber REF --to N` | Fix numbering collisions after merges |
+| `adr log REF` | Git history of an ADR |
+| `adr prime` / `adr skill` | Agent briefing and skill |
+
+The full specification is in [docs/SPEC.md](docs/SPEC.md).
+
+## Licence
+
+MIT

adrinaline-0.1.0/README.md

@@ -0,0 +1,83 @@
+# adrinaline
+
+ADRs in a line: git-native Architecture Decision Records for humans and coding agents.
+
+`adr` keeps decisions as Markdown files with YAML frontmatter in your repository, numbers them sequentially, links them into a graph, ties them to the code they govern, and answers every question in plain text or JSON.
+
+## Install
+
+```bash
+uv tool install adrinaline   # provides `adr` (and `adrinaline`)
+# or run without installing:
+uvx adrinaline --help
+```
+
+Requires Python 3.14+ and git.
+
+## Quick start
+
+```bash
+adr init                                   # docs/adr/.template.md + 0001-record-architecture-decisions.md
+adr new "Use PostgreSQL" --tag storage     # docs/adr/0002-use-postgresql.md (proposed)
+adr accept 2
+adr new "Use PostgreSQL 17" --supersedes 2 --accepted
+adr list
+adr graph --format mermaid                 # paste into any GitHub/GitLab Markdown file
+adr check                                  # CI-friendly validation
+```
+
+## Tie decisions to code
+
+Add `scope` globs to an ADR's frontmatter:
+
+```yaml
+scope: ["src/db/**", "migrations/**"]
+```
+
+Then:
+
+```bash
+adr for src/db/pool.py                     # which decisions govern this file?
+adr check --diff origin/main --strict      # CI gate: changed files governed by ADRs in force
+```
+
+## History
+
+Every read command accepts `--at REF`:
+
+```bash
+adr list --at v1.2 --status accepted       # what was in force at release 1.2?
+adr log 7                                  # git history of ADR 0007
+```
+
+## For coding agents
+
+Add one line to `AGENTS.md` (or your agent's equivalent):
+
+```markdown
+Run `adr prime` at the start of every session and follow the ADRs it lists.
+```
+
+`adr prime --budget 400` limits the briefing to about 400 words, picking the most important and most relevant decisions first (the top-scored ADR is always shown). `adr skill` prints a skill that teaches agents when and how to write ADRs; redirect it into your agent's skill directory (for example `adr skill > .claude/skills/adr/SKILL.md`). Every command accepts `--json` and returns a stable error envelope with exit code 3 on domain errors. Global flags (`--json`, `--dir`, `-q`, `--at`) work before or after the subcommand.
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `adr init` | Create the ADR directory, template and ADR 0001 |
+| `adr new TITLE` | Create an ADR (`--supersedes`, `--amends`, `--depends-on`, `--relates-to`, `--body-file -`) |
+| `adr show REF` / `adr list` / `adr index` | Read ADRs |
+| `adr accept` / `reject` / `deprecate` / `supersede` | Change status |
+| `adr link` / `unlink` | Manage relations |
+| `adr graph [REF]` | Text, Mermaid, DOT or JSON graph; `--reverse` for impact, `--rank` for keystones (text or JSON only) |
+| `adr for PATH` | ADRs governing a file |
+| `adr check` | Validate everything |
+| `adr renumber REF --to N` | Fix numbering collisions after merges |
+| `adr log REF` | Git history of an ADR |
+| `adr prime` / `adr skill` | Agent briefing and skill |
+
+The full specification is in [docs/SPEC.md](docs/SPEC.md).
+
+## Licence
+
+MIT