pydocstring
Python package for autogenerating python docstrings, built on top of Parso.
This project can be wrapped by an editor extension to provide docstrings as autocompletion or in response to a shortcut command.
Status
Ready for basic use - Supports Google, Numpy, and reST docstring formats, and it’s pretty simple to create your own formatter.
Types are able to be inferred for some things, but if they can’t be worked out ‘TYPE’ is just inserted instead.
Doesn’t support more complicated things like converting between styles or updating docstrings.
Future
Check the issues for any more, but the nice-to-haves are:
Docstring insertion for a whole file
Updating docstrings for methods with changed paramenters/exeptions/Types
Conversion between docstring styles
Docs
Documentation is on Read The Docs
API
For integration with editors, there’s a really simple api avaialble (just a single call), check out the docs for more on that.
Download
pydocstring is on PyPI and can be installed with pip:
pip install pydocstringDevelopment
Testing/Coverage is automanted with tox. Pull requests are welcome.
1 maintainer
Metadata
1 maintainer
Release files for pydocstring 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pydocstring-0.2.1.tar.gz | 8.4 kB | Without provenance | Details for pydocstring-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pydocstring-0.2.1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for pydocstring-0.2.1-py2.py3-none-any.whl |
Total release size: 19.5 kB
Release files / pydocstring-0.2.1.tar.gz
| Download URL | pydocstring-0.2.1.tar.gz |
|---|---|
| Size | 8.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
af28e075d525cd8e806292c7dfff71f04c233ed182881afbf267de4297bd9cc3
|
|
BLAKE2b-256 checksum How to use checksums |
1d792a2229692bb64dc16565f5769da7e094d28c0e27b8b935d6787bfb0fe89c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.1 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.8.0
|
Release files / pydocstring-0.2.1-py2.py3-none-any.whl
| Download URL | pydocstring-0.2.1-py2.py3-none-any.whl |
|---|---|
| Size | 11.1 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
1c23416f67598232bb1ea6d01b95288a6b3fbc17ad001fc4af5050c96cc177eb
|
|
BLAKE2b-256 checksum How to use checksums |
ac6b3e3e86a1e7028d57e14778ff9a3fe223f7891509e914a3893dc7c50a11b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.1 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.8.0
|
Security for pydocstring 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
