Skip to main content

contaix

Tools to make contexts (knowledge bases) for AI.

contaix turns diverse sources — code repos, documentation sites, file collections — into clean markdown contexts for AI agents to consume.

pip install contaix

Skills

This package ships agent skills you can install into any agent host with gh skill (don't have it? install gh):

gh skill install thorwhalen/contaix contaix-acquire-docs --agent claude-code
gh skill install thorwhalen/contaix contaix_docs_to_markdown
gh skill install thorwhalen/contaix contaix_web_aggregate
Skill Use it when…
contaix-acquire-docs acquiring a tool's docs (plus OpenAPI/MCP/GraphQL specs) as one agent-ready markdown bundle, cheapest source first
contaix_docs_to_markdown converting a documentation website into a single clean markdown file
contaix_web_aggregate aggregating arbitrary (non-docs) web pages into structured markdown, with manual control

Quick Start

Documentation site → single markdown file

from contaix.web import site_to_markdown

site_to_markdown(
    "https://fal.ai/docs/documentation",
    output_file="~/Downloads/fal_ai_docs.md",
    verbose=True,
)

site_to_markdown first probes the site for a publisher-provided /llms-full.txt bundle (Mintlify, Docusaurus, Fern, and others ship one). If found, it returns that directly — one HTTP request, clean markdown, no scraping. Otherwise it falls back to discovering navigation, fetching every page (with caching), and aggregating.

To bypass the fast path or grab the bundle yourself:

from contaix.web import find_llms_full_url, fetch_llms_full

bundle_url = find_llms_full_url("https://fal.ai/docs")  # str or None
markdown = fetch_llms_full("https://fal.ai/docs")  # str or None

Code base → single markdown file

from contaix import code_aggregate

# A local package
md = code_aggregate("contaix")

# A directory
md = code_aggregate("/path/to/project")

# A GitHub repo (downloaded via hubcap)
md = code_aggregate("https://github.com/thorwhalen/contaix")

# Save instead of return
code_aggregate("contaix", egress="/tmp/contaix_code.md")

Files → markdown

from contaix import bytes_to_markdown, bytes_store_to_markdown_store
from dol import Files

# Single file (auto-detects format)
md = bytes_to_markdown(open("report.pdf", "rb").read(), input_format="pdf")

# A whole folder
src = Files("/path/to/documents")
target = {}
bytes_store_to_markdown_store(src, target)

Markdown conversion is delegated to dn.src and supports PDF, DOCX, XLSX, PPTX, HTML, IPYNB, and more.

Cleanup of messy markdown (e.g. ChatGPT exports)

from contaix import remove_hyperlink_crap, remove_improperly_double_newlines

# Reads from clipboard if no arg, copies result back
clean = remove_hyperlink_crap()

Pure transforms live in dn.repair; the contaix wrappers add clipboard integration.

URLs in prose → article PDFs

from contaix import extract_urls, download_articles, verify_urls

# Inspect what URLs are in a string
list(extract_urls("[OpenAI](https://openai.com) and https://anthropic.com"))
# -> [('OpenAI', 'https://openai.com'), ('https://anthropic.com', 'https://anthropic.com')]

# Verify they resolve
verify_urls(["https://openai.com", "https://anthropic.com"])
# -> {'https://openai.com': 200, 'https://anthropic.com': 200}

# Download as PDFs (delegates to pdfdol)
download_articles(some_md_string, save_dir="~/Downloads/articles")

Package Map

contaix/
  web.py           # site_to_markdown, find_llms_full_url, RSC extraction
  code.py          # code_aggregate, PackageCodeContexts, GitHub fetch
  markdown.py      # bytes_to_markdown (delegates to dn.src)
  urls.py          # extract_urls, verify_urls, download_articles
  aggregation.py   # aggregate_store with deduplication and chunking
  util.py          # markdown_of_site, scrape utilities, clipboard helpers
  skills.py        # discover/install OTHER ecosystem packages' skills

contaix's own agent skills live at the repo root in skills/ (gh-distributed — see the Skills section above), symlinked into .claude/skills/.

Architecture

  • Functions are the primary interface; classes are reserved for stateful workflows (e.g. PackageCodeContexts).
  • dol store abstractions for file/data access throughout.
  • Smart defaults with keyword-only configurability — out of the box for common cases, fully parameterizable when needed.
  • Pure transforms live in domain packages (dn, pdfdol); contaix is the orchestration and UX layer.

Optional dependencies

  • pdfdol — for download_articles and PDF round-trips (pip install contaix[pdf])
  • dn[all] — for the full set of file-format converters (pip install contaix[all])
  • dn — pure markdown conversion and repair
  • pdfdol — PDF reading, writing, and format conversion
  • dol — store abstractions used everywhere
  • scraped — scraping primitives
  • hubcap — GitHub repo access

Metadata

Release files for contaix 0.0.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for contaix 0.0.28
File Size Uploaded Provenance
contaix-0.0.28.tar.gz 200.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for contaix 0.0.28
File Interpreter ABI Platform
contaix-0.0.28-py3-none-any.whl Python 3 none any Details

Total release size: 367.8 kB

Release files / contaix-0.0.28.tar.gz

Download URL contaix-0.0.28.tar.gz
Size 200.1 kB
Tags Source
SHA-256 checksum
How to use checksums
66b8a0e30c61380ec0c8bf52e7e1ea0af95a4bbdc755ade493cf8263a5d09436
BLAKE2b-256 checksum
How to use checksums
6b2b1ac1d5cfb43c8bc9a8b0728afedb5f25bb1affd6004b9f8509bc26186b8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / contaix-0.0.28-py3-none-any.whl

Download URL contaix-0.0.28-py3-none-any.whl
Size 167.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
468fa4d8aaa020f68e7ff02970c66f49550119f6b18c5a1ce69431fc1a9a30bb
BLAKE2b-256 checksum
How to use checksums
edd0fbbd06a5521f40e259691db60d34c9ce85fa37787e74f79bfc4b17993b5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for contaix 0.0.28

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page