{ "info": { "author": "Jan Freyberg", "author_email": "jan@asidatascience.com", "bugtrack_url": null, "classifiers": [], "description": "# docargs\n\nA package to check that you have documented all your parameters.\n\nDocargs is written with continuous integration in mind: It will raise an error\nif you have not documented all your function arguments. It's easy to forget, but\nit's also important not to - so you should automate a test of it!\n\nTo use, simply `pip install docargs`, and run `docargs mypackage/**/*py`. Alternatively, docargs integrates with flake8, so running `flake8 mypackage` will also work.\n\nTo see it in action, check out the travis CI configuration\non this [repository](https://travis-ci.org/janfreyberg/docargs)\n\nCurrently, `docargs` only works with `numpydoc`-style docstrings. \n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/janfreyberg/docargs/0.1.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/janfreyberg/docargs", "keywords": "linting", "license": "", "maintainer": "", "maintainer_email": "", "name": "docargs", "package_url": "https://pypi.org/project/docargs/", "platform": "", "project_url": "https://pypi.org/project/docargs/", "project_urls": { "Download": "https://github.com/janfreyberg/docargs/0.1.1.tar.gz", "Homepage": "https://github.com/janfreyberg/docargs" }, "release_url": "https://pypi.org/project/docargs/0.1.1/", "requires_dist": [ "numpydoc", "click", "colorama", "pyyaml", "flake8", "docstring-parser", "mypy ; extra == 'tests'" ], "requires_python": "", "summary": "Check that all arguments are documented.", "version": "0.1.1" }, "last_serial": 5902394, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "21736614f44e87184647d4d35211d3c1", "sha256": "ac598ee5b069b335fa1b64f6488b0cf5a39e07eb1cddc7b399563dcc4d07c786" }, "downloads": -1, "filename": "docargs-0.0.2.tar.gz", "has_sig": false, "md5_digest": "21736614f44e87184647d4d35211d3c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3000, "upload_time": "2018-11-05T10:29:08", "url": "https://files.pythonhosted.org/packages/83/7e/7657894204108af87477cad16dc5e2a7aeba9ad35c666449b6e230bb4bcc/docargs-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "bff97508cb97b0d243580785725327e0", "sha256": "028f3112551c84686805cec7fffc14c8603b30fd82c1538644988cede267d0c1" }, "downloads": -1, "filename": "docargs-0.0.3.tar.gz", "has_sig": false, "md5_digest": "bff97508cb97b0d243580785725327e0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3043, "upload_time": "2018-11-05T13:48:02", "url": "https://files.pythonhosted.org/packages/4f/96/1a86816aebbea2b763014bbf6383840396a5ea6235f2576da08ca6d3e285/docargs-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "2d32da1839a6d47afbc12c929a432524", "sha256": "4fc4cf5469227ec118c7f197b9d85bea7ee2f18f50dffbc5530603baaecb3b3c" }, "downloads": -1, "filename": "docargs-0.0.4.tar.gz", "has_sig": false, "md5_digest": "2d32da1839a6d47afbc12c929a432524", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3187, "upload_time": "2018-11-09T18:27:04", "url": "https://files.pythonhosted.org/packages/45/d5/a2a0ec5e21bd1e435743328af44c1d78a7697f1f1cf3eb4bf9156170b72d/docargs-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "fd6d9d5f1b47190ef2eaa007639f95c4", "sha256": "cd9d5a3d14ce7ee9db324ddd42e3410970397c7fbbad6c0db07991766b36b22c" }, "downloads": -1, "filename": "docargs-0.0.5.tar.gz", "has_sig": false, "md5_digest": "fd6d9d5f1b47190ef2eaa007639f95c4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4866, "upload_time": "2018-11-25T13:42:03", "url": "https://files.pythonhosted.org/packages/a0/1a/52830cfe0b9f20541ac824bc20b022d8a3fc8b34545d2284b7f5f6f8e018/docargs-0.0.5.tar.gz" } ], "0.0.5rc1": [ { "comment_text": "", "digests": { "md5": "117015936e267affdd735ba8764db0d9", "sha256": "1d0c9feeb2c2cd41356bfaaeac0faaf4b2761706a00664287d1b1e8d79112121" }, "downloads": -1, "filename": "docargs-0.0.5rc1.tar.gz", "has_sig": false, "md5_digest": "117015936e267affdd735ba8764db0d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4310, "upload_time": "2018-11-25T00:05:19", "url": "https://files.pythonhosted.org/packages/8a/54/8d69b4579b0b19464c95df63682824c17a1c4dab0c1af7cc72e04064a680/docargs-0.0.5rc1.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "6c936d95fa64130d0fab6a5deb98b003", "sha256": "0e7a5eec9abbfeef1722bba2b2b56fcae8a0dca7eab0ccc828545bc1b5730b23" }, "downloads": -1, "filename": "docargs-0.0.6.tar.gz", "has_sig": false, "md5_digest": "6c936d95fa64130d0fab6a5deb98b003", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4875, "upload_time": "2018-11-30T16:26:08", "url": "https://files.pythonhosted.org/packages/9b/32/0699ae89c8129147cbd35190a2477d3679a78087d95b39c4d3d3315781de/docargs-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "4d7a6ea96a272a8155b7417f37914323", "sha256": "938d42f5b8ca2f1b8dcbd3ae2e1051b3d9eccb4926ba87bcd5ec4b9f8a4d9ef2" }, "downloads": -1, "filename": "docargs-0.0.7.tar.gz", "has_sig": false, "md5_digest": "4d7a6ea96a272a8155b7417f37914323", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4896, "upload_time": "2018-12-05T10:01:47", "url": "https://files.pythonhosted.org/packages/70/f1/e57c113c81ff0ba5fa689fb9711b3d6659f4de8ba4a90e3e45cac4fa70eb/docargs-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "0ff63d134324ec189efdfdcff8151dd6", "sha256": "05304932f1927d7e8342ccdcbb7effcf18b87e3570b30af95ebdc7fbffe1ad64" }, "downloads": -1, "filename": "docargs-0.0.8.tar.gz", "has_sig": false, "md5_digest": "0ff63d134324ec189efdfdcff8151dd6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4930, "upload_time": "2018-12-15T11:20:16", "url": "https://files.pythonhosted.org/packages/9d/54/81a309bbf331a914a21b604eee67a7875b5436337fb6092a624dcea70b5f/docargs-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "12378280b8b5de331a9c583a7b77db11", "sha256": "7a593f63025377141275bb4831e3548c9e56a56b1b0c2f1539db95d223879bca" }, "downloads": -1, "filename": "docargs-0.0.9.tar.gz", "has_sig": false, "md5_digest": "12378280b8b5de331a9c583a7b77db11", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4934, "upload_time": "2018-12-15T11:53:39", "url": "https://files.pythonhosted.org/packages/99/61/4e2dbc4ff1949176ff2188b75bd04ed18b68602bfee231c4a7b83ae06c69/docargs-0.0.9.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "5493609459177d0f8a96bff69c6bf89c", "sha256": "a74b42c6d283c0374f19627c21a48ed1343125e010a11ea7e797e56a5959946f" }, "downloads": -1, "filename": "docargs-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5493609459177d0f8a96bff69c6bf89c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7494, "upload_time": "2019-09-27T22:05:59", "url": "https://files.pythonhosted.org/packages/83/e8/849c79cce1112b4dba0ab9edb0f3cd63e20540ff6532b1e02aec7c565fbb/docargs-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3c22df76788677cb85e3e9300fd50905", "sha256": "202b93a7b4bbaa795c9314bd8d415568cc4c3567113a8e088bff618bddc9fa9e" }, "downloads": -1, "filename": "docargs-0.1.0.tar.gz", "has_sig": false, "md5_digest": "3c22df76788677cb85e3e9300fd50905", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5110, "upload_time": "2019-09-27T22:06:00", "url": "https://files.pythonhosted.org/packages/af/96/c53a7a8503f3ebc3f8007035dc06d4acf5b1ce090856c5ebfefea078fdbe/docargs-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "b4a502a3ca605c6ec2f989c547da16b3", "sha256": "d87b77afa4ec61b252991a8b86479b97eb0f7fbdb5c3026a89fcbee02216492e" }, "downloads": -1, "filename": "docargs-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b4a502a3ca605c6ec2f989c547da16b3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7500, "upload_time": "2019-09-29T11:17:18", "url": "https://files.pythonhosted.org/packages/22/a7/80d45df252ecbea3c51ca49ede0deb3c32976de58c54ec5cfa01d2494727/docargs-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5b327a52c526db3c9ced0fcc25a0aa79", "sha256": "c2c4b8af4c30b8b3d21f74b2d6667951ff42fe32e0812b99c7260b891f0a9564" }, "downloads": -1, "filename": "docargs-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5b327a52c526db3c9ced0fcc25a0aa79", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5141, "upload_time": "2019-09-29T11:17:23", "url": "https://files.pythonhosted.org/packages/96/d6/ed8c69bb1fbfc2f98d6319bb67b485b38ccee1730f3854afe9c0fb2d47bf/docargs-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b4a502a3ca605c6ec2f989c547da16b3", "sha256": "d87b77afa4ec61b252991a8b86479b97eb0f7fbdb5c3026a89fcbee02216492e" }, "downloads": -1, "filename": "docargs-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b4a502a3ca605c6ec2f989c547da16b3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7500, "upload_time": "2019-09-29T11:17:18", "url": "https://files.pythonhosted.org/packages/22/a7/80d45df252ecbea3c51ca49ede0deb3c32976de58c54ec5cfa01d2494727/docargs-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5b327a52c526db3c9ced0fcc25a0aa79", "sha256": "c2c4b8af4c30b8b3d21f74b2d6667951ff42fe32e0812b99c7260b891f0a9564" }, "downloads": -1, "filename": "docargs-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5b327a52c526db3c9ced0fcc25a0aa79", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5141, "upload_time": "2019-09-29T11:17:23", "url": "https://files.pythonhosted.org/packages/96/d6/ed8c69bb1fbfc2f98d6319bb67b485b38ccee1730f3854afe9c0fb2d47bf/docargs-0.1.1.tar.gz" } ] }