{
    "info": {
        "author": "",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Documentation"
        ],
        "description": "<!--\nhttps://pypi.org/project/readme-generator/\nhttps://pypi.org/project/python-readme-generator/\n-->\n\n[![](https://img.shields.io/pypi/pyversions/readme-docstring.svg?longCache=True)](https://pypi.org/project/readme-docstring/)\n\n#### Installation\n```bash\n$ [sudo] pip install readme-docstring\n```\n\n#### Classes\nclass|`__doc__`\n-|-\n`readme_docstring.Classes` |`classes` table class. attrs: `classes`\n`readme_docstring.Functions` |`functions` table class. attrs: `functions`\n`readme_docstring.Table` |abstract table class. attrs: `headers`, `objects`\n\n#### Functions\nfunction|`__doc__`\n-|-\n`readme_docstring.getclasses()` |return a list of classes defined in `__all__`\n`readme_docstring.getdoc(obj)` |return first line of an object docstring\n`readme_docstring.getfunctions()` |return a list of functions defined in `__all__`\n`readme_docstring.getmembers()` |return all the members defined in `__all__` in a list of (name, value) pairs\n`readme_docstring.getmodules()` |return a list of modules\n`readme_docstring.getspec(routine)` |return a string with Python routine specification\n\n#### Executable modules\nusage|`__doc__`\n-|-\n`python -m readme_docstring.classes` |generate `classes` table\n`python -m readme_docstring.functions` |generate `functions` table\n\n#### Examples\nexample with [readme-generator](https://pypi.org/project/readme-generator/)\n```python\nclass Readme(readme_generator.Readme):\n    order = [..., \"classes\", \"functions\", ...]\n\n    def classes(self):\n        classes = self.getclasses()\n        return readme_docstring.Classes(classes)\n\n    def functions(self):\n        functions = self.getfunctions()\n        return readme_docstring.Functions(functions)\n```\n\ncustom table\n```python\nclass ExecutableModules(readme_docstring.Table):\n    columns = [\"usage\", \"`__doc__`\"]\n\n    def __init__(self,modules):\n        self.objects = modules\n\n    def getleftcell(self, obj):\n        default = \"python -m %s\" % obj.__name__.replace(\".__main__\", \"\")\n        return \"`%s`\" % getattr(obj, \"USAGE\", default)\n```\n\n<p align=\"center\">\n    <a href=\"https://pypi.org/project/python-readme-generator/\">python-readme-generator</a>\n</p>",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/looking-for-a-job/readme-docstring.py",
        "keywords": "readme docstring",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "readme-docstring",
        "package_url": "https://pypi.org/project/readme-docstring/",
        "platform": "",
        "project_url": "https://pypi.org/project/readme-docstring/",
        "project_urls": {
            "Homepage": "https://github.com/looking-for-a-job/readme-docstring.py"
        },
        "release_url": "https://pypi.org/project/readme-docstring/2019.4.13/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "generate README from python docstrings",
        "version": "2019.4.13"
    },
    "last_serial": 5587424,
    "releases": {
        "2019.3.22": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2efa47bb12c548a0de99c59889562c01",
                    "sha256": "73c846f4e28d7401db7e8df7d30b3b2fec971ae6a229de69a981ce82b2c00827"
                },
                "downloads": -1,
                "filename": "readme_docstring-2019.3.22-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2efa47bb12c548a0de99c59889562c01",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 145402,
                "upload_time": "2019-03-24T11:18:56",
                "url": "https://files.pythonhosted.org/packages/f4/1c/9a30509bd49c202eb1bba545655e5491f62b11fdd9afe94e7bb091fb1bd1/readme_docstring-2019.3.22-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "522fdd4ac5e1c90b475e91d440aeb26c",
                    "sha256": "bf7ad31ebdac8198ba65784bf59cbc47e6c6f6c7f9d1d073245d814f107463d1"
                },
                "downloads": -1,
                "filename": "readme-docstring-2019.3.22.tar.gz",
                "has_sig": false,
                "md5_digest": "522fdd4ac5e1c90b475e91d440aeb26c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2715,
                "upload_time": "2019-03-24T11:18:57",
                "url": "https://files.pythonhosted.org/packages/0d/af/d798c80c2457c8b60679188c41a8e5969743d9d19a3922ea291e8dffec09/readme-docstring-2019.3.22.tar.gz"
            }
        ],
        "2019.3.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e55fc5825f00804675a8b73ce7889d85",
                    "sha256": "5ded5e662cb04ff7d47941e375400b00b3ba41eab3f1ed6038a08397d182db38"
                },
                "downloads": -1,
                "filename": "readme_docstring-2019.3.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e55fc5825f00804675a8b73ce7889d85",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14761,
                "upload_time": "2019-03-08T21:11:02",
                "url": "https://files.pythonhosted.org/packages/14/20/3edb55cac5154a8fc52385be8e301839bbd8524f4452a18e6d3754191fbc/readme_docstring-2019.3.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2966fc5715264afee227502e7532db16",
                    "sha256": "0543478e85bfe651a879d03883f26e2f2d6832dff4b8de6c552a356dcb5389f5"
                },
                "downloads": -1,
                "filename": "readme-docstring-2019.3.5.tar.gz",
                "has_sig": false,
                "md5_digest": "2966fc5715264afee227502e7532db16",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2442,
                "upload_time": "2019-03-08T21:11:04",
                "url": "https://files.pythonhosted.org/packages/6f/79/5c3642a758151e75eace96cea11561a9d4e9a9c683332cb3bcb7202545f3/readme-docstring-2019.3.5.tar.gz"
            }
        ],
        "2019.3.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "34d8a9a3194964b2be0dda1bcb10f87a",
                    "sha256": "0caa2548d4d4b44f709c2533e0971b5df68a6d8e150ad6ae028f1af70f020fdf"
                },
                "downloads": -1,
                "filename": "readme_docstring-2019.3.9-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "34d8a9a3194964b2be0dda1bcb10f87a",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 18251,
                "upload_time": "2019-03-08T21:17:37",
                "url": "https://files.pythonhosted.org/packages/e5/45/d17bc1880abc92ec0cef23562d3c2c65d62c7fd19aa5777fd1fc562dc48f/readme_docstring-2019.3.9-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fedbf53396dfec1fdcda865fa61df128",
                    "sha256": "57078aed5075efc82a9029460588ac2782249fe2c923c99e34443126ef64eaf7"
                },
                "downloads": -1,
                "filename": "readme-docstring-2019.3.9.tar.gz",
                "has_sig": false,
                "md5_digest": "fedbf53396dfec1fdcda865fa61df128",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2449,
                "upload_time": "2019-03-08T21:17:59",
                "url": "https://files.pythonhosted.org/packages/b7/fa/80390e04d074a19d203e377e4a2e1e0d6155ca98efbbb5443753d6d9c952/readme-docstring-2019.3.9.tar.gz"
            }
        ],
        "2019.4.13": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5ec17ecd1afe4815801a9f1025692d11",
                    "sha256": "45a32ceef56ec20dde92a635a0144302ce45880d80951727453c9230d13d84c6"
                },
                "downloads": -1,
                "filename": "readme-docstring-2019.4.13.tar.gz",
                "has_sig": false,
                "md5_digest": "5ec17ecd1afe4815801a9f1025692d11",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2634,
                "upload_time": "2019-04-13T08:18:20",
                "url": "https://files.pythonhosted.org/packages/ee/8b/1879427c6079ce026c45acbe94553a37a17c6668182b0249168c58327a03/readme-docstring-2019.4.13.tar.gz"
            }
        ],
        "2019.4.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d3f75ba098987627545b01ddbdbedabf",
                    "sha256": "160f66727685113e4c80b5937f8fc125ce926dbbd612818f34db197e0ddd479d"
                },
                "downloads": -1,
                "filename": "readme_docstring-2019.4.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d3f75ba098987627545b01ddbdbedabf",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 3950,
                "upload_time": "2019-04-02T11:10:48",
                "url": "https://files.pythonhosted.org/packages/ed/d9/91495e1f6161b7c21487d3f5469faa89e72c6fc6287dad4ed99866374649/readme_docstring-2019.4.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "609833f81162a88c5a470781706fd7ca",
                    "sha256": "c3b6e31840a164b853f6156058eb21dd3be07b094bb057964b9a29f19b858337"
                },
                "downloads": -1,
                "filename": "readme-docstring-2019.4.2.tar.gz",
                "has_sig": false,
                "md5_digest": "609833f81162a88c5a470781706fd7ca",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2605,
                "upload_time": "2019-04-02T11:10:51",
                "url": "https://files.pythonhosted.org/packages/10/c2/0797c0625de0538750808a990365a957863f0f00b76ff934de1cd8f84f89/readme-docstring-2019.4.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5ec17ecd1afe4815801a9f1025692d11",
                "sha256": "45a32ceef56ec20dde92a635a0144302ce45880d80951727453c9230d13d84c6"
            },
            "downloads": -1,
            "filename": "readme-docstring-2019.4.13.tar.gz",
            "has_sig": false,
            "md5_digest": "5ec17ecd1afe4815801a9f1025692d11",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2634,
            "upload_time": "2019-04-13T08:18:20",
            "url": "https://files.pythonhosted.org/packages/ee/8b/1879427c6079ce026c45acbe94553a37a17c6668182b0249168c58327a03/readme-docstring-2019.4.13.tar.gz"
        }
    ]
}