/gpt4docstrings

Generating Python docstrings with OpenAI ChatGPT!!

Primary LanguagePythonMIT LicenseMIT

gpt4docstrings

PyPI Status Python Version License

Read the documentation at https://gpt4docstrings.readthedocs.io/ Tests Codecov

pre-commit Black

What is gpt4docstrings?

gpt4docstrings is a library that helps you to write docstrings for your Python code. Select a path / paths where you want gpt4docstrings to be applied and wait for the results!!

Requirements

gpt4docstrings supports Python 3.9 and above.

Installation

You can install gpt4docstrings via pip from PyPI:

$ pip install gpt4docstrings

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, gpt4docstrings is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.