turbo-docs 1.0.5

No project description provided

Turbo Docs 🚀

Turbo Docs is a Python package that automates the process of generating documentation for your Python projects. It uses OpenAI's GPT-3.5 Turbo and GPT-4 models to generate concise and informative documentation for your functions, and even creates a README.md for your repository.

Why Use Turbo Docs? 🎯

Writing documentation can be a tedious task, especially for large projects. Turbo Docs takes this burden off your shoulders by automating the process. It generates concise and informative documentation for your functions, and even creates a README.md for your repository. This allows you to focus on what you do best: writing code.

Repo Structure 🌳

turbo_docs/
├── commands/
│   ├── docs.py
│   ├── readme.py
│   └── __init__.py
├── utils/
│   ├── cli_options.py
│   ├── directory.py
│   ├── openai_api.py
│   └── __init__.py
├── generate.py
├── __init__.py
├── setup.py
└── requirements.txt

Example Usage 📖

from turbo_docs.commands import readme as readme_module
from turbo_docs.commands import docs as docs_module
from turbo_docs.utils import directory

# Get a dictionary of all text in the current repo
dir_text_dict = directory.get_repo_text_dict()

# Generate README.md
readme_module.readme(dir_text_dict, model="gpt-4")

# Generate documentation for all code files
docs_module.docs(dir_text_dict, model="gpt-4")

Installation 📦

You can install Turbo Docs via pip:

pip install turbo_docs

Please note that you need to have an OpenAI API key to use Turbo Docs. If you don't have one, you can create an account at OpenAI.

Contributing 🤝

Contributions are welcome! Please feel free to submit a Pull Request.

License 📄

Turbo Docs is licensed under the MIT License.