Metadata-Version: 2.2
Name: autodocstring
Version: 0.1.2
Summary: A Python package for generating docstrings automatically.
Home-page: https://github.com/eduardonery1/autodocstring
Author: Your Name
Author-email: your_email@example.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: python-dotenv
Requires-Dist: google-generativeai
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Autodocstring
I made this tool to improve code quality without much headache.

Have ```GEMINI_API_KEY``` defined in your PATH. You can do this by [following these steps](https://ai.google.dev/gemini-api/docs/api-key).
```bash
pip install autodocstring
```
Run this to generate docstrings to all your public methods at the desired python module.
```bash
autodocstring path/to/file
```
You may also want to target specific methods by using the ```--methods```parameter. The tool generates a backup file by default.
