{ "info": { "author": "Ilya Lebedev", "author_email": "melevir@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# flake8-annotations-coverage\n\n\n[![Build Status](https://travis-ci.org/best-doctor/flake8-annotations-coverage.svg?branch=master)](https://travis-ci.org/best-doctor/flake8-annotations-coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/8480286aaae1c0612351/maintainability)](https://codeclimate.com/github/best-doctor/flake8-annotations-coverage/maintainability)\n\n\nAn extension for flake8 to report on files with a lot of code\nwithout type annotations.\n\nThis is mostly useful when you add type annotations to existing\nlarge codebase and want to know if new code in annotated modules\n is annotated.\n\nMinimal annotations coverage percentage for each file can be configured via\n`--min-coverage-percents` option, default is 75.\n\nFunction is treated as annotated if it has annotation for at least\none argument or return type. This is enough for mypy to threat the function\nnot as dynamically typed.\n\n## Installation\n\n pip install flake8-annotations-coverage\n\n\n## Example\n\nSample file:\n\n```python\n# test.py\n\ndef annotated_function(some_arg: int):\n pass\n\n\ndef unannotated_function():\n pass\n```\n\nUsage:\n\n```terminal\n$ flake8 test.py\ntest.py:0:1: TAE001 too few type annotations\n```\n\nTested on Python 3.6.5 and flake8 3.7.4.\n\n\n## Contributing\n\nWe would love you to contribute to our project. It's simple:\n\n1. Create an issue with bug you found or proposal you have. Wait for approve from maintainer.\n2. Create a pull request. Make sure all checks are green.\n3. Fix review comments if any.\n4. Be awesome.\n\nHere are useful tips:\n\n- You can run all checks and tests with `make check`. Please do it before TravisCI does.\n- We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/python_styleguide.md). Sorry, styleguide is available only in Russian for now.\n- We respect [Django CoC](https://www.djangoproject.com/conduct/). Make soft, not bullshit.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/best-doctor/flake8-annotations-coverage", "keywords": "flake8 annotations", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "flake8-annotations-coverage", "package_url": "https://pypi.org/project/flake8-annotations-coverage/", "platform": "", "project_url": "https://pypi.org/project/flake8-annotations-coverage/", "project_urls": { "Homepage": "https://github.com/best-doctor/flake8-annotations-coverage" }, "release_url": "https://pypi.org/project/flake8-annotations-coverage/0.0.3/", "requires_dist": null, "requires_python": "", "summary": "A flake8 extension that checks for type annotations coverage", "version": "0.0.3" }, "last_serial": 5202570, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "3196040649be00fd66929d988b4b8c75", "sha256": "17fb1032623aeb3534baffedfb4796385eae18cf1eba1e832e1f66aed2dda301" }, "downloads": -1, "filename": "flake8_annotations_coverage-0.0.2.tar.gz", "has_sig": false, "md5_digest": "3196040649be00fd66929d988b4b8c75", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3182, "upload_time": "2019-02-06T13:26:43", "url": "https://files.pythonhosted.org/packages/34/11/0952146a59225ccb0f43b8ea92ede5f3abad7581d60b3739621036cd2f03/flake8_annotations_coverage-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "1097e284e01a225c70e6df6326eb8ab7", "sha256": "68bec23c59c79c2696bc4b6d73b278c6a0fced4307b730e13820dabfdcded616" }, "downloads": -1, "filename": "flake8_annotations_coverage-0.0.3.tar.gz", "has_sig": false, "md5_digest": "1097e284e01a225c70e6df6326eb8ab7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3210, "upload_time": "2019-04-29T10:15:27", "url": "https://files.pythonhosted.org/packages/ff/8b/1e01a7990f104767d47c05bcf678e9ec707a522749c5ade987c781d1cf9f/flake8_annotations_coverage-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1097e284e01a225c70e6df6326eb8ab7", "sha256": "68bec23c59c79c2696bc4b6d73b278c6a0fced4307b730e13820dabfdcded616" }, "downloads": -1, "filename": "flake8_annotations_coverage-0.0.3.tar.gz", "has_sig": false, "md5_digest": "1097e284e01a225c70e6df6326eb8ab7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3210, "upload_time": "2019-04-29T10:15:27", "url": "https://files.pythonhosted.org/packages/ff/8b/1e01a7990f104767d47c05bcf678e9ec707a522749c5ade987c781d1cf9f/flake8_annotations_coverage-0.0.3.tar.gz" } ] }