brainkeeper 0.1.0__tar.gz

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

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Format check
+        run: uv run ruff format --check .
+
+      - name: Tests
+        run: uv run pytest
+
+  build:
+    name: build wheel
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Build sdist + wheel
+        run: uv build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error

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

@@ -0,0 +1,118 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "brainkeeper-v*"
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Format check
+        run: uv run ruff format --check .
+
+      - name: Tests
+        run: uv run pytest
+
+  build:
+    name: build wheel
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Verify tag matches package version
+        env:
+          TAG_NAME: ${{ github.ref_name }}
+        run: |
+          pkg_version=$(uv run python -c "import tomllib, pathlib; print(tomllib.loads(pathlib.Path('pyproject.toml').read_text())['project']['version'])")
+          expected="brainkeeper-v${pkg_version}"
+          if [ "$TAG_NAME" != "$expected" ]; then
+            echo "Tag '$TAG_NAME' does not match pyproject version (expected '$expected')." >&2
+            exit 1
+          fi
+
+      - name: Build sdist + wheel
+        run: uv build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: publish to PyPI + GitHub Release
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/brainkeeper
+    permissions:
+      id-token: write   # Trusted Publishing (PyPI OIDC)
+      contents: write   # create GitHub Release
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Extract release notes from CHANGELOG
+        id: notes
+        env:
+          TAG_NAME: ${{ github.ref_name }}
+        run: |
+          section=$(awk -v t="[$TAG_NAME]" '
+            $0 ~ "^## " t { found=1; next }
+            found && /^## / { exit }
+            found
+          ' CHANGELOG.md)
+          if [ -z "$section" ]; then
+            echo "No CHANGELOG section found for $TAG_NAME; falling back to auto-generated notes." >&2
+          fi
+          {
+            echo "body<<NOTES_EOF"
+            echo "$section"
+            echo "NOTES_EOF"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v3
+        with:
+          body: ${{ steps.notes.outputs.body }}
+          generate_release_notes: ${{ steps.notes.outputs.body == '' }}
+          files: dist/*

brainkeeper-0.1.0/.gitignore

@@ -0,0 +1,213 @@
+# 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
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# brainkeeper vault audit reports (contain vault paths, keep local)
+/vault-audit-*.md
+
+# Local MCP server config (contains absolute paths, keep local)
+.mcp.json

brainkeeper-0.1.0/CHANGELOG.md

@@ -0,0 +1,84 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Two artifacts are versioned independently:
+- **`spec-vX.Y.Z`**: the brainkeeper specification (`spec/`).
+- **`brainkeeper-vX.Y.Z`**: the `brainkeeper` Python package, which contains the vault engine library, the MCP server, and the CLI.
+
+## [brainkeeper-v0.1.0] - 2026-05-02
+
+First public release of the `brainkeeper` Python package. Implements spec v0.1.4.
+
+### Added
+- `brainkeeper.core` vault engine library: frontmatter parser and validator, atomic writer with mtime guard, in-memory note index with watchdog-based auto-update, periodic rescanner safety net, and config loader validated against the JSON Schema.
+- `brainkeeper.mcp` server (FastMCP-based, stdio transport) exposing 13 tools across three layers:
+  - Layer 0 primitives (5): `read_note`, `list_notes`, `write_note_atomic`, `move_note`, `delete_note`.
+  - Layer 1 convention (4): `read_convention`, `list_layers`, `get_template`, `resolve_path`.
+  - Layer 2 semantic (4): `find_by_tag`, `find_orphans`, `validate_frontmatter`, `update_frontmatter`, `list_tags`.
+- `brainkeeper.cli` with two subcommands: `brainkeeper init <path>` to bootstrap a vault, `brainkeeper serve --vault <path>` to run the MCP server.
+- MCP server `instructions=` block surfaced to connected clients, encoding the access rule, vault concepts, workflow, and limitations.
+- Spec data (`SPEC.md`, JSON Schema, examples) bundled inside the wheel via hatch `force-include`.
+- Auto-managed `created` and `updated` frontmatter on every write through the MCP. `created` defaults to today on new files, preserved from disk on overwrite. `updated` is always refreshed to today.
+- Archive transition (`delete_note(soft=True)`) refreshes `updated` per spec §12.
+
+### Notes
+- This package was previously developed under the name `brainkeeper-mcp`. It was renamed to `brainkeeper` for v0.1.0 and restructured into the `core`/`mcp`/`cli`/`spec` subpackages described above.
+- Single-vault per server instance. Multiple vaults need multiple `mcpServers` entries with distinct names.
+- `move_note` does not rewrite wikilinks (deferred to v2).
+
+## [spec-v0.1.4] - 2026-05-02
+
+### Changed
+- **Breaking:** §7 Tag taxonomy simplified. The prescribed dimensions table (`domain/`, `topic/`, `project/`, `person/`) is removed. Tags are now plain lowercase kebab-case strings; the `prefix/value` form is still allowed but no longer prescribed. The "domain vocabulary derived from folders" mechanism is gone. There is no implicit vocabulary, just freeform tags.
+- MCP `list_domains` tool removed. Folder-derived domain vocabulary is no longer a spec concept; nothing replaces this tool. Use `list_notes` + `find_by_tag` for tag exploration.
+- Spec cross-references (§3, §5, §10, §15, §16) cleaned up to drop "domain" terminology.
+- MCP server now ships an `instructions=` block via FastMCP that surfaces to every connected client. Encodes the access rule, vault concepts, recommended workflow, and limitations.
+
+### Migration
+- No frontmatter changes needed. Existing tags with `domain/` or any other prefix continue to validate (the grammar regex is unchanged).
+- Remove any tooling that calls `list_domains` (it no longer exists).
+
+## [spec-v0.1.3] - 2026-05-01
+
+### Changed
+- **Breaking:** frontmatter contract pared down to three required fields. `type`, `status`, `deadline`, and `archived` are no longer recognised by the spec. The new required set is `created`, `updated`, `tags`. `updated` is set to `created` on first write and refreshed to today on every edit; it MUST be ≥ `created`. Any other field is allowed and passed through unchanged under the extension rule (vault- or tool-specific concerns like lifecycle status, deadlines, or course metadata live there).
+- §11 capture flow now reads an explicit *intent* from the caller instead of the `type` frontmatter field.
+- §12 archive transition no longer mutates `status` or `archived` in frontmatter. Only `updated` is refreshed; the file moves to `<archive>/<YYYY>/`.
+- §13 (Status semantics) removed. Status is no longer part of the spec.
+- Config schema: `layers.projects.status_field` and `layers.projects.active_values` removed (they configured filtering of the now-removed `status` field).
+
+### Migration
+- Drop `type`, `status`, `deadline`, `archived` from existing notes (or keep them; they become extension fields, ignored by spec validators).
+- Add `updated` to every managed note. For notes never edited since creation, set `updated: <same as created>`.
+- Remove `status_field` / `active_values` from `brainkeeper.yaml` if present.
+
+## [spec-v0.1.2] - 2026-05-01
+
+### Changed
+- `status` frontmatter field is no longer required (moved from required to optional in §6). It remains meaningful for lifecycle types (`project`, `area`, `idea`) but is typically omitted on reference types (`knowledge`, `resource`, `note`) that have no lifecycle. The enum and §13 semantics are unchanged for notes that do carry a status. Tooling SHOULD treat a missing `status` as "no lifecycle" rather than a validation error. This is a constraint relaxation; v0.1.1 notes remain compliant.
+
+## [spec-v0.1.1] - 2026-05-01
+
+### Changed
+- **Breaking:** template directory renamed from `.templates/` to `_templates/`. The hidden dot-folder broke the Obsidian editing workflow (templates were invisible in the sidebar). The underscore prefix keeps templates visible while still marking them as meta so tooling excludes them from indexing and domain derivation. Vaults adopting v0.1.0 must rename their `<layer>/.templates/` directories to `<layer>/_templates/`.
+
+## [spec-v0.1.0] - 2026-04-24
+
+### Added
+- Initial public draft of the `brainkeeper` specification (`spec/SPEC.md`).
+- JSON Schema for `brainkeeper.yaml` (`spec/schema/brainkeeper.schema.json`).
+- Three reference configs: `minimal.yaml`, `daniels-vault.yaml`, `zettelkasten.yaml`.
+- Negative-test fixtures under `spec/examples/.invalid/`.
+- Six-layer structural model (`inbox`, `journal`, `projects`, `areas`, `brain`, `archive`) with colocated per-layer templates under `<layer>/.templates/`.
+- Archive semantics narrowed to completed projects only; retired Areas are deleted or distilled into Brain, not archived.
+- Domain tags: cardinality relaxed to 0..n (optional but recommended); vocabulary derived from folders under `projects/` and `areas/` rather than an enumerated list in the config.
+
+[spec-v0.1.4]: https://github.com/dasirra/brainkeeper/releases/tag/spec-v0.1.4
+[spec-v0.1.3]: https://github.com/dasirra/brainkeeper/releases/tag/spec-v0.1.3
+[spec-v0.1.2]: https://github.com/dasirra/brainkeeper/releases/tag/spec-v0.1.2
+[spec-v0.1.1]: https://github.com/dasirra/brainkeeper/releases/tag/spec-v0.1.1
+[spec-v0.1.0]: https://github.com/dasirra/brainkeeper/releases/tag/spec-v0.1.0

brainkeeper-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Sierra
+
+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.