docstring-ai

AI-powered docstring generator for Python codebases. Batch-generates Google, NumPy, or Sphinx docstrings. Preserves existing docs. CI-ready.

Install

pip install docstring-ai

Requires ANTHROPIC_API_KEY.

Quick start

from docstring_ai import DocstringAI

ai = DocstringAI(style="google")

# Single function
result = ai.generate_for_source("""
def compute_recall(retrieved: list, relevant: list, k: int = 5) -> float:
    hits = sum(1 for r in retrieved[:k] if r in relevant)
    return hits / len(relevant) if relevant else 0.0
""")
print(result.docstring)

# Entire file
report = ai.process_file("mymodule.py", dry_run=True)
print(report.summary())
# Generated:    8 / Already had: 3 / Skipped: 2

# Entire directory
reports = ai.process_directory("src/", pattern="*.py")

Styles

DocstringAI(style="google")   # Google (default)
DocstringAI(style="numpy")    # NumPy
DocstringAI(style="sphinx")   # Sphinx / reST

CLI

docstring-ai src/mymodule.py --dry-run
docstring-ai src/ --style numpy
docstring-ai src/ --overwrite --include-private

Linda Oraegbunam | LinkedIn | GitHub