docmancer 0.1.1__tar.gz

docmancer-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v

docmancer-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,92 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      # Glob (not regex): three-part semver tags like v0.1.1
+      - "v*.*.*"
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
+
+jobs:
+  smoke-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install package and build tools
+        run: pip install -e ".[dev]" build twine "hatchling<1.27"
+
+      - name: Verify tag matches package version
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          PKG="$(python -c "from docmancer._version import __version__; print(__version__)")"
+          if [[ "$TAG" != "$PKG" ]]; then
+            echo "::error::Git tag $GITHUB_REF_NAME does not match docmancer._version ($PKG). Bump docmancer/_version.py before tagging."
+            exit 1
+          fi
+
+      - name: Run tests
+        run: pytest tests/ -v
+
+      - name: Run smoke CLI checks
+        run: |
+          python -m docmancer --help
+          TMP_DIR="$(mktemp -d)"
+          python -m docmancer init --dir "$TMP_DIR"
+          test -f "$TMP_DIR/docmancer.yaml"
+          python -m docmancer doctor --config "$TMP_DIR/docmancer.yaml"
+
+      - name: Build artifacts
+        run: python -m build --no-isolation
+
+      - name: Check artifacts
+        run: python -m twine check dist/*
+
+  build:
+    needs: smoke-test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install build twine "hatchling<1.27"
+
+      - name: Build
+        run: python -m build --no-isolation
+
+      - name: Check artifacts
+        run: python -m twine check dist/*
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

docmancer-0.1.1/.gitignore

@@ -0,0 +1,17 @@
+.claude/
+__pycache__/
+*.pyc
+.pytest_cache/
+.qdrant/
+.venv/
+dist/
+build/
+coverage/
+.DS_Store
+.worktrees/
+.docmancer/
+.docs-kit/
+downloaded-docs/
+/release-patch-pypi.sh
+/repush-release-tag.sh
+docs/

docmancer-0.1.1/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 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.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Release numbers were restarted at **0.1.1** after a fresh git history; PyPI installs use this line only going forward.
+
+## [0.1.1] - 2026-03-29
+
+### Added
+
+- Initial release on the restarted version line: fetch GitBook/Mintlify docs, local FastEmbed + Qdrant ingest, `docmancer query` / `list` / `remove` / `inspect` / `doctor`, and agent skill install targets (Claude Code, Cursor, Codex, OpenCode, Claude Desktop, Gemini, etc.).

docmancer-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to docmancer
+
+Thank you for contributing! This guide covers project layout and common extension points.
+
+## Project structure
+
+```text
+docmancer/
+  agent.py              # DocmancerAgent; parser registry (_PARSERS); component wiring
+  core/
+    config.py           # DocmancerConfig (pydantic-settings)
+    models.py           # Document, Chunk, RetrievedChunk
+    chunking.py         # Text/markdown chunking
+  connectors/
+    fetchers/           # GitBook and other doc sources (base + gitbook)
+    embeddings/         # Embedding backends (FastEmbed)
+    parsers/            # Document loaders (text, markdown)
+    vector_stores/      # Qdrant store
+  cli/
+    commands.py         # Click commands
+    __main__.py         # CLI entry point
+tests/                  # pytest tests (mirror docmancer/ where useful)
+```
+
+## Adding a new document parser
+
+1. Implement a loader subclassing `BaseLoader` in `docmancer/connectors/parsers/`.
+2. Register the file extension in `_PARSERS` in `docmancer/agent.py` (dotted import path to the class).
+
+## Adding a new embedding provider
+
+1. Implement the dense (and if needed sparse) API following `docmancer/connectors/embeddings/base.py`.
+2. Extend the `embedding.provider` branch in `DocmancerAgent._init_components()` in `docmancer/agent.py`.
+3. Extend `DocmancerConfig` / YAML schema in `docmancer/core/config.py` if new settings are required.
+4. Add optional dependencies in `pyproject.toml` if the provider needs extra packages.
+
+## Adding a new vector store
+
+1. Implement `BaseVectorStore` in `docmancer/connectors/vector_stores/`.
+2. Extend the `vector_store.provider` branch in `DocmancerAgent._init_components()` and add config fields as needed.
+
+## Adding a new doc source (fetcher)
+
+1. Subclass `BaseFetcher` in `docmancer/connectors/fetchers/`.
+2. Wire the new source into the CLI `fetch` / `ingest` paths in `docmancer/cli/commands.py` (and any agent helpers) following the GitBook pattern.
+
+## Running tests
+
+**On macOS (to avoid arm64/x86_64 Rosetta issues):**
+
+```bash
+arch -arm64 .venv/bin/python -m pytest tests/ -v
+```
+
+**On Linux / CI:**
+
+```bash
+pytest tests/ -v
+```
+
+## Submitting a PR
+
+- Branch name: `feat/<topic>` or `fix/<description>`
+- Run the full test suite before opening the PR
+- New connectors or fetchers should include tests where practical

docmancer-0.1.1/LICENSE

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

docmancer-0.1.1/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.3
+Name: docmancer
+Version: 0.1.1
+Summary: Fetch docs, embed locally, expose to AI agents via skills.
+License: MIT License
+        
+        Copyright (c) 2026 Docs Kit Limited
+        
+        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.
+Requires-Python: <3.14,>=3.11
+Requires-Dist: click>=8.0.0
+Requires-Dist: fastembed>=0.6.0
+Requires-Dist: filelock>=3.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic-settings>=2.2.1
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: qdrant-client>=1.10.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# docmancer
+
+[![PyPI version](https://img.shields.io/pypi/v/docmancer)](https://pypi.org/project/docmancer/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/docmancer)](https://pypi.org/project/docmancer/)
+[![CI](https://github.com/docmancer/docmancer/actions/workflows/ci.yml/badge.svg)](https://github.com/docmancer/docmancer/actions/workflows/ci.yml)
+
+Fetch docs from GitBook, Mintlify, or local files, embed them locally, and teach AI agents to search them via installed **skills** (CLI commands). No API keys for the default embedding path. No background server—agents run `docmancer` from the terminal.
+
+## What it does
+
+- Fetches public docs from **GitBook** and **Mintlify** sites via `/llms-full.txt` and `/llms.txt`, with a **sitemap.xml** fallback on Mintlify when those endpoints are missing
+- **`docmancer ingest`:** `--provider auto` (default) uses a combined strategy (llms endpoints → sitemap). **`--provider gitbook`** uses the GitBook-only fetcher; **`--provider mintlify`** uses the same pipeline as `auto`
+- Ingests local `.md` and `.txt` files
+- Stores vectors in **embedded Qdrant** on disk — typically `~/.docmancer/qdrant` when using the auto-created user config, or `.docmancer/qdrant` (resolved relative to your `docmancer.yaml`) for a project-local config from `docmancer init`
+- **Hybrid retrieval** (dense embeddings + sparse / BM25-style vectors) for `docmancer query` and agent-driven queries
+- Installs **skill files** into Claude Code, Cursor, Codex, OpenCode, and Claude Desktop so agents run `docmancer` over the shell
+- Concurrent CLI runs coordinate with a **file lock** on the local Qdrant path
+
+## Install
+
+Recommended: **`pipx`** so `docmancer` is on your PATH:
+
+```bash
+pipx install docmancer
+```
+
+Install `pipx` if needed:
+
+```bash
+brew install pipx
+pipx ensurepath
+```
+
+Or **`pip`** inside a virtual environment:
+
+```bash
+pip install docmancer
+```
+
+## Quickstart
+
+```bash
+# 1. Install (once)
+pipx install docmancer
+
+# 2. Ingest docs
+docmancer ingest https://docs.example.com
+
+# 3. Install skill into your agent
+docmancer install claude-code   # or: cursor, codex, opencode, claude-desktop
+
+# 4. Use the agent — it can run docmancer query / list / ingest when relevant
+```
+
+No server to start. On first use, config and the default vector store path are created under **`~/.docmancer/`** unless you use a project-local `docmancer.yaml`.
+
+## How it works
+
+docmancer installs a **skill** (Markdown + YAML frontmatter) into each tool’s skills directory. The skill tells the agent when to use docmancer and which commands to run (`query`, `list`, `ingest`, `remove`, `inspect`, `doctor`, …). Agents execute **`docmancer`** via their normal terminal integration.
+
+For more architecture detail (config resolution, layout, security posture), see [docs/project-overview.md](docs/project-overview.md).
+
+## Install targets
+
+| Command | Where the skill lands |
+|---------|------------------------|
+| `docmancer install claude-code` | `~/.claude/skills/docmancer/SKILL.md` |
+| `docmancer install codex` | `~/.codex/skills/docmancer/SKILL.md` (also mirrors to `~/.agents/skills/docmancer/SKILL.md` for compatibility) |
+| `docmancer install cursor` | `~/.cursor/skills/docmancer/SKILL.md` + marked block in `~/.cursor/AGENTS.md` when needed |
+| `docmancer install opencode` | `~/.config/opencode/skills/docmancer/SKILL.md` (and may mirror under `~/.agents/skills/` if absent) |
+| `docmancer install claude-desktop` | `~/.docmancer/exports/claude-desktop/docmancer.zip` — upload via Claude Desktop **Customize → Skills** |
+
+`codex-app` and `codex-desktop` are accepted aliases for the Codex install path.
+
+Use **`--project`** with `claude-code` for `.claude/skills/docmancer/SKILL.md` in the current repo.
+
+## Commands
+
+### `docmancer install <agent>`
+
+Install the docmancer skill into a supported agent.
+
+```bash
+docmancer install claude-code
+docmancer install cursor
+docmancer install codex
+docmancer install opencode
+docmancer install claude-desktop
+docmancer install claude-code --project
+docmancer install cursor --config ./docmancer.yaml
+```
+
+If no config is found, **`~/.docmancer/docmancer.yaml`** is created automatically (non-project installs).
+
+### `docmancer ingest <path-or-url>`
+
+Ingest a local file, directory, or documentation URL.
+
+```bash
+docmancer ingest ./docs
+docmancer ingest https://docs.example.com
+docmancer ingest https://docs.example.com --provider gitbook
+docmancer ingest ./docs --recreate
+```
+
+`--provider`: `auto` (default), `gitbook`, or `mintlify`.
+
+### `docmancer query <text>`
+
+Run hybrid retrieval from the CLI.
+
+```bash
+docmancer query "How do I authenticate?"
+docmancer query "getting started" --limit 3
+docmancer query "season 5 end date" --full
+docmancer query "..." --config ./docmancer.yaml
+```
+
+Use `--full` when you want the entire chunk body instead of the default preview.
+
+### `docmancer list`
+
+List ingested sources with ingestion timestamps.
+
+```bash
+docmancer list
+docmancer list --config ./docmancer.yaml
+```
+
+### `docmancer fetch <url>`
+
+Download **GitBook** docs as Markdown files only (does not embed). For Mintlify or mixed hosting, use **`docmancer ingest`** or copy files locally first.
+
+```bash
+docmancer fetch https://docs.example.com
+docmancer fetch https://docs.example.com --output ./downloaded-docs
+```
+
+### `docmancer remove <source>`
+
+Remove an ingested source by URL or file path.
+
+```bash
+docmancer remove https://docs.example.com/page
+docmancer remove ./docs/getting-started.md
+```
+
+### `docmancer inspect`
+
+Show collection stats and embedding settings.
+
+```bash
+docmancer inspect
+docmancer inspect --config ./docmancer.yaml
+```
+
+### `docmancer doctor`
+
+Check `docmancer` on PATH, effective config, Qdrant path / connectivity, and which skills are installed.
+
+For Codex installs, `doctor` reports both the native `~/.codex/skills/...` install and the shared compatibility mirror under `~/.agents/skills/...` when present.
+
+```bash
+docmancer doctor
+docmancer doctor --config ./docmancer.yaml
+```
+
+### `docmancer init`
+
+Create a project-local **`docmancer.yaml`** (optional if you rely on `~/.docmancer/docmancer.yaml`).
+
+```bash
+docmancer init
+docmancer init --dir ./sandbox
+```
+
+## Configuration
+
+**Resolution order:** `--config` → `./docmancer.yaml` in the current working directory → `~/.docmancer/docmancer.yaml` (created on first use when applicable).
+
+Example **project-local** `docmancer.yaml` from `docmancer init`:
+
+```yaml
+embedding:
+  provider: fastembed
+  model: BAAI/bge-small-en-v1.5
+
+vector_store:
+  provider: qdrant
+  local_path: .docmancer/qdrant   # resolved relative to this file’s directory
+  collection_name: knowledge_base
+  retrieval_limit: 5
+  score_threshold: 0.35
+
+ingestion:
+  chunk_size: 800
+  chunk_overlap: 120
+  bm25_model: Qdrant/bm25
+```
+
+The auto-created **user** config under `~/.docmancer/` sets `local_path` to an absolute directory under **`~/.docmancer/qdrant`**. To use a **remote** Qdrant instance, set `vector_store.url` and leave local storage unused.
+
+## Supported sources
+
+| Source | Strategy |
+|--------|----------|
+| GitBook sites | `/llms-full.txt` → `/llms.txt` (GitBook fetcher); `auto` / `mintlify` use the broader pipeline below |
+| Mintlify & typical llms.txt sites | `/llms-full.txt` → `/llms.txt` → `/sitemap.xml` |
+| Local `.md` / `.txt` | Read from disk |
+
+## Requirements
+
+- **Python 3.11–3.13** (`requires-python` excludes 3.14+ while dependencies such as `onnxruntime` lack wheels)
+- Disk space for the embedding model (on the order of tens of MB for the default model)
+
+If your default `python` is 3.14:
+
+```bash
+pipx install docmancer --python python3.13
+```
+
+## Migration from v0.1.x
+
+Older releases wired a separate server into some agent configs. Use **skills + CLI** instead.
+
+1. Remove any legacy **docmancer** server block from `~/.claude/settings.json`, Cursor or Codex tool-server config, `~/.codex/config.toml`, etc., if you still have one from an old install.
+2. Run **`docmancer install <agent>`** again to install skills.
+3. Existing **`~/.docmancer/docmancer.yaml`** and ingested data remain valid.