{
    "info": {
        "author": "Timothy Crosley",
        "author_email": "timothy.crosley@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "[![pdocs - Documentation Powered by Your Python Code.](https://raw.github.com/timothycrosley/pdocs/master/art/logo_large.png)](https://timothycrosley.github.io/pdocs/)\n_________________\n\n[![PyPI version](https://badge.fury.io/py/pdocs.svg)](http://badge.fury.io/py/pdocs)\n[![Build Status](https://travis-ci.org/timothycrosley/pdocs.svg?branch=master)](https://travis-ci.org/timothycrosley/pdocs)\n[![codecov](https://codecov.io/gh/timothycrosley/pdocs/branch/master/graph/badge.svg)](https://codecov.io/gh/timothycrosley/pdocs)\n[![Join the chat at https://gitter.im/pdocs/community](https://badges.gitter.im/pdocs/community.svg)](https://gitter.im/pdocs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://pypi.python.org/pypi/pdocs/)\n[![Downloads](https://pepy.tech/badge/pdocs)](https://pepy.tech/project/pdocs)\n_________________\n\n[Read Latest Documentation](https://timothycrosley.github.io/pdocs/) - [Browse GitHub Code Repository](https://github.com/timothycrosley/pdocs/)\n_________________\n\n\n`pdocs` is a library and a command line program to discover the public\ninterface of a Python module or package. The `pdocs` script can be used to\ngenerate Markdown or HTML of a module's public interface, or it can be used\nto run an HTTP server that serves generated HTML for installed modules.\n\n`pdocs` is an MIT Licensed fork of `pdoc` with the goal of staying true to the original vision\nlayed out by the projects creator.\n\nNOTE: For most projects, the best way to use `pdocs` is using [portray](https://timothycrosley.github.io/portray/).\n\n[![asciicast](https://asciinema.org/a/265744.svg)](https://asciinema.org/a/265744)\n\nFeatures\n--------\n\n* Support for documenting data representation by traversing the abstract syntax\n  to find docstrings for module, class and instance variables.\n* For cases where docstrings aren't appropriate (like a\n  [namedtuple](http://docs.python.org/2.7/library/collections.html#namedtuple-factory-function-for-tuples-with-named-fields)),\n  the special variable `__pdocs__` can be used in your module to\n  document any identifier in your public interface.\n* Usage is simple. Just write your documentation as Markdown. There are no\n  added special syntax rules.\n* `pdocs` respects your `__all__` variable when present.\n* `pdocs` will automatically link identifiers in your docstrings to its\n  corresponding documentation.\n* When `pdocs` is run as an HTTP server, external linking is supported between\n  packages.\n* The `pdocs` HTTP server will cache generated documentation and automatically\n  regenerate it if the source code has been updated.\n* When available, source code for modules, functions and classes can be viewed\n  in the HTML documentation.\n* Inheritance is used when possible to infer docstrings for class members.\n\nThe above features are explained in more detail in pdocs's documentation.\n\n`pdocs` is compatible with Python 3.6 and newer.\n\n## Quick Start\n\nThe following guides should get you up using pdocs in no time:\n\n1. [Installation](https://timothycrosley.github.io/pdocs/docs/quick_start/1.-installation/) - TL;DR: Run `pip3 install pdocs` within your projects virtual environment.\n2. [Command Line Usage](https://timothycrosley.github.io/pdocs/docs/quick_start/2.-cli/) - TL;DR: Run `pdocs server YOUR_MODULES` to test and `pdocs as_html YOUR_MODULES` to generate HTML.\n3. [API Usage](https://timothycrosley.github.io/pdocs/docs/quick_start/3.-api/) - TL;DR: Everything available via the CLI is also easily available programmatically from within Python.\n\n## Why Create `pdocs`?\n\nI created `pdocs` to help power [portray](https://timothycrosley.github.io/portray/) while staying true to the original vision of `pdoc` and maintain\nMIT license compatibility. In the end I created it to help power better documentation websites for Python projects.\n\nI hope you too find `pdocs` useful!\n\n~Timothy Crosley\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "",
        "keywords": "",
        "license": "MIT",
        "maintainer": "Timothy Crosley",
        "maintainer_email": "timothy.crosley@gmail.com",
        "name": "pdocs",
        "package_url": "https://pypi.org/project/pdocs/",
        "platform": "",
        "project_url": "https://pypi.org/project/pdocs/",
        "project_urls": null,
        "release_url": "https://pypi.org/project/pdocs/1.0.1/",
        "requires_dist": [
            "Markdown (>=3.0.0,<4.0.0)",
            "Mako (>=1.1,<2.0)",
            "hug (>=2.6,<3.0)"
        ],
        "requires_python": ">=3.6,<4.0",
        "summary": "A simple program and library to auto generate API documentation for Python modules.",
        "version": "1.0.1"
    },
    "last_serial": 5774810,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d0a6c357965705c39337274e9e76b3e9",
                    "sha256": "03c522aed85df188d21ba5b7df4066eed8916225214f9402d35e926056788c1e"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d0a6c357965705c39337274e9e76b3e9",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6,<4.0",
                "size": 33454,
                "upload_time": "2019-08-31T06:16:52",
                "url": "https://files.pythonhosted.org/packages/05/1e/e29ead6567d9622b2d73aa05bda2ad2470dc201e931c17c82eb71a0f3c38/pdocs-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cce134139e2e64a4721a32be4330f673",
                    "sha256": "db3d64a19e5b922fa51f6124219b8ec4d6d1bf86290b2cd6f6909d6cec47704a"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "cce134139e2e64a4721a32be4330f673",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6,<4.0",
                "size": 30490,
                "upload_time": "2019-08-31T06:16:54",
                "url": "https://files.pythonhosted.org/packages/96/9e/902db716a40a512c8364a0916d58ea057a0ecd9ecce8715cec8ee08849c6/pdocs-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7326c276ea7a9cc951e7816e8686a2ad",
                    "sha256": "d4dbc5dd970b87c77f70b33149e2aa094903ea10c25263f7f99d8f4ae18b86b8"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7326c276ea7a9cc951e7816e8686a2ad",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6,<4.0",
                "size": 33467,
                "upload_time": "2019-08-31T07:08:05",
                "url": "https://files.pythonhosted.org/packages/92/b6/17a533a255833261440def2ff289040a2096d7440bbd64f6d1240cbf3ff2/pdocs-0.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c211bc499f0930e75172ef4022a9a98e",
                    "sha256": "68be6fbb773ff3db5498fc6dd68537ffac1d5826e637a06200b7afbf48141b79"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c211bc499f0930e75172ef4022a9a98e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6,<4.0",
                "size": 30537,
                "upload_time": "2019-08-31T07:08:06",
                "url": "https://files.pythonhosted.org/packages/5f/97/5423fa438a3e51215ef0b72c159baa61f60bc0a140013ce08ef7b361daf2/pdocs-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7cc9a950fa2d1b1ada7c4fc4f94e364d",
                    "sha256": "7eed5739fa4b7bc3066c6e6abfca5494550b579bf27651e411101f9e04a2bde8"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7cc9a950fa2d1b1ada7c4fc4f94e364d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6,<4.0",
                "size": 33492,
                "upload_time": "2019-08-31T07:28:32",
                "url": "https://files.pythonhosted.org/packages/cc/df/6b2ac57fad4b9d8912703d5b30569c0a49599aca11939bf212f2e4990806/pdocs-0.1.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c3cd3457d25fd36f77792321edc45343",
                    "sha256": "9005ac8875c25bb53e2f738d6e00515cdee4945f80ecfa21982819b634688b51"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "c3cd3457d25fd36f77792321edc45343",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6,<4.0",
                "size": 30568,
                "upload_time": "2019-08-31T07:28:34",
                "url": "https://files.pythonhosted.org/packages/1d/07/12a648f3f3f52f90fa4e403a34b958f695a2c45d04757b3b53f3f8ba3cbb/pdocs-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "81c4826f218d5430ec9c56b7d39170d0",
                    "sha256": "f34efd70d44bea4f6da7e723e370d0d5d8800dba71d9a29141921815df06a706"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "81c4826f218d5430ec9c56b7d39170d0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6,<4.0",
                "size": 33589,
                "upload_time": "2019-08-31T19:59:45",
                "url": "https://files.pythonhosted.org/packages/72/8e/12848d7bb549ff64e2b41bc371865a438f2958266bb0c975fda997cd1cc4/pdocs-0.1.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "832dec1e85d551eadd9698a27a188be3",
                    "sha256": "c3e4635f4732781a7889e961db6789a6adf7a81b9e63d0f8625cb5b02e508313"
                },
                "downloads": -1,
                "filename": "pdocs-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "832dec1e85d551eadd9698a27a188be3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6,<4.0",
                "size": 30645,
                "upload_time": "2019-08-31T19:59:47",
                "url": "https://files.pythonhosted.org/packages/94/e8/08796d347194a40786bf7ba7fb754389d665fa8f1dfec27be8b27ebd6b40/pdocs-0.1.3.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f708e6bea15d6482c173242f973d1d83",
                    "sha256": "74ff94eddeb8bf2bf9b979c4e8f89b4b6d089deb1d1d5d3447a1f62a5d068ea8"
                },
                "downloads": -1,
                "filename": "pdocs-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f708e6bea15d6482c173242f973d1d83",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6,<4.0",
                "size": 32497,
                "upload_time": "2019-09-03T06:56:27",
                "url": "https://files.pythonhosted.org/packages/77/47/26feaa01d500b8c01fad3717a77e157d7f45746d751d6f1beffa7393d870/pdocs-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "3128ff0e1cb991b992093dd0da45ef98",
                    "sha256": "7abdf8972bd3462f5cdb8801a641d40c856153b1f11c477b190b8383e382ac08"
                },
                "downloads": -1,
                "filename": "pdocs-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "3128ff0e1cb991b992093dd0da45ef98",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6,<4.0",
                "size": 29147,
                "upload_time": "2019-09-03T06:56:28",
                "url": "https://files.pythonhosted.org/packages/e7/63/98213a4ea9106c715faabeaa0de5537e5f88d7dc8cce56ca69892456d956/pdocs-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "642fee545b0047f8c109cd4759c1a4c8",
                    "sha256": "9c0d24fdc0e0c537be8f2418edb4f1075da46a0d749b17ea20b74e7e60124f49"
                },
                "downloads": -1,
                "filename": "pdocs-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "642fee545b0047f8c109cd4759c1a4c8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6,<4.0",
                "size": 32839,
                "upload_time": "2019-09-03T09:16:02",
                "url": "https://files.pythonhosted.org/packages/bf/47/40854264a493bfba1c16b55c99f89c5a4a833b52e64283b7f053369eeb6c/pdocs-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7843acddadc185844a03600be50c55c9",
                    "sha256": "23a0346f56c08ab5701ca9b14630aa1f0f32f1c29ee7efcfc8bc512cd272f89b"
                },
                "downloads": -1,
                "filename": "pdocs-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "7843acddadc185844a03600be50c55c9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6,<4.0",
                "size": 29908,
                "upload_time": "2019-09-03T09:16:04",
                "url": "https://files.pythonhosted.org/packages/b7/14/9070549dd862faf3f24ea82ecb709071ca765395abcdf45476c8c50f617a/pdocs-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "642fee545b0047f8c109cd4759c1a4c8",
                "sha256": "9c0d24fdc0e0c537be8f2418edb4f1075da46a0d749b17ea20b74e7e60124f49"
            },
            "downloads": -1,
            "filename": "pdocs-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "642fee545b0047f8c109cd4759c1a4c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6,<4.0",
            "size": 32839,
            "upload_time": "2019-09-03T09:16:02",
            "url": "https://files.pythonhosted.org/packages/bf/47/40854264a493bfba1c16b55c99f89c5a4a833b52e64283b7f053369eeb6c/pdocs-1.0.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7843acddadc185844a03600be50c55c9",
                "sha256": "23a0346f56c08ab5701ca9b14630aa1f0f32f1c29ee7efcfc8bc512cd272f89b"
            },
            "downloads": -1,
            "filename": "pdocs-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7843acddadc185844a03600be50c55c9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6,<4.0",
            "size": 29908,
            "upload_time": "2019-09-03T09:16:04",
            "url": "https://files.pythonhosted.org/packages/b7/14/9070549dd862faf3f24ea82ecb709071ca765395abcdf45476c8c50f617a/pdocs-1.0.1.tar.gz"
        }
    ]
}