Metadata-Version: 2.4
Name: docforge-gen
Version: 0.1.0
Summary: Automatically generate documentation for any GitHub repository using LLMs
Project-URL: Homepage, https://github.com/your-org/docforge
Project-URL: Repository, https://github.com/your-org/docforge
Project-URL: Issues, https://github.com/your-org/docforge/issues
License: MIT License
        
        Copyright (c) 2026 DocForge Contributors
        
        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.
License-File: LICENSE
Keywords: cli,code-analysis,documentation,llm,tree-sitter
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.11
Requires-Dist: gitpython>=3.1.40
Requires-Dist: httpx>=0.27.0
Requires-Dist: jinja2>=3.1.4
Requires-Dist: litellm>=1.52.0
Requires-Dist: pydantic>=2.8.0
Requires-Dist: rich>=14.0.0
Requires-Dist: tenacity>=9.0.0
Requires-Dist: tiktoken>=0.7.0
Requires-Dist: tree-sitter-go>=0.23.0
Requires-Dist: tree-sitter-java>=0.23.0
Requires-Dist: tree-sitter-javascript>=0.23.0
Requires-Dist: tree-sitter-python>=0.23.0
Requires-Dist: tree-sitter-rust>=0.23.0
Requires-Dist: tree-sitter-typescript>=0.23.0
Requires-Dist: tree-sitter>=0.23.0
Requires-Dist: typer>=0.12.0
Provides-Extra: dev
Requires-Dist: coverage>=7.5.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.4.0; extra == 'dev'
Provides-Extra: mkdocs
Requires-Dist: mkdocs-material>=9.5.0; extra == 'mkdocs'
Requires-Dist: mkdocs>=1.6.0; extra == 'mkdocs'
Description-Content-Type: text/markdown

# DocForge

AI-powered documentation generator for any GitHub repository or local project.

## Quick Start

```bash
pip install docforge

# From GitHub URL
docforge generate https://github.com/user/repo

# From local path
docforge generate ./my-project

# With Ollama (local, free)
docforge generate ./my-project --model ollama/llama3 --api-base http://localhost:11434
```

## What it generates

- `README.md` — Comprehensive project overview
- `INSTALLATION.md` — Setup and installation guide
- `ARCHITECTURE.md` — System architecture with Mermaid diagrams
- `CHANGELOG.md` — Formatted changelog from git history
- `api/*.md` — Per-module API reference docs
- `mkdocs.yml` — Optional MkDocs site config (`--mkdocs`)
- `.github/workflows/auto-docs.yml` — Optional GitHub Action (`--github-action`)

## Supported Languages

Python, JavaScript, TypeScript, Go, Rust, Java

## Supported LLM Providers

- **OpenAI** (default): `--model gpt-4o`
- **Anthropic Claude**: `--model claude-sonnet-4-6`
- **Ollama (local)**: `--model ollama/llama3 --api-base http://localhost:11434`
- Any provider supported by [LiteLLM](https://docs.litellm.ai)

## License

MIT
