{
    "info": {
        "author": "ku-mu",
        "author_email": "cocodrips@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# doc-cov \n\ndoc-cov is a tool for measuring docstring coverage of Python project.\n\n- Python versions >= 3.6 \n\n\n## Quick start\n\n1. Install doc-cov from pip.\n2. Use `doccov PROJECT_PATH`\n\n```\n$ doccov tests/sample_project\nfunction     3 /   5 60.00%\n```\n\n## Options\n### Target object\ndoc-cov can measure docstring coverage of functions, classes and modules.\n\n#### functions (default, `-f`) \n\n```\n$ doccov tests/sample_project -f\nfunction     3 /   5 60.00%\n\n```\n\n#### classes `-c`\n\n```\n$ doccov tests/sample_project -c\nclass        2 /   2 100.00%\n\n```\n\n#### modules `-m`\n\n```\n$ doccov tests/sample_project -m\nmodule       3 /   7 42.86%\n\n```\n\n### Output \n\n#### str (default, `--output str`)\n\n```\n$ doccov tests/sample_project -fmc --output str\nclass        2 /   2 100.00%\nmodule       3 /   7 42.86%\nfunction     3 /   5 60.00%\n```\n\n#### csv `--output csv`\n\n```\n$ doccov tests/sample_project -fmc --output csv\ncoverage,class,2,2,100.00%\ncoverage,module,3,7,42.86%\ncoverage,function,3,5,60.00%\n```\n\n### Target \n#### Print coverage of whole (default)\n\n```\n$ doccov tests/sample_project\nfunction     3 /   5 60.00%\n\n```  \n#### Print all coverage of modules `--all`\n\n```\n$ doccov tests/sample_project --all\n=============================\nmodule_fulldoc\n-----------------------------\nfunction     1 /   1 100.00%\n=============================\npackage_A\n-----------------------------\nfunction     0 /   0 -\n=============================\npackage_A.module_fulldoc\n-----------------------------\nfunction     1 /   1 100.00%\n=============================\npackage_B\n-----------------------------\nfunction     0 /   0 -\n=============================\npackage_B.module_shortdoc\n-----------------------------\nfunction     1 /   1 100.00%\n=============================\npackage_B.package_B_1\n-----------------------------\nfunction     0 /   0 -\n=============================\npackage_B.package_B_1.module_nodoc\n-----------------------------\nfunction     0 /   2 0.00%\n=============================\ncoverage\n-----------------------------\nfunction     3 /   5 60.00%\n```\n\n## Report to pull request\n\nAdd comment to *github* pull request.\n\n```\n$ doccov <project> -fmc --output csv > doccov.csv\n$ GITHUB_TOKEN=XXXXX doccov-report doccov.csv\n```\n\n**CircleCi**  \nAdd pull request comment using circle-ci environment.\n\n**Other**  \nRequired following environment\n- PROJECT_USERNAME\n- PROJECT_REPONAME\n- PR_NUMBER\n\n\n",
        "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/cocodrips/doc-cov",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "doc-cov",
        "package_url": "https://pypi.org/project/doc-cov/",
        "platform": "",
        "project_url": "https://pypi.org/project/doc-cov/",
        "project_urls": {
            "Homepage": "https://github.com/cocodrips/doc-cov"
        },
        "release_url": "https://pypi.org/project/doc-cov/0.4.0/",
        "requires_dist": [
            "pytest (>=3) ; extra == 'dev'"
        ],
        "requires_python": ">=3.6",
        "summary": "doc-cov is a tool for measuring docstring coverage of Python project",
        "version": "0.4.0"
    },
    "last_serial": 4915729,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0f52882857793624f8ac576dfade2a7f",
                    "sha256": "19b7b294aa48c679b0720247408f3456933bb577f81b699bf612a86ad5eca908"
                },
                "downloads": -1,
                "filename": "doc_cov-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0f52882857793624f8ac576dfade2a7f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5046,
                "upload_time": "2019-02-06T14:32:16",
                "url": "https://files.pythonhosted.org/packages/b8/43/9ee47b384de4c1b8b6597f162328405fd54399655bab94bd8cd9b43b223f/doc_cov-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ba0334966d8b67a242b112e43efd9243",
                    "sha256": "1b47e683dc984aff7bbcd763c2f9fa1d22bd311676e1be9c0d70264d64c5ebbb"
                },
                "downloads": -1,
                "filename": "doc-cov-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ba0334966d8b67a242b112e43efd9243",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 3962,
                "upload_time": "2019-02-06T14:32:18",
                "url": "https://files.pythonhosted.org/packages/12/a9/11acb3714978c182dbb124c73b911d1f141d7f640f2904ff37d473a2255c/doc-cov-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "44464ba03d00a6fce2a545efdb6ac31d",
                    "sha256": "7ef468d72c5c2e742d2597404fdff75b6b801111ba34282ce066734fcab34ecf"
                },
                "downloads": -1,
                "filename": "doc_cov-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "44464ba03d00a6fce2a545efdb6ac31d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5205,
                "upload_time": "2019-02-06T17:29:14",
                "url": "https://files.pythonhosted.org/packages/6d/1e/62b9976dad0c7fb1acf5163530b3d3588088efc3b69713eb2f5e0792abe0/doc_cov-0.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2013077f32e5696da51da0480ce01028",
                    "sha256": "dfb2c1ad8371e5f8f7e47c7b0588e966dacdd198652dc5871d1ec38dba4f70ce"
                },
                "downloads": -1,
                "filename": "doc-cov-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "2013077f32e5696da51da0480ce01028",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 4134,
                "upload_time": "2019-02-06T17:29:15",
                "url": "https://files.pythonhosted.org/packages/c5/44/06be6daacdc5f3992000e860036fc28222cc68151a69365789a9c8817302/doc-cov-0.1.1.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b800bd553504c272095ab8995e4df842",
                    "sha256": "ad8e8a38c0990028e74f6414ffe6086672f045019bdbc38a8eb0a35bb8d0fa8c"
                },
                "downloads": -1,
                "filename": "doc_cov-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b800bd553504c272095ab8995e4df842",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5250,
                "upload_time": "2019-02-06T18:04:55",
                "url": "https://files.pythonhosted.org/packages/81/6d/ace32d150f94b13cb160b922dd146cda4266c8241091c738f022c2e92aee/doc_cov-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a37bda20544fc6b8208faf781f3e1e84",
                    "sha256": "fcda7a2cbec807e5b2e46ed61db93c089847645b2e36db952167925b6f918083"
                },
                "downloads": -1,
                "filename": "doc-cov-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a37bda20544fc6b8208faf781f3e1e84",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 4169,
                "upload_time": "2019-02-06T18:04:56",
                "url": "https://files.pythonhosted.org/packages/3e/96/b11a253af91d70ebccf4a26f13c2398530c62981ec0126ea4b46a2072531/doc-cov-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9efcd8d031350a77ec411897b3527543",
                    "sha256": "ac81bce59087d0389059a50891a349bedb829cde7238995f2341a6e8c64217e1"
                },
                "downloads": -1,
                "filename": "doc_cov-0.3.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9efcd8d031350a77ec411897b3527543",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5572,
                "upload_time": "2019-02-15T15:22:09",
                "url": "https://files.pythonhosted.org/packages/87/1a/df832425cdc8a33b093de359638de7b4072ae9172945bda79bed2739e3aa/doc_cov-0.3.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a669a86af2fcf1b7cf6be6cadbfc74ee",
                    "sha256": "d8e070bed5930af54af0beb97a65f928c671e16cb14df888014770da2f1394d5"
                },
                "downloads": -1,
                "filename": "doc-cov-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a669a86af2fcf1b7cf6be6cadbfc74ee",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 4529,
                "upload_time": "2019-02-15T15:22:11",
                "url": "https://files.pythonhosted.org/packages/9f/52/b2e9ba409a3b165222876f655c33f714175fd2eb43e736e0f1a15371bebd/doc-cov-0.3.0.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e209beda8478b52ca9cf26531e784fb2",
                    "sha256": "18bf921e09579f1f22f2b78c9b725c198a5baaad07ab0a88cddbeb0ea4815167"
                },
                "downloads": -1,
                "filename": "doc_cov-0.4.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e209beda8478b52ca9cf26531e784fb2",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7056,
                "upload_time": "2019-03-08T14:30:55",
                "url": "https://files.pythonhosted.org/packages/23/2f/d0a330f9fee31f829a31a0809b127acefa81f6523fdf7d4e826692e475c2/doc_cov-0.4.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6d361fc8a36c466f064dbf5ba7178483",
                    "sha256": "28990976f00f9855c56c35473e9b1e0d1d79e51254d62b5eb311a10dacae9950"
                },
                "downloads": -1,
                "filename": "doc-cov-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "6d361fc8a36c466f064dbf5ba7178483",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 5623,
                "upload_time": "2019-03-08T14:30:56",
                "url": "https://files.pythonhosted.org/packages/b5/95/3488ac6d1174a40a1ca20559ada6eb540ebe39491a3a931484f166d0a835/doc-cov-0.4.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e209beda8478b52ca9cf26531e784fb2",
                "sha256": "18bf921e09579f1f22f2b78c9b725c198a5baaad07ab0a88cddbeb0ea4815167"
            },
            "downloads": -1,
            "filename": "doc_cov-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e209beda8478b52ca9cf26531e784fb2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7056,
            "upload_time": "2019-03-08T14:30:55",
            "url": "https://files.pythonhosted.org/packages/23/2f/d0a330f9fee31f829a31a0809b127acefa81f6523fdf7d4e826692e475c2/doc_cov-0.4.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "6d361fc8a36c466f064dbf5ba7178483",
                "sha256": "28990976f00f9855c56c35473e9b1e0d1d79e51254d62b5eb311a10dacae9950"
            },
            "downloads": -1,
            "filename": "doc-cov-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6d361fc8a36c466f064dbf5ba7178483",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 5623,
            "upload_time": "2019-03-08T14:30:56",
            "url": "https://files.pythonhosted.org/packages/b5/95/3488ac6d1174a40a1ca20559ada6eb540ebe39491a3a931484f166d0a835/doc-cov-0.4.0.tar.gz"
        }
    ]
}