Skip to main content

A simple context builder and converter toolkit

Project description

ContextMaker

License Python

Feature to enrich the CMBAgents: Multi-Agent System for Science, Made by Cosmologists, Powered by AG2.

Acknowledgments

This project uses the CAMB code developed by Antony Lewis and collaborators. Please see the CAMB website and documentation for more information.


Installation

Install ContextMaker from PyPI:

pip install contextmaker

Usage

From the Command Line

ContextMaker automatically finds libraries on your system and generates complete documentation with function signatures and docstrings.

# Convert a library's documentation (automatic search)
contextmaker library_name

# Example: convert pixell documentation
contextmaker pixell

# Example: convert numpy documentation
contextmaker numpy

Advanced Usage

# Specify custom output path
contextmaker pixell --output ~/Documents/my_docs

# Specify manual input path (overrides automatic search)
contextmaker pixell --input_path /path/to/library/source

Output

  • Default location: ~/your_context_library/library_name.txt
  • Content: Complete documentation with function signatures, docstrings, examples, and API references
  • Format: Clean text optimized for AI agent ingestion

From a Python Script

You can also use ContextMaker programmatically in your Python scripts:

import contextmaker

# Minimal usage (automatic search, default output path)
contextmaker.convert("pixell")

# With custom output path
contextmaker.convert("pixell", output_path="/tmp")

# With manual input path
contextmaker.convert("pixell", input_path="/path/to/pixell/source")

This will generate a text file with the complete documentation, just like the CLI.


Supported Inputs

  • Sphinx documentation (conf.py + .rst) - Complete documentation with signatures
  • Markdown README files (README.md)
  • Jupyter notebooks (.ipynb)
  • Python source files with docstrings (auto-generated docs if no user docs)

Library Requirements

For complete documentation extraction, the library should have:

  • A docs/ or doc/ directory containing conf.py and index.rst
  • Source code accessible for docstring extraction

If only the installed package is found (without Sphinx docs), ContextMaker will extract available docstrings from the source code.


Troubleshooting

Library not found

# Use manual path
contextmaker pixell --input_path /path/to/pixell/repo

No documentation detected

  • Ensure the library has a docs/ or doc/ directory with conf.py and index.rst
  • Clone the official repository if using an installed package

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

contextmaker-0.1.1.tar.gz (17.3 kB view details)

Uploaded Source

Built Distribution

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

contextmaker-0.1.1-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file contextmaker-0.1.1.tar.gz.

File metadata

  • Download URL: contextmaker-0.1.1.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for contextmaker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1e189c377e2054a9234f63aefbb2e1e56dc4282aa0266fb3a632e66f60a959fe
MD5 6c0a89f7ea89cba8673180d507c64e20
BLAKE2b-256 d43cdbde6c034f118a5376526c5ec93d127bb858810f35ef57bf176706cdb43e

See more details on using hashes here.

File details

Details for the file contextmaker-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: contextmaker-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for contextmaker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e55384f03cf98a2136ca29062865254211c5104d717b773458bb0c22dd2e9033
MD5 2b1059905e5670d0bf17f15356e55013
BLAKE2b-256 c0cbf541408d1fe20ebc4b444349283bbaac2ab2ff1c9c9cfb93a244fb11a17e

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