{
    "info": {
        "author": "Jake Lever",
        "author_email": "jake.lever@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Software Development :: Documentation",
            "Topic :: Software Development :: Testing"
        ],
        "description": "=============\ndocstringtest\n=============\n\n|pypi| |build-status| |coverage| |docs| |license|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/docstringtest.svg\n   :target: https://pypi.python.org/pypi/docstringtest\n   :alt: PyPI Release\n   \n.. |build-status| image:: https://travis-ci.org/jakelever/docstringtest.svg?branch=master\n   :target: https://travis-ci.org/jakelever/docstringtest\n   :alt: Travis CI status\n\n.. |coverage| image:: https://coveralls.io/repos/github/jakelever/docstringtest/badge.svg?branch=master\n   :target: https://coveralls.io/github/jakelever/docstringtest?branch=master\n   :alt: Coverage status\n   \n.. |docs| image:: https://readthedocs.org/projects/docstringtest/badge/\n   :target: http://docstringtest.readthedocs.io/\n   :alt: Documentation status\n   \n.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg\n   :target: https://opensource.org/licenses/MIT\n   :alt: MIT license\n\ndocstringtest is a small package for regression testing of docstrings in Python code. It checks that all appropriate methods and functions are using ReST docstrings with parameter information so that nice documentation can be generated. This format looks like:\n\n.. code-block:: python\n\n   def example_function(varA,varB):\n      \"\"\"\n      This function does nothing\n\n      :param varA: The first variable\n      :param varB: The second variable\n      :type varA: The type of the first variable\n      :type varB: The type of the second variable\n      \"\"\"\n      pass\n\nIt makes it easy to check that the docstrings match with the current parameters so that documentation doesn't become out-of-step with the code. \n\nIf you wanted to add docstringtest to a standard test algorithm, it would simply be something like this\n\n.. code:: python\n\n        import mymodule\n        import docstringtest\n\n        def test_docstringtest():\n                docstringtest.testModule(mymodule)\n\nInstallation\n------------\n\nYou can install \"docstringtest\" via `pip`_ from `PyPI`_::\n\n   $ pip install docstringtest\n   \n\nContributing\n------------\nContributions are very welcome.\n\nLicense\n-------\n\nDistributed under the terms of the `MIT`_ license, \"docstringtest\" is free and open source software\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n\n.. _`MIT`: http://opensource.org/licenses/MIT\n.. _`file an issue`: https://github.com/jakelever/docstringtest/issues\n.. _`pip`: https://pypi.python.org/pypi/pip/\n.. _`PyPI`: https://pypi.python.org/pypi",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/jakelever/docstringtest",
        "keywords": "docstring testing",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "docstringtest",
        "package_url": "https://pypi.org/project/docstringtest/",
        "platform": "",
        "project_url": "https://pypi.org/project/docstringtest/",
        "project_urls": {
            "Homepage": "https://github.com/jakelever/docstringtest"
        },
        "release_url": "https://pypi.org/project/docstringtest/0.3.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Procedure to check for valid Sphinx ReST docstrings",
        "version": "0.3.0"
    },
    "last_serial": 3094341,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "70d440ad6ea282d5df3dfdcc27fe60f6",
                    "sha256": "58b906fe5fb3b982942388fe280465275c4a6aba9006ec26a9bff1419599c266"
                },
                "downloads": -1,
                "filename": "docstringtest-0.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "70d440ad6ea282d5df3dfdcc27fe60f6",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 4854,
                "upload_time": "2017-07-27T00:23:30",
                "url": "https://files.pythonhosted.org/packages/39/fd/ff1b7dfe9061a1954bc801d6b68b0e868ae0ab4d685b25ca6129330aa1e2/docstringtest-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d49689a88c33c182a484a7dc694f3a8c",
                    "sha256": "95a744bb06427e78cf5e018438e8baffed1d7ee04f1af904f1e986479aed9c2a"
                },
                "downloads": -1,
                "filename": "docstringtest-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "d49689a88c33c182a484a7dc694f3a8c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3243,
                "upload_time": "2017-07-27T00:23:32",
                "url": "https://files.pythonhosted.org/packages/67/a8/6ffc01a3f36c84e209b5e75fa8cdfaddbfae1756a2da8abad0c4132e94fe/docstringtest-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "eb831f72534fc9c1a48097694ca1a534",
                    "sha256": "44c701c88792590999d3b2950df1b97c542bc55f3d23a84149b56936450cace4"
                },
                "downloads": -1,
                "filename": "docstringtest-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "eb831f72534fc9c1a48097694ca1a534",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3242,
                "upload_time": "2017-07-28T02:54:38",
                "url": "https://files.pythonhosted.org/packages/c7/c3/7b29383a82dec73760579dbbd96043707eae32140250d61778ee997c6b7d/docstringtest-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "577e2e2b277dcce61e8252b9a26f1c37",
                    "sha256": "bd3b2fb08057df4149c27adbeb013fbc85d527ec8fae68cb60aab3cd157d5a1e"
                },
                "downloads": -1,
                "filename": "docstringtest-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "577e2e2b277dcce61e8252b9a26f1c37",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3606,
                "upload_time": "2017-07-28T03:12:27",
                "url": "https://files.pythonhosted.org/packages/c3/09/2cd5ade6ed64d439974219c692c4a93d97523942b1ee7055935129accec6/docstringtest-0.1.2.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "88bd03d40a7ec19827182415ff68446b",
                    "sha256": "89341d37a0d086e488dafd8915c85713e1af2787e096044103d991461c3d81c1"
                },
                "downloads": -1,
                "filename": "docstringtest-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "88bd03d40a7ec19827182415ff68446b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3744,
                "upload_time": "2017-08-01T04:57:24",
                "url": "https://files.pythonhosted.org/packages/f9/f5/db303f9c06ff8d1669bac66cfc967e8184c87b5d74904d5e2646d5af51f0/docstringtest-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7076cf1bad1ebddad98c8a244b95f6ec",
                    "sha256": "0c762d1157f6c7a21419c8c7bc3453035ebed9c40472b6adf8505f16fc21c8a7"
                },
                "downloads": -1,
                "filename": "docstringtest-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "7076cf1bad1ebddad98c8a244b95f6ec",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4407,
                "upload_time": "2017-08-13T23:32:15",
                "url": "https://files.pythonhosted.org/packages/25/e2/2cdaa8fa607f79ec0bff9741ce8e26822843533bcac45e3c3f80d9b5ed8c/docstringtest-0.3.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7076cf1bad1ebddad98c8a244b95f6ec",
                "sha256": "0c762d1157f6c7a21419c8c7bc3453035ebed9c40472b6adf8505f16fc21c8a7"
            },
            "downloads": -1,
            "filename": "docstringtest-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7076cf1bad1ebddad98c8a244b95f6ec",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4407,
            "upload_time": "2017-08-13T23:32:15",
            "url": "https://files.pythonhosted.org/packages/25/e2/2cdaa8fa607f79ec0bff9741ce8e26822843533bcac45e3c3f80d9b5ed8c/docstringtest-0.3.0.tar.gz"
        }
    ]
}