{ "info": { "author": "Alisdair Robertson", "author_email": "alisdair.w.robertson@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Plugins", "Environment :: Win32 (MS Windows)", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Documentation" ], "description": "===========\npydocstring\n===========\n\n\n.. image:: https://travis-ci.org/robodair/pydocstring.svg?branch=master\n :target: https://travis-ci.org/robodair/pydocstring\n\n.. image:: https://codecov.io/gh/robodair/pydocstring/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/robodair/pydocstring\n\n.. image:: https://readthedocs.org/projects/pydocstring/badge/?version=latest\n :target: https://pydocstring.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/pypi/l/pydocstring.svg\n :target: https://pypi.org/project/pydocstring/\n\n.. image:: https://img.shields.io/pypi/v/pydocstring.svg\n :target: https://pypi.org/project/pydocstring/\n\n.. image:: https://img.shields.io/pypi/pyversions/pydocstring.svg\n :target: https://pypi.org/project/pydocstring/\n\n.. image:: https://img.shields.io/pypi/status/pydocstring.svg\n :target: https://pypi.org/project/pydocstring/\n\n\nPython package for autogenerating python docstrings, built on top of `Parso `_.\n\n\nThis project can be wrapped by an editor extension to provide docstrings as autocompletion or in response to a shortcut command.\n\nStatus\n======\n\nReady for basic use - Supports **Google**, **Numpy**, and **reST** docstring formats are supported, and it's pretty simple to create your own formatter.\n\nTypes are able to be inferred for some things, but if they can't be worked out '``TYPE``' is just inserted instead.\n\nDoesn't support more complicated things like converting between styles or updating docstrings.\n\nFuture\n======\n\nCheck the issues for any more, but the nice-to-haves are:\n\n- Docstring insertion for a whole file\n- Updating docstrings for methods with changed paramenters/exeptions/Types\n- Conversion between docstring styles\n\nDocs\n====\n\nDocumentation is on `Read The Docs `_\n\nAPI\n===\n\nFor integration with editors, there's a really simple api avaialble (just a single call), check out the docs for more on that.\n\nDownload\n========\n\npydocstring is on `PyPI `_ and can be installed with pip:\n\n.. code-block:: bash\n\n pip install pydocstring\n\nDevelopment\n===========\n\nTesting/Coverage is automanted with `tox `_. Pull requests are welcome.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/robodair/pydocstring", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pydocstring", "package_url": "https://pypi.org/project/pydocstring/", "platform": "", "project_url": "https://pypi.org/project/pydocstring/", "project_urls": { "Homepage": "https://github.com/robodair/pydocstring" }, "release_url": "https://pypi.org/project/pydocstring/0.1.5/", "requires_dist": [ "parso (==0.1.1)" ], "requires_python": "", "summary": "Package providing autocompletion capabilities for python docstrings", "version": "0.1.5" }, "last_serial": 3355723, "releases": { "0.1.5": [ { "comment_text": "", "digests": { "md5": "3b43c453f742fe6dff54d06f523e0cf7", "sha256": "e9db230c7535a37736237f935fa7bc5eba652a9cd571fbf6bfd48d0ee42dfc7b" }, "downloads": -1, "filename": "pydocstring-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3b43c453f742fe6dff54d06f523e0cf7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12233, "upload_time": "2017-11-22T16:00:25", "url": "https://files.pythonhosted.org/packages/1d/73/bc9d634ce0183d460153d32a6961738035e7ae469d46d4ca9f1188383912/pydocstring-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e7fd757e28ca92c25fb3449790cf18bf", "sha256": "f084d85f66c9b7d9b4e7e76e523b05a4b775073197be86e27050cdc9d923c8c7" }, "downloads": -1, "filename": "pydocstring-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e7fd757e28ca92c25fb3449790cf18bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6885, "upload_time": "2017-11-22T16:00:26", "url": "https://files.pythonhosted.org/packages/4b/6f/b63a59290703763248d9612ecfd987feffa5b6fa28864ebb6bf78388a04b/pydocstring-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3b43c453f742fe6dff54d06f523e0cf7", "sha256": "e9db230c7535a37736237f935fa7bc5eba652a9cd571fbf6bfd48d0ee42dfc7b" }, "downloads": -1, "filename": "pydocstring-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3b43c453f742fe6dff54d06f523e0cf7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12233, "upload_time": "2017-11-22T16:00:25", "url": "https://files.pythonhosted.org/packages/1d/73/bc9d634ce0183d460153d32a6961738035e7ae469d46d4ca9f1188383912/pydocstring-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e7fd757e28ca92c25fb3449790cf18bf", "sha256": "f084d85f66c9b7d9b4e7e76e523b05a4b775073197be86e27050cdc9d923c8c7" }, "downloads": -1, "filename": "pydocstring-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e7fd757e28ca92c25fb3449790cf18bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6885, "upload_time": "2017-11-22T16:00:26", "url": "https://files.pythonhosted.org/packages/4b/6f/b63a59290703763248d9612ecfd987feffa5b6fa28864ebb6bf78388a04b/pydocstring-0.1.5.tar.gz" } ] }