README.rst

PyDocsGenie

PyDocsGenie is a python coding helper that automatically generates docstrings for the code you input to it. It uses the OpenAI API for this end.

How to install

Installation can be performed by running:

cd pydocsgenie
python -m pip install .

Run the GUI

The project includes a GUI where you can paste your code and it will generate the docstrings for it. To run the GUI, you can run the following command after installing the project in your environment:

pydocsgenie

Style and Testing

If required, you can always call the style commands (black, isort, flake8...) or unit testing ones (pytest) from the command line. However, this does not guarantee that your project is being tested in an isolated environment, which is another reason to consider using tox.

Documentation

For building documentation, you can either run the usual rules provided in the Sphinx Makefile, such us:

python -m pip install .[doc]
make -C doc/ html

# subsequently open the documentation with (under Linux):
your_browser_name doc/html/index.html

Distributing

If you would like to create either source or wheel files, start by installing the building requirements:

python -m pip install .

Then, you can execute:

python -m build
python -m twine check dist/*