doctracker 0.1.0__tar.gz

doctracker-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Carlos Filipe de Castro Lemos
+
+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.

doctracker-0.1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: doctracker
+Version: 0.1.0
+Summary: MCP server that centralizes the documentation of Python projects developed with LLM agents.
+Author: Carlos Filipe de Castro Lemos
+Author-email: Carlos Filipe de Castro Lemos <carlos.lemos.dev@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+License-File: src/doctracker/wiki/static/htmx-LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Software Development :: Documentation
+Requires-Dist: click>=8.5.0
+Requires-Dist: griffe>=2.4.1
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: markdown-it-py>=4.2.0
+Requires-Dist: mcp>=2.3.0,<3
+Requires-Dist: pygments>=2.21.0
+Requires-Dist: starlette>=1.10.0
+Requires-Dist: uvicorn>=0.54.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/cfclemos/doctracker
+Project-URL: Repository, https://github.com/cfclemos/doctracker
+Project-URL: Issues, https://github.com/cfclemos/doctracker/issues
+Description-Content-Type: text/markdown
+
+# DOCUMENTATION TRACKER (DOCTRACKER)
+
+**One place for the documentation of a Python project developed with LLM agents.**
+
+When agents work on a codebase, documentation ends up scattered: notes in many
+Markdown files, memories, code comments and commit messages, all drifting out of
+sync. Documentation Tracker (doctracker) centralizes it. It runs an [MCP](https://modelcontextprotocol.io)
+server that any agent (Claude Code, OpenCode, …) can connect to, and serves a live
+wiki of the project in your browser.
+
+> **Status: alpha (0.1).** This first version builds the technical reference of the
+> code. Notes, commit history and LLM summaries come in the next versions (see
+> [Roadmap](#roadmap)).
+
+## Features
+
+- **Technical reference built from the code** — modules, classes, functions,
+  methods and attributes, with signatures, type hints, decorators and parsed
+  docstrings (Google, NumPy or Sphinx style).
+- **Static analysis only** — the code is read with [griffe](https://mkdocstrings.github.io/griffe/),
+  never imported or executed.
+- **Live wiki** — edit a file and the open page updates by itself.
+- **MCP server** — agents can list and read the documentation, and get a guide on
+  how to document the code so the wiki stays complete.
+- **Search** — by name, path and description, with keyboard navigation.
+- **Everything in one folder** — doctracker keeps its files in `doc/` inside your
+  project and never touches anything else.
+- **Cross-platform** — Windows and Linux, Python 3.11+.
+
+## Installation
+
+Install it as a development dependency of the project you want to document:
+
+```bash
+uv add --dev doctracker
+```
+
+or with pip:
+
+```bash
+pip install doctracker
+```
+
+## Quick start
+
+From the root of your project:
+
+```bash
+doctracker init     # creates doc/config/config.json (packages are detected automatically)
+doctracker start    # starts the server
+```
+
+With uv, prefix the commands with `uv run` (e.g. `uv run doctracker start`).
+`start` runs `init` on its own if the project has no configuration yet.
+
+The server prints its two addresses:
+
+```text
+Wiki: http://127.0.0.1:8765/
+MCP:  http://127.0.0.1:8765/mcp
+```
+
+Open the wiki in your browser. Keep the server running while you work on the code;
+stop it with `Ctrl+C`.
+
+## Connecting an agent
+
+The MCP server uses the Streamable HTTP transport at `http://127.0.0.1:8765/mcp`.
+The server must be running before the agent connects.
+
+**Claude Code** — add a `.mcp.json` file at the root of your project:
+
+```json
+{
+  "mcpServers": {
+    "doctracker": { "type": "http", "url": "http://127.0.0.1:8765/mcp" }
+  }
+}
+```
+
+or register it from the terminal:
+
+```bash
+claude mcp add --transport http doctracker http://127.0.0.1:8765/mcp
+```
+
+**OpenCode** — in `opencode.json`:
+
+```json
+{
+  "mcp": {
+    "doctracker": { "type": "remote", "url": "http://127.0.0.1:8765/mcp" }
+  }
+}
+```
+
+**Other agents** — any MCP client that supports Streamable HTTP can connect to the
+same URL.
+
+### What the agent gets
+
+| Name | Kind | What it does |
+| --- | --- | --- |
+| `list_entities` | tool | Lists documented entities, filtered by path prefix and kind. |
+| `get_entity` | tool | Full technical reference of one entity. |
+| `status` | tool | Whether the documentation is built, and loading errors. |
+| `documentation_guide` | tool | How to document this project's code (adapted to its settings). |
+| `doctracker://guide` | resource | The same guide, as a Markdown resource. |
+
+The server's instructions tell the agent to read the guide before writing or
+changing docstrings.
+
+## The wiki
+
+- **Tree** — packages (📦/📁), modules (📄), classes (**C**), functions (**f**) and
+  methods (**m**). Branches collapse; the tree can be resized or hidden (☰).
+- **Module pages** — description, public API (`__all__`) and members grouped by kind.
+- **Entity pages** — description, signature, parameters table, returns, raises,
+  examples, notes, members (for classes) and the source code with syntax
+  highlighting. Every section can be collapsed from its badge.
+- **Code theme** — choose among the Pygments themes in the Source section; the
+  choice is saved in `config.json`.
+- **Search** — press `/` anywhere, type, use ↑/↓ and Enter.
+
+## Configuration
+
+`doc/config/config.json` (created by `doctracker init`):
+
+| Key | Default | Description |
+| --- | --- | --- |
+| `packages` | detected | Top-level packages to document. |
+| `search_paths` | `["src", "."]` | Folders where the packages are found, relative to the project root. |
+| `host` | `"127.0.0.1"` | Address the server listens on. |
+| `port` | `8765` | Port of the server (also `doctracker start --port`). |
+| `docstring_style` | `"google"` | `google`, `numpy` or `sphinx`. |
+| `show_private` | `true` | Show `_private` members. |
+| `code_theme` | `"default"` | Pygments theme of the source code. |
+| `ssl_certfile` / `ssl_keyfile` | `null` | Certificate and key files; when both are set, the server uses HTTPS. |
+| `watch_interval` | `1.0` | Seconds between checks for changed files. |
+
+### The `doc/` folder
+
+```text
+doc/
+├── .gitignore        # keeps local data out of git
+└── config/
+    └── config.json   # commit this file
+```
+
+Other folders (local data, models) are created only when a feature needs them, and
+are ignored by `doc/.gitignore`.
+
+## Documenting your code
+
+doctracker shows what the code says, so the wiki is as good as the docstrings. In
+short:
+
+- a docstring for every module, public class, function and method;
+- the first line is a one-sentence summary (it is used in lists and search);
+- type hints on every parameter and return value;
+- `Args`, `Returns`, `Raises`, `Attributes` and `Examples` sections as needed;
+- constants documented with a string on the line after the assignment.
+
+```python
+def get_weather(city: str, units: str = "metric") -> Forecast:
+    """Fetch the forecast for a city.
+
+    Args:
+        city: City name, e.g. `Lisbon`.
+        units: `metric` or `imperial`.
+
+    Returns:
+        Forecast data for the city.
+
+    Raises:
+        CityNotFound: When the city is unknown.
+    """
+```
+
+Agents get the complete guide from the `documentation_guide` tool.
+
+## Security
+
+- By default the server listens only on `127.0.0.1`, and the MCP endpoint
+  validates the `Host` and `Origin` headers (protection against DNS rebinding).
+- The wiki only accepts changes (such as the code theme) from its own pages.
+- Exposing the server on a network is not supported yet: there is no
+  authentication in this version.
+
+## Roadmap
+
+- Notes recorded by the agent through the MCP server, turned into atomic commits.
+- Commit history linked to each function and class, with LLM summaries
+  (llama.cpp or vLLM).
+- Knowledge graph of the code: callers, callees, dead code.
+- Semantic search.
+- Editing the documentation from the wiki.
+
+## License
+
+[MIT](LICENSE). The bundled [htmx](https://htmx.org) is distributed under the
+Zero-Clause BSD license (`src/doctracker/wiki/static/htmx-LICENSE.txt`).

doctracker-0.1.0/README.md

@@ -0,0 +1,202 @@
+# DOCUMENTATION TRACKER (DOCTRACKER)
+
+**One place for the documentation of a Python project developed with LLM agents.**
+
+When agents work on a codebase, documentation ends up scattered: notes in many
+Markdown files, memories, code comments and commit messages, all drifting out of
+sync. Documentation Tracker (doctracker) centralizes it. It runs an [MCP](https://modelcontextprotocol.io)
+server that any agent (Claude Code, OpenCode, …) can connect to, and serves a live
+wiki of the project in your browser.
+
+> **Status: alpha (0.1).** This first version builds the technical reference of the
+> code. Notes, commit history and LLM summaries come in the next versions (see
+> [Roadmap](#roadmap)).
+
+## Features
+
+- **Technical reference built from the code** — modules, classes, functions,
+  methods and attributes, with signatures, type hints, decorators and parsed
+  docstrings (Google, NumPy or Sphinx style).
+- **Static analysis only** — the code is read with [griffe](https://mkdocstrings.github.io/griffe/),
+  never imported or executed.
+- **Live wiki** — edit a file and the open page updates by itself.
+- **MCP server** — agents can list and read the documentation, and get a guide on
+  how to document the code so the wiki stays complete.
+- **Search** — by name, path and description, with keyboard navigation.
+- **Everything in one folder** — doctracker keeps its files in `doc/` inside your
+  project and never touches anything else.
+- **Cross-platform** — Windows and Linux, Python 3.11+.
+
+## Installation
+
+Install it as a development dependency of the project you want to document:
+
+```bash
+uv add --dev doctracker
+```
+
+or with pip:
+
+```bash
+pip install doctracker
+```
+
+## Quick start
+
+From the root of your project:
+
+```bash
+doctracker init     # creates doc/config/config.json (packages are detected automatically)
+doctracker start    # starts the server
+```
+
+With uv, prefix the commands with `uv run` (e.g. `uv run doctracker start`).
+`start` runs `init` on its own if the project has no configuration yet.
+
+The server prints its two addresses:
+
+```text
+Wiki: http://127.0.0.1:8765/
+MCP:  http://127.0.0.1:8765/mcp
+```
+
+Open the wiki in your browser. Keep the server running while you work on the code;
+stop it with `Ctrl+C`.
+
+## Connecting an agent
+
+The MCP server uses the Streamable HTTP transport at `http://127.0.0.1:8765/mcp`.
+The server must be running before the agent connects.
+
+**Claude Code** — add a `.mcp.json` file at the root of your project:
+
+```json
+{
+  "mcpServers": {
+    "doctracker": { "type": "http", "url": "http://127.0.0.1:8765/mcp" }
+  }
+}
+```
+
+or register it from the terminal:
+
+```bash
+claude mcp add --transport http doctracker http://127.0.0.1:8765/mcp
+```
+
+**OpenCode** — in `opencode.json`:
+
+```json
+{
+  "mcp": {
+    "doctracker": { "type": "remote", "url": "http://127.0.0.1:8765/mcp" }
+  }
+}
+```
+
+**Other agents** — any MCP client that supports Streamable HTTP can connect to the
+same URL.
+
+### What the agent gets
+
+| Name | Kind | What it does |
+| --- | --- | --- |
+| `list_entities` | tool | Lists documented entities, filtered by path prefix and kind. |
+| `get_entity` | tool | Full technical reference of one entity. |
+| `status` | tool | Whether the documentation is built, and loading errors. |
+| `documentation_guide` | tool | How to document this project's code (adapted to its settings). |
+| `doctracker://guide` | resource | The same guide, as a Markdown resource. |
+
+The server's instructions tell the agent to read the guide before writing or
+changing docstrings.
+
+## The wiki
+
+- **Tree** — packages (📦/📁), modules (📄), classes (**C**), functions (**f**) and
+  methods (**m**). Branches collapse; the tree can be resized or hidden (☰).
+- **Module pages** — description, public API (`__all__`) and members grouped by kind.
+- **Entity pages** — description, signature, parameters table, returns, raises,
+  examples, notes, members (for classes) and the source code with syntax
+  highlighting. Every section can be collapsed from its badge.
+- **Code theme** — choose among the Pygments themes in the Source section; the
+  choice is saved in `config.json`.
+- **Search** — press `/` anywhere, type, use ↑/↓ and Enter.
+
+## Configuration
+
+`doc/config/config.json` (created by `doctracker init`):
+
+| Key | Default | Description |
+| --- | --- | --- |
+| `packages` | detected | Top-level packages to document. |
+| `search_paths` | `["src", "."]` | Folders where the packages are found, relative to the project root. |
+| `host` | `"127.0.0.1"` | Address the server listens on. |
+| `port` | `8765` | Port of the server (also `doctracker start --port`). |
+| `docstring_style` | `"google"` | `google`, `numpy` or `sphinx`. |
+| `show_private` | `true` | Show `_private` members. |
+| `code_theme` | `"default"` | Pygments theme of the source code. |
+| `ssl_certfile` / `ssl_keyfile` | `null` | Certificate and key files; when both are set, the server uses HTTPS. |
+| `watch_interval` | `1.0` | Seconds between checks for changed files. |
+
+### The `doc/` folder
+
+```text
+doc/
+├── .gitignore        # keeps local data out of git
+└── config/
+    └── config.json   # commit this file
+```
+
+Other folders (local data, models) are created only when a feature needs them, and
+are ignored by `doc/.gitignore`.
+
+## Documenting your code
+
+doctracker shows what the code says, so the wiki is as good as the docstrings. In
+short:
+
+- a docstring for every module, public class, function and method;
+- the first line is a one-sentence summary (it is used in lists and search);
+- type hints on every parameter and return value;
+- `Args`, `Returns`, `Raises`, `Attributes` and `Examples` sections as needed;
+- constants documented with a string on the line after the assignment.
+
+```python
+def get_weather(city: str, units: str = "metric") -> Forecast:
+    """Fetch the forecast for a city.
+
+    Args:
+        city: City name, e.g. `Lisbon`.
+        units: `metric` or `imperial`.
+
+    Returns:
+        Forecast data for the city.
+
+    Raises:
+        CityNotFound: When the city is unknown.
+    """
+```
+
+Agents get the complete guide from the `documentation_guide` tool.
+
+## Security
+
+- By default the server listens only on `127.0.0.1`, and the MCP endpoint
+  validates the `Host` and `Origin` headers (protection against DNS rebinding).
+- The wiki only accepts changes (such as the code theme) from its own pages.
+- Exposing the server on a network is not supported yet: there is no
+  authentication in this version.
+
+## Roadmap
+
+- Notes recorded by the agent through the MCP server, turned into atomic commits.
+- Commit history linked to each function and class, with LLM summaries
+  (llama.cpp or vLLM).
+- Knowledge graph of the code: callers, callees, dead code.
+- Semantic search.
+- Editing the documentation from the wiki.
+
+## License
+
+[MIT](LICENSE). The bundled [htmx](https://htmx.org) is distributed under the
+Zero-Clause BSD license (`src/doctracker/wiki/static/htmx-LICENSE.txt`).

doctracker-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "doctracker"
+version = "0.1.0"
+description = "MCP server that centralizes the documentation of Python projects developed with LLM agents."
+readme = "README.md"
+license = "MIT"
+license-files = [
+    "LICENSE",
+    "src/doctracker/wiki/static/htmx-LICENSE.txt",
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: Software Development :: Documentation",
+]
+dependencies = [
+    "click>=8.5.0",
+    "griffe>=2.4.1",
+    "jinja2>=3.1.6",
+    "markdown-it-py>=4.2.0",
+    "mcp>=2.3.0,<3",
+    "pygments>=2.21.0",
+    "starlette>=1.10.0",
+    "uvicorn>=0.54.0",
+]
+
+[[project.authors]]
+name = "Carlos Filipe de Castro Lemos"
+email = "carlos.lemos.dev@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/cfclemos/doctracker"
+Repository = "https://github.com/cfclemos/doctracker"
+Issues = "https://github.com/cfclemos/doctracker/issues"
+
+[project.scripts]
+doctracker = "doctracker.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.13.1,<0.14.0"]
+build-backend = "uv_build"

doctracker-0.1.0/pyproject.toml.orig

@@ -0,0 +1,44 @@
+[project]
+name = "doctracker"
+version = "0.1.0"
+description = "MCP server that centralizes the documentation of Python projects developed with LLM agents."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE", "src/doctracker/wiki/static/htmx-LICENSE.txt"]
+authors = [
+    { name = "Carlos Filipe de Castro Lemos", email = "carlos.lemos.dev@gmail.com" }
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: Software Development :: Documentation",
+]
+dependencies = [
+    "click>=8.5.0",
+    "griffe>=2.4.1",
+    "jinja2>=3.1.6",
+    "markdown-it-py>=4.2.0",
+    "mcp>=2.3.0,<3",
+    "pygments>=2.21.0",
+    "starlette>=1.10.0",
+    "uvicorn>=0.54.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/cfclemos/doctracker"
+Repository = "https://github.com/cfclemos/doctracker"
+Issues = "https://github.com/cfclemos/doctracker/issues"
+
+[project.scripts]
+doctracker = "doctracker.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.13.1,<0.14.0"]
+build-backend = "uv_build"

doctracker-0.1.0/src/doctracker/__init__.py

@@ -0,0 +1,5 @@
+"""doctracker: centralized documentation for Python projects developed with LLM agents."""
+
+from importlib.metadata import version
+
+__version__ = version("doctracker")

doctracker-0.1.0/src/doctracker/__main__.py

@@ -0,0 +1,4 @@
+from doctracker.cli import main
+
+if __name__ == "__main__":
+    main()

doctracker-0.1.0/src/doctracker/cli.py

@@ -0,0 +1,55 @@
+"""Command line interface: `doctracker init` and `doctracker start`."""
+
+from pathlib import Path
+
+import click
+
+from doctracker import __version__
+from doctracker.config import CONFIG_PATH, Config, detect_packages, load_config, write_config
+
+
+@click.group()
+@click.version_option(__version__, prog_name="doctracker")
+def main() -> None:
+    """Centralized documentation for Python projects developed with LLM agents."""
+
+
+@main.command()
+@click.option("--force", is_flag=True, help="Overwrite an existing configuration.")
+def init(force: bool) -> None:
+    """Create doc/config/config.json in the current project."""
+    project_root = Path.cwd()
+    if (project_root / CONFIG_PATH).exists() and not force:
+        raise click.ClickException(f"{CONFIG_PATH.as_posix()} already exists (use --force to overwrite).")
+    _initialize(project_root)
+
+
+@main.command()
+@click.option("--host", help="Override the host from the configuration.")
+@click.option("--port", type=int, help="Override the port from the configuration.")
+def start(host: str | None, port: int | None) -> None:
+    """Start the server (MCP endpoint, wiki and watcher) for the current project."""
+    from doctracker.server.app import run
+
+    project_root = Path.cwd()
+    if not (project_root / CONFIG_PATH).exists():
+        _initialize(project_root)
+    config = load_config(project_root)
+    if host:
+        config.host = host
+    if port:
+        config.port = port
+    if not config.packages:
+        raise click.ClickException(f"No packages to document. Add them to {CONFIG_PATH.as_posix()}.")
+    scheme = "https" if config.ssl_certfile else "http"
+    click.echo(f"Wiki: {scheme}://{config.host}:{config.port}/")
+    click.echo(f"MCP:  {scheme}://{config.host}:{config.port}/mcp")
+    run(project_root, config)
+
+
+def _initialize(project_root: Path) -> None:
+    config = Config()
+    config.packages = detect_packages(project_root, config.search_paths)
+    write_config(project_root, config)
+    found = ", ".join(config.packages) or "none (edit the file to add them)"
+    click.echo(f"Created {CONFIG_PATH.as_posix()}. Packages: {found}")

doctracker-0.1.0/src/doctracker/config.py

@@ -0,0 +1,65 @@
+"""Load and write the doctracker configuration (`doc/config/config.json`)."""
+
+import json
+from dataclasses import asdict, dataclass, field
+from pathlib import Path
+
+DOC_DIR = "doc"
+CONFIG_PATH = Path(DOC_DIR) / "config" / "config.json"
+GITIGNORE_PATH = Path(DOC_DIR) / ".gitignore"
+GITIGNORE_CONTENT = "sqlite/\nmodels/\n"
+
+
+@dataclass
+class Config:
+    """Settings read from `doc/config/config.json`."""
+
+    packages: list[str] = field(default_factory=list)
+    search_paths: list[str] = field(default_factory=lambda: ["src", "."])
+    host: str = "127.0.0.1"
+    port: int = 8765
+    docstring_style: str = "google"
+    show_private: bool = True
+    code_theme: str = "default"
+    ssl_certfile: str | None = None
+    ssl_keyfile: str | None = None
+    watch_interval: float = 1.0
+
+
+def load_config(project_root: Path) -> Config:
+    """Read the config file of a project, filling missing keys with defaults."""
+    path = project_root / CONFIG_PATH
+    data = json.loads(path.read_text(encoding="utf-8"))
+    known = Config.__dataclass_fields__
+    return Config(**{key: value for key, value in data.items() if key in known})
+
+
+def write_config(project_root: Path, config: Config) -> None:
+    """Write the config file and the `doc/.gitignore`."""
+    path = project_root / CONFIG_PATH
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(json.dumps(asdict(config), indent=2) + "\n", encoding="utf-8")
+    (project_root / GITIGNORE_PATH).write_text(GITIGNORE_CONTENT, encoding="utf-8")
+
+
+def update_config_value(project_root: Path, key: str, value) -> None:
+    """Change one key in the config file, keeping everything else as it is on disk."""
+    path = project_root / CONFIG_PATH
+    data = json.loads(path.read_text(encoding="utf-8"))
+    data[key] = value
+    path.write_text(json.dumps(data, indent=2) + "\n", encoding="utf-8")
+
+
+def detect_packages(project_root: Path, search_paths: list[str]) -> list[str]:
+    """Find top-level Python packages (folders with `__init__.py`) in the search paths."""
+    packages = []
+    for search_path in search_paths:
+        base = project_root / search_path
+        if not base.is_dir():
+            continue
+        for child in sorted(base.iterdir()):
+            if child.name.startswith(".") or child.name == DOC_DIR:
+                continue
+            if (child / "__init__.py").is_file() and child.name not in packages:
+                packages.append(child.name)
+    return packages

doctracker-0.1.0/src/doctracker/extraction/__init__.py

@@ -0,0 +1,5 @@
+"""Extraction of technical data from the project's code."""
+
+from doctracker.extraction.griffe_loader import extract_project
+
+__all__ = ["extract_project"]