A python library for generating documentation for python projects.
Project description
documentation-generator
Overeview
This is a python library for generating documentation for python projects. It is built to:
- Generate function docstrings
- Generate class docstrings include class method docstrings (still under development)
- Generate sphinx documentation (still under development)
The library uses openai's
gpt model to generate the function docstrings. You pass it a file or folder path togther with an openai
api key. It then parses the folder for python files, then for each file, it finds the functions and classes, generates their documentation and updates their docstrings.
Requirements
- Python 3.10+
- Works on Linux, Windows, macOS, BSD
Installation
pip install oryks-docstring-generator
Usage
First, provide the openai
api key:
export OPENAI_API_KEY=sk-xxxxxxxxxxx
Then run the application, providing the path to the python file to generate docs for or the folder containing the python files:
python -m docstring_generator --path test_function.py
Project details
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
Close
Hashes for oryks-docstring-generator-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 854b4ef28d6f9f7a259d8363dbfe6cb1cbc90a01ccba2b63ebb5c4c4f5622796 |
|
MD5 | 4eb23693ebd19bb4016c33935de44b1c |
|
BLAKE2b-256 | d9981ddb220444029bc949fd50d0ea76c8b2377aabf790033a9f4c94e8bdbbc5 |
Close
Hashes for oryks_docstring_generator-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac54a28432abbe3b86df5001df8ef8a76ec867ea6f00608b90c097a1b4e01580 |
|
MD5 | b4e0290094bc64c01e0ac6a5ecda562d |
|
BLAKE2b-256 | 21b082da281cd9d5e4c0449f7ca58a3c33697498a48498a7ab5b7cc34504f2f3 |