Skip to main content

Polyglot codebase inspection library for agent-driven development (namespace reserved; public release in progress)

Project description

otter-docs

A polyglot codebase inspection library for agent-driven development.

Status (2026-05-14): namespace reserved; public release in progress.

What it will be

otter-docs builds a queryable model of a codebase — modules, functions, classes, calls, imports — augmented with LLM-generated description embeddings, and emits structured findings (redundancy, drift, dead code, architectural smells) that an agent can act on. Each finding can carry a recommendation with rationale and an apply-ready diff.

The library is designed for agents to consume, not humans to read. The human operates the agent.

What's here today

This release (0.0.0) reserves the PyPI namespace. It contains no functional code yet.

What's coming in v0.1

  • Polyglot AST via tree-sitter (Python, Go, TypeScript day one)
  • Precise name resolution via tree-sitter-stack-graphs
  • Three-vector indexing per symbol (description, code, docstring)
  • Static-tier detectors wrapping similarity-py, vulture, pydeps, radon
  • Embedding-augmented redundancy + drift detectors
  • Agent harness (MCP-style tools, prompts, schemas, runner)
  • SQLite + sqlite-vec graph backend; Neo4j adapter for heavy graphs
  • Git hook + systemd timer integration

Roadmap and design notes live in the repository (link below) once public.

Why

AI-assisted development produces working code fast and produces redundancy fast. otter-docs is the biopsy layer — deterministic where it can be, LLM-augmented where it must be, agent-readable everywhere.

License

MIT.

Links

Watch this space

Follow the PyPI page or the GitHub repository for v0.1 release notes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

otter_docs-0.0.0.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

otter_docs-0.0.0-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file otter_docs-0.0.0.tar.gz.

File metadata

  • Download URL: otter_docs-0.0.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for otter_docs-0.0.0.tar.gz
Algorithm Hash digest
SHA256 7e62f99d89c90eaa2e619854776f8df62cc14968657a53e1fb66ea4af2c6b9e9
MD5 08fb23fde16959dc5367cc4a216da6f7
BLAKE2b-256 bb14ce1b006e28e1980e02622182833e1fe246aa2485be85ae15088ac7fd02fe

See more details on using hashes here.

File details

Details for the file otter_docs-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: otter_docs-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for otter_docs-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e2a814d017c9a9d6d7a89d60e9d5b3364a995241395af5eed6c49c6cc30dd40
MD5 da9c365855afc5b3aef39c83066b87c2
BLAKE2b-256 42d8004b9160d60e8858f072e5e81a882c6ec08579c2a48dbadbd80d7c93877b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page