Auto Commenter
Auto Commenter is a Python package that automatically generates docstrings for your Python functions and classes based on their arguments and return types. It uses abstract syntax tree (AST) analysis to inspect the code and generate informative comments.
Features
- Automatically generates docstrings for functions and classes.
- Infers argument types based on common patterns (e.g.,
num,data,arr). - Supports return type detection, including for
int,str,list,dict,pd.DataFrame, andnp.ndarray. - Easily integrate into your workflow to improve code documentation.
Installation
You can install Auto Commenter from PyPI using pip:
pip install auto-commenter
Metadata
Release files for auto-commenter 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| auto_commenter-0.1.0.tar.gz | 4.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| auto_commenter-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.6 kB
Release files / auto_commenter-0.1.0.tar.gz
| Download URL | auto_commenter-0.1.0.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
59546e5bb168e9d19e405bca036bc5726b47f1fe9275d06992a1eea23b6999aa
|
|
BLAKE2b-256 checksum How to use checksums |
507dc8bed08d1121531fc787b9ea659d81d127174b5d9bab0a694955286358f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Release files / auto_commenter-0.1.0-py3-none-any.whl
| Download URL | auto_commenter-0.1.0-py3-none-any.whl |
|---|---|
| Size | 4.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
584941d00be24df77a27c0ac244a87e1ace597e50427bf9ad70c1bb5faca54f8
|
|
BLAKE2b-256 checksum How to use checksums |
45ce80a40dae8e9bf092cb8cbe4bd55e2b4f2ec3ac5c0ee8b6be6b1f4ec75dac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|