onyx-vault 1.0.1__tar.gz

onyx_vault-1.0.1/.claude/commands/vault-bootstrap.md

@@ -0,0 +1,7 @@
+---
+description: Set up a new Onyx vault or adopt an existing one via the interview wizard
+---
+
+Read the skill at `modules/core/skills/vault-bootstrap/SKILL.md` (in this repository; in an installed vault it lives at `.claude/skills/vault-bootstrap/SKILL.md`) and follow it exactly.
+
+Target: $ARGUMENTS — if empty, first ask where the vault should live and whether it is a new folder (init) or an existing vault (adopt).

onyx_vault-1.0.1/.claude-plugin/marketplace.json

@@ -0,0 +1,17 @@
+{
+  "name": "onyx",
+  "owner": {
+    "name": "odysseia06"
+  },
+  "plugins": [
+    {
+      "name": "onyx",
+      "source": "./plugin",
+      "description": "Bootstrap and operate a tailored Obsidian vault with Onyx — the vault-bootstrap wizard plus the shared vault conventions. Pairs with the onyx-vault CLI on PyPI.",
+      "version": "1.0.1",
+      "author": {
+        "name": "odysseia06"
+      }
+    }
+  ]
+}

onyx_vault-1.0.1/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.{yaml,yml,json}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

onyx_vault-1.0.1/.gitattributes

@@ -0,0 +1,6 @@
+# Everything the engine writes is LF; keep the repo (and golden fixtures) LF on
+# every OS so byte-exact comparisons hold across the CI matrix.
+* text=auto eol=lf
+*.png binary
+*.jpg binary
+*.pdf binary

onyx_vault-1.0.1/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+# The 3-OS matrix is live from M0, per KICKSTART.md §9.5 and §11 — Windows is
+# first-class from the first commit, not retrofitted. The suite includes the
+# golden-file and idempotency tests, so byte-exactness across OSes is enforced
+# on every push.
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ["3.11", "3.14"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install
+        run: python -m pip install -e ".[dev]"
+      - name: Test
+        run: python -m pytest tests -q
+      - name: Generated artifacts are regenerable, not drifted
+        run: |
+          python tools/regen_golden.py
+          python tools/gen_examples.py
+          python tools/build_plugin.py
+          git diff --exit-code -- tests/fixtures/golden examples plugin/skills

onyx_vault-1.0.1/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+# Publish onyx-vault to PyPI on a version tag, via Trusted Publishing (OIDC) —
+# no API token stored anywhere. One-time setup the owner must do is in
+# RELEASING.md. Until that setup exists, this workflow builds and uploads the
+# artifacts to the run but the publish step will fail (harmless — nothing is
+# published without the trusted-publisher link).
+name: publish
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch: {}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist + wheel
+        run: |
+          python -m pip install build
+          python -m build
+      - name: Sanity-check the wheel carries the module library
+        run: |
+          python - <<'PY'
+          import glob, zipfile
+          whl = glob.glob("dist/*.whl")[0]
+          names = zipfile.ZipFile(whl).namelist()
+          assert "onyx/cli.py" in names, "engine missing from wheel"
+          mods = [n for n in names if n.startswith("onyx/_library/modules/") and n.endswith("/module.yaml")]
+          assert len(mods) >= 12, f"expected the module library in the wheel, found {len(mods)}"
+          print(f"wheel OK: {len(mods)} modules bundled")
+          PY
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    # The environment + id-token permission are what PyPI's trusted publisher
+    # checks. Configure the matching trusted publisher on PyPI (see RELEASING.md).
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

onyx_vault-1.0.1/.gitignore

@@ -0,0 +1,19 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+.pytest_cache/
+.coverage
+coverage.xml
+
+# OS junk
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# Editors
+.idea/
+.vscode/

onyx_vault-1.0.1/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing to Onyx
+
+## Before anything else
+
+Read [KICKSTART.md](KICKSTART.md) — at minimum §3 (Principles), §4 (Architecture), §5 (Modules), and §8 (Write & update contract). The charter is the referee: §2 non-goals and §3 principles are enforceable in review, and a PR that violates a numbered principle is a bug report against the PR, not a tradeoff discussion.
+
+## Development setup
+
+```
+python -m venv .venv
+# Windows: .venv\Scripts\activate     macOS/Linux: source .venv/bin/activate
+pip install -e .[dev]
+pytest
+```
+
+Python 3.11+ is required. Runtime dependencies are deliberately minimal (PyYAML only); think hard before proposing another.
+
+## The rules that bite
+
+- **Every engine write goes through the lockfile.** If you add a code path that writes into a vault without recording a lock entry, that is a defect, not a style issue (§8).
+- **Never touch user files.** Anything not in the lockfile is the user's. The planner must emit a blocked/report action for collisions, never a write (§8.2).
+- **Determinism.** Engine output is byte-identical across OSes and across runs: UTF-8 without BOM, LF line endings, sorted lock entries, no timestamps in the lock. Date-bearing content renders from the `ONYX_NOW` override in tests and CI so golden trees stay byte-exact.
+- **Re-running anything against an unchanged vault is a no-op** (P3). The idempotency tests enforce this; keep them passing.
+
+## Authoring module assets and generated prose
+
+- **Do not hard-wrap prose** in module assets, fragments, or anything the engine emits into a vault. One logical line per paragraph and per bullet; let editors soft-wrap. Hard-wrapped bullets render in Obsidian Live Preview with a gap partway through the sentence, which reads as broken. See `core/conventions/authoring.md`.
+- **Two placeholder languages, two moments.** `{{variable}}` is the *engine's* substitution, resolved once at apply time. `<% tp.* %>` is *Templater's*, resolved when the user instantiates a template — the engine passes it through untouched. A template must remain functional as a plain copy with no Templater installed (P2).
+- Modules contain **no executable code**. A module is reviewable by reading it (§5.1).
+- The `vault-conventions` skill bundles copies of `core/conventions/frontmatter.md` and `naming.md`; a test enforces byte-equality. Edit the canonical file under `core/conventions/`, then copy it into `modules/core/skills/vault-conventions/` — never edit the bundled copy directly.
+
+## Tests
+
+`pytest` runs everything. Per KICKSTART.md §11, changes touching the engine or module assets need:
+
+- unit coverage for new planner/lock/render behavior,
+- the idempotency suite still green,
+- golden fixtures regenerated *only* via `python tools/regen_golden.py` (never hand-edited), with the diff reviewed in the PR.
+
+CI runs the matrix on Ubuntu, macOS, and Windows. Windows is first-class; "passes on my Linux box" is not done.
+
+## Commit and PR hygiene
+
+- Small, reviewable PRs; one concern each.
+- Cite the charter section your change implements or amends.
+- Changes to charter decisions (§13) require owner sign-off — flip Proposed→Confirmed only with a date and a reviewer.