Generate API documentation in MarkDown based in the models and api handlers for given project using ChatGPT.
Project description
Generate Docs using ChatGPT
CLI to generate API documentation in MarkDown based in the models and api handlers for given project using ChatGPT.
genDocsGPT badge
ChatGPT API Key
The genDosGPT demand a ChatGPT API Key that you can generate after create your account in OpenAI. Tutorial here. After this, create a .env file in the following format:
API_KEY="chatgpt_api_Key"
Usage
usage: genDocsGPT [-h] [-v, --verbose] -m / --model <model_paths> -a / --api <api_paths>
[-o / --output <filename>] [-t / --token <token>] [--env <filename>] [--gpt_model <model>]
CLI to generate API documentation in MarkDown based in the models and api handlers for
given project using ChatGPT.
options:
-h, --help show this help message and exit
-v, --verbose Show all the messages to debug
-m / --model <model_paths>
Model paths. If more than one, separate with a comma
-a / --api <api_paths>
API paths. If more than one, separate with a comma
-o / --output <filename>
Filename to the documentation generated. Default: ./api.md
-t / --token <token> ChatGPT API KEY
--env <filename> Env file that MUST and ONLY have API_KEY="chatgpt_api_key".
Default: ./.env
--gpt_model <model> Model that will be used by ChatGPT. Default: gpt-3.5-turbo
We do not recommend using it in non-open-source projects.
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
genDocsGPT-1.0b16.tar.gz
(7.0 kB
view hashes)
Built Distribution
Close
Hashes for genDocsGPT-1.0b16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e1a22b933b74cc4a49ffc25d5a83b8d6563c3d5566dec3fa467ee418fd081e4 |
|
MD5 | 4ad8367637e7e10e8c6883c3ec8f028c |
|
BLAKE2b-256 | b96f4306fe8d2156cea8ad1d5cae7afa959eb7587b93ae48b18a669d5f941419 |