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.
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.
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
Documentation is on Read The Docs
For integration with editors, there's a really simple api avaialble (just a single call), check out the docs for more on that.
pydocstring is on PyPI and can be installed with pip:
pip install pydocstring
Testing/Coverage is automanted with tox. Pull requests are welcome.