A library for generating docstring for python programms.
Project description
DocGen-AI
DocGen-AI is a Python library that automatically generates docstrings for Python functions. It takes a Python file as input, generates docstrings for each function in the file, and outputs a new Python file with the generated docstrings.
Features
- Automatically generate docstrings for Python functions
- Easy to use: just pass the file name to the DocGen instance and call the write_to_file() method
Installation
You can install DocGen-AI by cloning the repository or using pip: git clone cd DocGen-AI/src pip install DocGen-AI
Usage
Here’s a simple example of how to use DocGen-AI:
from docgen_ai import DocGen
doc_gen = DocGen('./test.py')
doc_gen.write_to_file()
In this example, DocGen is instantiated with the path to a Python file ('./test.py'). The write_to_file() method is then called to generate docstrings for each function in the file and output a new Python file with the generated docstrings.
License
DocGen-AI is licensed under the MIT License. See the LICENSE file for more information.
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 pydcogenerator-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f215fdf6d01cbb39bd272bb7bc8b52dced3275f464f433e5edfaffb8e86995c |
|
MD5 | 2f57a9f73304c8850315b2abbbd209ba |
|
BLAKE2b-256 | 3d2321c339374d68435dd5975c658c9aad403149708119868f744dcf7beb2305 |