aidoc

aidoc is a command line interface (CLI) tool that uses AI to automatically generate documentation for your code.

Requirements

• OpenAI API key: https://beta.openai.com/
• Python 3.6 or higher

Installation

• globally install the package

python3 -m pip install aidoc

• (recommended) create a virtual environment and install the package

pip install aidoc

Usage

To configure the API key and model for aidoc, run the following command:

aidoc configure

To generate documentation for a source file or directory, run the following command:

aidoc gen <source_file>

You can also specify the following optional arguments:

• -o or --overwrite: Overwrite existing docstrings
• -f or --format: Format the entire source file using black (default=True)
• -pr or --pull-request: Create a pull request with the changes

Examples

Generate docstrings for the main.py file:

aidoc gen main.py

Generate docstrings for all Python files in the src directory and its subdirectories:

aidoc gen src

Generate docstrings and create a pull request with the changes:

aidoc gen main.py -pr

Which model to choose?

• code-davinci-002
  • most capable codex model
  • generated docstrings are more accurate and detailed
• code-cushman-001
  • slightly faster.
  • generated docstrings are less accurate

To learn more see https://beta.openai.com/docs/models/codex

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments

• OpenAI

Disclaimer

This project is not affiliated with OpenAI. The OpenAI API and GPT-3 language model are not free. You will need to sign up for a free OpenAI account and create an API key to use this tool.