DocGPT

DocGPT (docgpt) is a CLI tool that automatically generates documentation for code.

👉 All the in-code documentation of docgpt project are generated with docgpt! So meta! :point_left:

Installation

pip install docgpt

API Key

DocGPT depends on the GPT3 model, hence the name, trained and served by OpenAI.
Register for an account and get your API key here: https://openai.com/api/
Check OpenAI's Pricing and use it responsibly (roughly speaking, auto-documenting 4 pages of code with docgpt costs $0.05 USD).

Set the OPENAI_API_KEY environment variable, or specify via --api_key flag. The key will get cached in ~/.docgpt for future use.

Usage

# conventional use
docgpt <source> --target <target>

# piped
cat <source> | docgpt --target <target>

# overwrite
docgpt <source> --overwrite

To see available options try docgpt --help

Contributing

DocGPT is GNU GPL licensed and we intend to keep it purely open-source. We welcome contributions to docgpt. Your forks and pull-requests are always welcome.

To open a feature request or report a bug, please open an issue here.

Cause

DocGPT is open-sourced as part of the global action in solidarity with Iranians who are courageously demonstrating peacefully for their human rights.