No project description provided
Project description
Turbo Docs ๐
Turbo Docs is a powerful Python tool that helps developers automatically generate high-quality README.md files for their repositories. It leverages the power of OpenAI's GPT-3.5 Turbo and GPT-4 models to create well-structured, informative, and engaging documentation.
Why Turbo Docs? ๐ค
Writing good documentation is essential for any software project, but it can be time-consuming and tedious. Turbo Docs simplifies this process by generating a README.md file that meets all your requirements, allowing you to focus on writing great code.
Table of Contents ๐
Installation ๐ป
To install Turbo Docs, simply run:
pip install turbo_docs
Usage ๐ ๏ธ
To use Turbo Docs, navigate to your project's root directory and run:
turbo_docs --readme
This will generate a README.md file for your project. You can also use the --gpt3
flag to use the GPT-3.5 Turbo model:
turbo_docs --readme --gpt3
Additionally, you can copy the directory text to the clipboard by using the --copy
flag:
turbo_docs --copy
Repo Structure ๐๏ธ
turbo_docs/
โ
โโโ commands/
โ โโโ __init__.py
โ โโโ readme.py
โ
โโโ utils/
โ โโโ __init__.py
โ โโโ cli_options.py
โ โโโ directory.py
โ โโโ openai_api.py
โ
โโโ __init__.py
โโโ generate.py
โโโ setup.py
โโโ turbo_docs.toml
Example Usage ๐
Here's an example of how to use Turbo Docs to generate a README.md file:
from turbo_docs.commands import readme
# Define your repo structure as a string
repo = """
{'repo': 'example_repo',
'files': {
'main.py': 'print("Hello, World!")',
'README.md': ''
}
}
"""
# Generate the README.md file
readme(repo)
License ๐
Turbo Docs is released under the MIT License.
Project details
Release history Release notifications | RSS feed
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 turbo_docs-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdfc6eac2c2f94f8966376acbf1caf5a2050b6e703d675b256e43161baea5cd7 |
|
MD5 | 58e8344cad8061448c84b9ed82947d04 |
|
BLAKE2b-256 | eb57ad392b9339a89778d1c63648d8a4563bf71fbd543c022badeae80af1773a |