pulse8-ai-cortex-knowledge-vault 0.3.0__tar.gz

pulse8_ai_cortex_knowledge_vault-0.3.0/.env.example

@@ -0,0 +1,16 @@
+# Cortex Environment Configuration
+# Copy to .env and fill in your values: cp .env.example .env
+
+# ── Required ─────────────────────────────────────────────────────────
+# OpenRouter API key (get one at https://openrouter.ai/keys)
+LLM_API_KEY=sk-or-...
+
+# ── Optional ─────────────────────────────────────────────────────────
+# LLM model to use for knowledge compilation
+# COMPILER_MODEL=anthropic/claude-sonnet-4
+
+# LLM API base URL (default: OpenRouter)
+# LLM_BASE_URL=https://openrouter.ai/api/v1
+
+# Path to your vault directory (default: ./example_vault)
+# VAULT_DIR=./example_vault

pulse8_ai_cortex_knowledge_vault-0.3.0/.github/workflows/publish-docker.yml

@@ -0,0 +1,44 @@
+name: Publish Docker Image
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  packages: write
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Log in to GHCR
+      uses: docker/login-action@v3
+      with:
+        registry: ${{ env.REGISTRY }}
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Extract metadata
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+        tags: |
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+
+    - name: Build and push
+      uses: docker/build-push-action@v6
+      with:
+        context: .
+        push: true
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}

pulse8_ai_cortex_knowledge_vault-0.3.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.12"
+
+    - name: Install build tools
+      run: pip install build
+
+    - name: Build package
+      run: python -m build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

pulse8_ai_cortex_knowledge_vault-0.3.0/.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+        pip install -e ".[dev]"
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

pulse8_ai_cortex_knowledge_vault-0.3.0/.gitignore

@@ -0,0 +1,82 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+instance/
+.webassets-cache
+.scrapy
+docs/_build/
+.pybuilder/
+target/
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+.pdm.toml
+.pdm-python
+__pypackages__/
+celerybeat-schedule
+celerybeat.pid
+*.sage.py
+.env
+.env.*
+!.env.example
+.venv
+env/
+venv/
+ENV/
+.spyderproject
+.spyproject
+.ropeproject
+/site
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+cython_debug/
+.ruff_cache/
+.vscode/
+.idea/
+.cursor/
+*.swp
+*.swo
+*~
+.DS_Store
+Thumbs.db

pulse8_ai_cortex_knowledge_vault-0.3.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to PULSE8.ai Cortex are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.2.0] — 2026-04-25
+
+### Performance — QMD Search
+
+- **Deduplicate periodic refresh**: Cortex no longer runs its own periodic QMD refresh timer when using the Docker stack, since the QMD container already manages its own. Cuts redundant `update` + `embed` cycles in half.
+- **Fix `/update` client timeout**: Extended the `QMDHttpSearch.update()` timeout from 30s to 600s to match the server-side embed duration. Prevents silent client-side timeouts on large vaults.
+- **Debounce write-triggered re-index**: Added `DebouncedQMDUpdate` that coalesces rapid writes into a single deferred `qmd.update()` call, avoiding N full re-indexes during batch operations.
+- **Batch graph edge lookups**: Added `GraphEngine.get_edges_batch()` using `asyncio.gather` to fetch edges for all search results in parallel instead of sequentially.
+- **TTL search cache**: Wrapped QMD search with `CachedQMDSearch` — identical queries within a 30s window return cached results without spawning a QMD process. Cache is invalidated on `update()`.
+- **Skip duplicate `/setup`**: `QMDHttpSearch.initialize()` now polls `/health` first and skips calling `/setup` if the QMD container has already finished its own setup, reducing cold-boot time.
+
+### Performance — Vault Loading
+
+- **Batch graph persistence**: Added `GraphEngine.batch()` context manager that defers `save()` calls during `build_graph`, replacing O(N) JSON serializations with a single write at the end.
+- **Parallel vault scanning**: Added `scan_vault_async()` that offloads frontmatter parsing to a `ThreadPoolExecutor` for concurrent file I/O during startup.
+- **Wikilink index**: Added `build_wikilink_index()` that pre-builds a stem-to-path lookup map, giving `build_graph` O(1) wikilink resolution instead of per-link filesystem traversals.
+- **Accept pre-scanned notes in `rebuild_index`**: `rebuild_index()` now takes an optional `notes` parameter to skip redundant full vault scans when notes are already loaded.
+
+### Fixed
+
+- **Consistent search mode**: `build_context_window` now respects `CORTEX_QMD_SEARCH_MODE` instead of always defaulting to `hybrid`, which is the most expensive mode.
+
+### New Modules
+
+- `cortex/search/qmd_debounce.py` — Debounced update scheduler
+- `cortex/search/qmd_cache.py` — TTL search result cache
+
+### Tests
+
+- 34 new tests covering all performance improvements
+- Total test count: 200+
+
+## [0.1.0] — 2026-04-20
+
+Initial open-source release.
+
+- Knowledge graph engine (NetworkX) with typed edges and wikilinks
+- Full-text search via QMD (keyword / semantic / hybrid)
+- LLM compiler for transforming raw sources into wiki articles
+- MCP server (streamable HTTP + stdio transport)
+- REST API at `/api/v1/`
+- Real-time vault watcher with filesystem monitoring
+- Docker Compose stack with QMD sidecar
+- Apache 2.0 license with PULSE8.ai additional terms

pulse8_ai_cortex_knowledge_vault-0.3.0/Dockerfile

@@ -0,0 +1,34 @@
+FROM python:3.12-slim
+
+LABEL org.opencontainers.image.title="PULSE8.ai Cortex"
+LABEL org.opencontainers.image.description="Agent-native knowledge OS built on Markdown"
+LABEL org.opencontainers.image.vendor="PULSE8.ai"
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    curl \
+    poppler-utils \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+
+WORKDIR /app
+
+COPY pyproject.toml uv.lock README.md ./
+RUN uv sync --frozen --no-dev --no-install-project
+
+COPY cortex/ cortex/
+COPY scripts/ scripts/
+RUN uv sync --frozen --no-dev
+
+RUN mkdir -p /vault/raw /vault/wiki /vault/agents /vault/sessions /vault/daily /vault/.cortex
+
+ENV CORTEX_VAULT_PATH=/vault
+ENV CORTEX_MCP_TRANSPORT=http
+ENV CORTEX_MCP_SSE_PORT=8420
+
+EXPOSE 8420
+
+HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
+    CMD curl -sf http://localhost:8420/api/v1/health || exit 1
+
+CMD ["uv", "run", "uvicorn", "cortex.main:app", "--host", "0.0.0.0", "--port", "8420"]

pulse8_ai_cortex_knowledge_vault-0.3.0/LICENSE.md

@@ -0,0 +1,248 @@
+                                 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
+
+=========================================================================
+
+   ADDITIONAL TERMS — PULSE8.ai Cortex Open Source License
+
+   The following additional terms supplement the Apache License 2.0
+   and apply to all use of PULSE8.ai Cortex. By using, reproducing,
+   or distributing the Work, You agree to these additional terms.
+
+=========================================================================
+
+   A1. Commercial License and Thresholds.
+
+   PULSE8.ai Cortex may be used for commercial purposes without a
+   separate commercial license. However, if You and Your Affiliates,
+   on a consolidated basis, meet either of the following thresholds
+   (A or B), You must obtain a separate commercial license from
+   PULSE8.ai before continuing such use:
+
+      A. Monthly Active Users (MAU) exceed 1 million.
+
+      B. Total Monthly Revenue (TMR) exceeds USD 5 million.
+
+   For the purposes of this section, MAU includes end-users of any
+   product or service that integrates PULSE8.ai Cortex, as well as
+   AI agents, API consumers, or MCP clients connecting to an instance
+   of PULSE8.ai Cortex.
+
+   A2. Service Attribution Obligation.
+
+   If You provide products or services to third parties that integrate
+   PULSE8.ai Cortex — whether as a hosted API, managed knowledge
+   service, embedded backend, or any other form — You must clearly and
+   prominently indicate, in the relevant product or service interface
+   or in publicly available documentation, that PULSE8.ai Cortex is
+   used.
+
+   A3. Termination of Additional Terms.
+
+   Where a separate commercial license is required under Section A1 but
+   is not obtained before continuing such use, or where the attribution
+   obligation under Section A2 is not complied with, this License and
+   all rights granted under this License will terminate automatically,
+   and no further notice from the Licensor is required.
+
+   A4. Definitions.
+
+   In these additional terms, "Affiliates" means any legal entity that
+   directly or indirectly controls, is controlled by, or is under
+   common control with You. "Control" means the power to direct the
+   management and operating decisions of an entity, whether through
+   equity ownership, voting rights, contractual arrangements, or
+   otherwise.
+
+=========================================================================
+
+   Copyright 2026 PULSE8.ai
+
+   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.
+
+   This software is additionally subject to the PULSE8.ai Cortex
+   additional terms set out above (Sections A1–A4).