Metadata-Version: 2.1
Name: turbo-docs
Version: 0.7.4
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: requests
Requires-Dist: openai
Requires-Dist: click
Requires-Dist: pyperclip
Requires-Dist: redbaron
Requires-Dist: gitpython

# Turbo_Docs
A library for creating **formatted & user-friendly** readmes from existing files.

## Features 
-   Generates **README.md** for the current directory from files
-   For larger repositories, uses the alternative command `turbo_docs --readme_large_repo`
-   Copies directory text to clipboard using **Pyperclip**, useful for working with chatGPT
-   Generates **docstrings** for all functions in your codebase


## Usage
To generate a README or docs.md, use the following command:

`turbo_docs --{command}`

For more options, use the following flags:
-   `--copy`
-   `--readme`
-   `--readme_large_repo`
-   `--docstring`


## Requirements
-   Requests
-   OpenAI
-   Pyperclip
-   RedBaron
-   GitPython
