Skip to main content

Package providing autocompletion capabilities for python docstrings

Project description

https://travis-ci.org/robodair/pydocstring.svg?branch=master https://codecov.io/gh/robodair/pydocstring/branch/master/graph/badge.svg https://readthedocs.org/projects/pydocstring/badge/?version=latest https://img.shields.io/pypi/l/pydocstring.svg https://img.shields.io/pypi/v/pydocstring.svg https://img.shields.io/pypi/pyversions/pydocstring.svg https://img.shields.io/pypi/status/pydocstring.svg

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 pydocstring

Development

Testing/Coverage is automanted with tox. Pull requests are welcome.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pydocstring, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size pydocstring-0.2.1-py2.py3-none-any.whl (11.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pydocstring-0.2.1.tar.gz (8.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page