A library for generating docstring for python programms.
Project description
PyDocGenerator
PyDocGenerator 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 PyDocGenerator by cloning the repository or using pip: git clone
Dependencies
-
transformers: A library for natural language processing using pre-trained models. pip install transformers
-
torch: The PyTorch library for deep learning and neural networks. pip install torch
-
astunparse: A Python library for parsing and un-parsing abstract syntax trees (ASTs). pip install astunparse
Usage
Here’s a simple example of how to use DocGen-AI:
from pydocgenerator.pydoc import PyDOC
py_doc = PyDOC('./filename.py')
py_doc.write_to_file()
In this example, DocGen is instantiated with the path to a Python file ('./filename.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 docstrings attached.
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.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b0b6f084c3f374953678d80afd0216a043c7eacee4a3eadf6fa127547d670d2 |
|
MD5 | f6160ae1acbf54a6abc99b10aaf642ad |
|
BLAKE2b-256 | 8316b7f7b44347f704aedd48c4ce2941ce8618e5cddd35eaba3a3cb0cbd68668 |