Chocksy / docGPT

Python script that generates markdown documentation by scanning a directory of files and sending those to GPT

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docGPT -- Alpha

Python script that generates markdown documentation by scanning a directory of files and sending those to GPT

How to use

You will need to replace API_KEY and openai with your actual API key and OpenAI Python library.

First, make sure you have the openai library installed by running:

pip install openai

To use the script, run:

python main.py

And enter the directory path when prompted. The script will output the structure of the project, classes, and methods with explanations as requested.

About

Python script that generates markdown documentation by scanning a directory of files and sending those to GPT


Languages

Language:Python 72.7%Language:Dockerfile 27.3%