kelmo 0.1.0__tar.gz

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

@@ -0,0 +1,206 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  workflow_call:
+  schedule:
+    - cron: "17 3 * * 1"
+
+permissions:
+  contents: read
+
+# A runner's preinstalled Python can lack SQLite extension support, which sqlite-vec needs.
+env:
+  UV_MANAGED_PYTHON: "1"
+
+jobs:
+  source:
+    name: Source (${{ matrix.os }}, Python ${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # Pushes and pull requests: one Linux job. Release tags, the weekly run and a manual run: both
+        # operating systems on the lowest and highest supported Python.
+        include: ${{ fromJSON((github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/')) && '[{"os":"ubuntu-24.04","python":"3.12"},{"os":"ubuntu-24.04","python":"3.13"},{"os":"macos-26","python":"3.12"},{"os":"macos-26","python":"3.13"}]' || '[{"os":"ubuntu-24.04","python":"3.13"}]') }}
+    steps:
+      - name: Prepare synthetic environment
+        run: |
+          synthetic_home="$RUNNER_TEMP/kelmo-home"
+          mkdir -p "$synthetic_home"
+          {
+            echo "HOME=$synthetic_home"
+            echo "GIT_CONFIG_GLOBAL=$synthetic_home/.gitconfig"
+            echo "GIT_CONFIG_NOSYSTEM=1"
+            echo "GIT_AUTHOR_NAME=Kelmo CI"
+            echo "GIT_AUTHOR_EMAIL=kelmo-ci@example.invalid"
+            echo "GIT_COMMITTER_NAME=Kelmo CI"
+            echo "GIT_COMMITTER_EMAIL=kelmo-ci@example.invalid"
+          } >> "$GITHUB_ENV"
+      - name: Check out source
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          version: "0.11.3"
+          python-version: ${{ matrix.python }}
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+      - name: Sync locked dependencies
+        run: uv sync --locked --dev --python ${{ matrix.python }}
+      - name: Check lock file
+        run: uv lock --check
+      - name: Lint
+        run: uv run --locked --python ${{ matrix.python }} ruff check .
+      - name: Test default source profile
+        env:
+          PYTHONPATH: ${{ github.workspace }}/src
+        # The same sharded run the gate uses: four pytest processes on a four-core runner.
+        run: >-
+          uv run --locked --python ${{ matrix.python }} python tools/pytest_shards.py tests -q -ra
+          --ignore=tests/test_runtime.py
+          --ignore=tests/test_runtime_macos.py
+          --ignore=tests/test_linux_runtime.py
+          --ignore=tests/test_installed_cli.py
+
+  artifacts:
+    name: Build and inspect artifacts
+    needs: source
+    runs-on: ubuntu-24.04
+    outputs:
+      artifact-id: ${{ steps.distributions.outputs.artifact-id }}
+    steps:
+      - name: Prepare synthetic environment
+        run: |
+          synthetic_home="$RUNNER_TEMP/kelmo-home"
+          mkdir -p "$synthetic_home"
+          {
+            echo "HOME=$synthetic_home"
+            echo "GIT_CONFIG_GLOBAL=$synthetic_home/.gitconfig"
+            echo "GIT_CONFIG_NOSYSTEM=1"
+            echo "GIT_AUTHOR_NAME=Kelmo CI"
+            echo "GIT_AUTHOR_EMAIL=kelmo-ci@example.invalid"
+            echo "GIT_COMMITTER_NAME=Kelmo CI"
+            echo "GIT_COMMITTER_EMAIL=kelmo-ci@example.invalid"
+          } >> "$GITHUB_ENV"
+      - name: Check out source
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          version: "0.11.3"
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+      - name: Sync locked dependencies
+        run: uv sync --locked --dev --python 3.12
+      - name: Build wheel and source distribution
+        run: uv build --no-sources
+      - name: Inspect distribution contents
+        run: |
+          wheel=$(find dist -maxdepth 1 -name '*.whl' -print -quit)
+          source=$(find dist -maxdepth 1 -name '*.tar.gz' -print -quit)
+          test -n "$wheel"
+          test -n "$source"
+          KELMO_TEST_WHEEL="$wheel" KELMO_TEST_SDIST="$source" \
+            uv run --locked pytest tests/test_distribution.py
+      - name: Upload distributions
+        id: distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: kelmo-dist
+          path: dist/
+          if-no-files-found: error
+          retention-days: 7
+
+  installed-launcher:
+    name: Fresh installed launcher (${{ matrix.os }}, Python ${{ matrix.python }})
+    needs: [source, artifacts]
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+      actions: read
+    strategy:
+      fail-fast: false
+      matrix:
+        # Pushes and pull requests: one Linux job. Release tags, the weekly run and a manual run: both
+        # operating systems on the lowest and highest supported Python.
+        include: ${{ fromJSON((github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/')) && '[{"os":"ubuntu-24.04","python":"3.12"},{"os":"ubuntu-24.04","python":"3.13"},{"os":"macos-26","python":"3.12"},{"os":"macos-26","python":"3.13"}]' || '[{"os":"ubuntu-24.04","python":"3.13"}]') }}
+    steps:
+      - name: Prepare synthetic environment
+        run: |
+          synthetic_home="$RUNNER_TEMP/kelmo-home"
+          mkdir -p "$synthetic_home"
+          {
+            echo "HOME=$synthetic_home"
+            echo "GIT_CONFIG_GLOBAL=$synthetic_home/.gitconfig"
+            echo "GIT_CONFIG_NOSYSTEM=1"
+            echo "GIT_AUTHOR_NAME=Kelmo CI"
+            echo "GIT_AUTHOR_EMAIL=kelmo-ci@example.invalid"
+            echo "GIT_COMMITTER_NAME=Kelmo CI"
+            echo "GIT_COMMITTER_EMAIL=kelmo-ci@example.invalid"
+          } >> "$GITHUB_ENV"
+      - name: Check out source
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          version: "0.11.3"
+          python-version: ${{ matrix.python }}
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+      - name: Sync locked test dependencies
+        run: uv sync --locked --dev --no-install-project --python ${{ matrix.python }}
+      - name: Download immutable distributions
+        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
+        with:
+          artifact-ids: ${{ needs.artifacts.outputs.artifact-id }}
+          path: ${{ runner.temp }}/dist
+          merge-multiple: true
+          github-token: ${{ github.token }}
+          digest-mismatch: error
+      - name: Install fresh runtime
+        run: |
+          set -- "$RUNNER_TEMP"/dist/*.whl
+          test "$#" -eq 1
+          test -f "$1"
+          uv venv --python ${{ matrix.python }} "$RUNNER_TEMP/fresh-runtime"
+          uv export --locked --no-dev --no-emit-project --no-hashes \
+            --output-file "$RUNNER_TEMP/constraints.txt"
+          uv pip install --python "$RUNNER_TEMP/fresh-runtime/bin/python" \
+            --constraints "$RUNNER_TEMP/constraints.txt" "$1"
+      - name: Test installed launcher
+        working-directory: ${{ runner.temp }}
+        env:
+          KELMO_TEST_PREFIX: ${{ runner.temp }}/fresh-runtime
+          PYTHONPATH: ${{ runner.temp }}/fresh-runtime/lib/python${{ matrix.python }}/site-packages
+        run: |
+          set -- "$RUNNER_TEMP"/dist/*.whl
+          export KELMO_TEST_WHEEL="$1"
+          set -- "$RUNNER_TEMP"/dist/*.tar.gz
+          export KELMO_TEST_SDIST="$1"
+          "$GITHUB_WORKSPACE/.venv/bin/python" - <<'PY'
+          import importlib.util
+          import os
+          from pathlib import Path
+
+          prefix = Path(os.environ["KELMO_TEST_PREFIX"]).resolve()
+          for name in ("kelmo", "kelmo.store"):
+              spec = importlib.util.find_spec(name)
+              assert spec is not None and spec.submodule_search_locations, name
+              for location in spec.submodule_search_locations:
+                  assert Path(location).resolve().is_relative_to(prefix), (name, location)
+          PY
+          "$GITHUB_WORKSPACE/.venv/bin/python" -m pytest --import-mode=importlib --noconftest \
+            "$GITHUB_WORKSPACE/tests/test_installed_cli.py" \
+            "$GITHUB_WORKSPACE/tests/test_distribution.py"

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

@@ -0,0 +1,50 @@
+name: Release
+
+# Push a tag vX.Y.Z whose version matches pyproject.toml. The full CI runs first; the exact wheel and sdist it
+# built and tested are then published to PyPI through Trusted Publishing (no API token is stored anywhere).
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  checks:
+    name: CI
+    uses: ./.github/workflows/ci.yml
+    permissions:
+      contents: read
+      actions: read
+
+  publish:
+    name: Publish to PyPI
+    needs: checks
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/project/kelmo/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download the tested distributions
+        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
+        with:
+          name: kelmo-dist
+          path: dist/
+      - name: Check that the tag names the built version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          set -- dist/kelmo-*.whl
+          test "$#" -eq 1
+          version=$(basename "$1" | cut -d- -f2)
+          if [ "v$version" != "$TAG" ]; then
+            echo "Tag $TAG does not match the built version $version (pyproject.toml)." >&2
+            exit 1
+          fi
+          ls -l dist/
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3

kelmo-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+/_docs/
+.venv/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+*.egg-info/
+build/
+dist/
+.coverage
+local-data/
+.env*
+!.env.example

kelmo-0.1.0/INSTALL_FOR_AGENTS.md

@@ -0,0 +1,88 @@
+# Install Kelmo for your user
+
+You are a coding agent asked to install Kelmo. Follow these steps in order. Ask before each
+step that changes the user's files or spends their model quota.
+
+## 1. Check the machine
+
+Stop and report if any check fails.
+
+```sh
+python3 --version          # 3.12 or 3.13
+git config user.name       # must print a value
+git config user.email      # must print a value
+claude --version           # or: codex --version
+```
+
+macOS or Linux only. The agent CLI must already be logged in; Kelmo never copies credentials.
+
+## 2. Ask the user four things
+
+Do not choose these for them.
+
+1. **Project name**, for example the repository's name.
+2. **Client:** `claude`, `codex` or `both`.
+3. **Editor model and provider.** The background worker calls this model for every note, on the
+   user's subscription or API key. On the author's vault Claude Haiku cost a median of $0.13 per
+   note on an API key. Ask which model they want. There is no fallback.
+4. **Session capture.** `off` is the default. `auto` or `archive-only` saves session transcripts
+   to the local archive, so ask explicitly.
+
+## 3. Install the package
+
+```sh
+pipx install kelmo         # or: uv tool install kelmo
+```
+
+## 4. Preview, then show the plan
+
+Run this from the user's repository. It writes nothing, downloads nothing and calls no model.
+
+```sh
+kelmo setup --non-interactive --disable-native-memory \
+  --client CLIENT --provider PROVIDER --model MODEL \
+  --project NAME --link "$PWD" --session-memory MODE --dry-run
+```
+
+Use the session capture mode the user chose for `MODE`. `auto` and `archive-only` also run model-backed
+readiness checks when applied. Show the user the `files` list and `warnings`, and wait for their yes.
+
+`--disable-native-memory` adds a line to the agent's instruction file telling it to use Kelmo
+instead of the client's built-in memory. If the user wants to keep both, use
+`--allow-native-memory`.
+
+## 5. Apply
+
+Run the same command without `--dry-run`. It creates the vault, downloads the pinned embedding
+model once (87 MB), registers MCP and hooks, makes one real model call to check the editor, and
+starts a user-level background worker. Changed files get verified backups.
+
+## 6. Verify
+
+```sh
+kelmo doctor --json
+kelmo projects --json
+kelmo create --project NAME --text 'Kelmo was installed on this machine today.' --wait --json
+kelmo pages
+```
+
+`kelmo create` costs one editor run. If it reports an operation id without a final state, follow
+it with `kelmo trace OPERATION_ID --json`: `applied` means the wiki changed and `failed` names the
+refusal. `archived` is a final evidence-only result only when the operation is terminal; before that
+the note is still waiting for the editor.
+
+## 7. Hand over
+
+Tell the user to restart their agent client. Codex asks them to trust the new hooks in `/hooks`;
+you cannot approve that for them. In the new session the project's hub arrives at startup.
+
+To undo the client integration:
+
+```sh
+kelmo uninstall --home "$HOME" --executable "$(command -v kelmo)" --vault VAULT --client CLIENT --json
+```
+
+Add `--apply` after showing the preview. This disconnects the clients and keeps the worker and
+the data; see [docs/REMOVAL.md](docs/REMOVAL.md).
+
+More options, a shared server and custom models are in [docs/SETUP.md](docs/SETUP.md).

kelmo-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.