A Python package for generating docstrings automatically.
Project description
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.
pip install autodocstring
Run this to generate docstrings to all your public methods at the desired python module.
autodocstring path/to/file
You may also want to target specific methods by using the --methodsparameter. The tool generates a backup file by default.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file autodocstring-0.1.2.tar.gz.
File metadata
- Download URL: autodocstring-0.1.2.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ffd9e20751d25ce6053658c9a2455996617bbaf8e133e1a78a1e0ee8a8c456cb
|
|
| MD5 |
9c459140c84f3133a66ff9c4865346a9
|
|
| BLAKE2b-256 |
1b169db579dca1291dc06bc1a729b77ff0fa6407543ac8b6ec68ac2bf1446762
|
Provenance
The following attestation bundles were made for autodocstring-0.1.2.tar.gz:
Publisher:
python-publish.yml on eduardonery1/autodocstring
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
autodocstring-0.1.2.tar.gz -
Subject digest:
ffd9e20751d25ce6053658c9a2455996617bbaf8e133e1a78a1e0ee8a8c456cb - Sigstore transparency entry: 160830039
- Sigstore integration time:
-
Permalink:
eduardonery1/autodocstring@67dcdac87e9c92612ec9102cd17293e405ce560b -
Branch / Tag:
refs/heads/master - Owner: https://github.com/eduardonery1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@67dcdac87e9c92612ec9102cd17293e405ce560b -
Trigger Event:
push
-
Statement type:
File details
Details for the file autodocstring-0.1.2-py3-none-any.whl.
File metadata
- Download URL: autodocstring-0.1.2-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa7d700b8dda1468c30e5d2103e11a35d4fbf9e29b1b4e983d19028fb2bf567c
|
|
| MD5 |
c326225f9ab6e06e2f326671c05043e6
|
|
| BLAKE2b-256 |
5c00c04c59ce43ed025c743574d565ce3d06fe691a06695ef71fa0ceda70b915
|
Provenance
The following attestation bundles were made for autodocstring-0.1.2-py3-none-any.whl:
Publisher:
python-publish.yml on eduardonery1/autodocstring
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
autodocstring-0.1.2-py3-none-any.whl -
Subject digest:
fa7d700b8dda1468c30e5d2103e11a35d4fbf9e29b1b4e983d19028fb2bf567c - Sigstore transparency entry: 160830042
- Sigstore integration time:
-
Permalink:
eduardonery1/autodocstring@67dcdac87e9c92612ec9102cd17293e405ce560b -
Branch / Tag:
refs/heads/master - Owner: https://github.com/eduardonery1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@67dcdac87e9c92612ec9102cd17293e405ce560b -
Trigger Event:
push
-
Statement type: