llm-autodocs 🧞: Automatically generate docstrings for your codebase using LLMs.
Project description
llm-autodocs 🪄
Overview 🌞
autodocs
is a Python-based command-line tool for automatically generating documentation for git-tracked Python files in a project. It leverages LLMs to generate documentation automatically and asynchronously.
Features ⚡️
- Git Integration: Only selects Python files that are tracked by Git within a specified directory.
- Custom File Selection: Offers the flexibility to specify files to include or exclude in the documentation process.
- LLM Support: Currently supports OpenAI gpt models
- Asynchronous Execution: Improves performance by handling multiple files concurrently.
Quickstart 🚴♂️
Install the library:
pip install llm-autodocs
Navigave to your git project and run:
cd my_project/
autodocs --directory .
This will run in the root of your project and include all tracked .py files. By default it uses gpt-3.5-turbo
.
You will be prompted to review the files affected before continuing.
Examples
Specify a specific directory:
autodocs --directory ./src
Specify a different openai model (can be any of the gpt-3.5* or gpt-4* patterns):
autodocs --documenter gpt-4
Allow only certain file patterns:
autodocs --allowed-files utils.py data_model.py
Exclude certain file patterns:
autodocs --ignored-files __init__.py
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
Built Distribution
Hashes for llm_autodocs-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c76aa08887a8da8e5425f6aecd66644cc2eedd424d03ce36b6d297c2af7d1f9 |
|
MD5 | a4e9883b846c5a4493af9122b3129da8 |
|
BLAKE2b-256 | a87c98b340b2fc2726528272db0055dcabd91b7487b1e4cda29887fb905701e8 |