{ "info": { "author": "Ilya Lebedev", "author_email": "melevir@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# flake8-variables-names\n\n\n[![Build Status](https://travis-ci.org/best-doctor/flake8-variables-names.svg?branch=master)](https://travis-ci.org/best-doctor/flake8-variables-names)\n[![Maintainability](https://api.codeclimate.com/v1/badges/c7502e578af3f4437179/maintainability)](https://codeclimate.com/github/best-doctor/flake8-variables-names/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/c7502e578af3f4437179/test_coverage)](https://codeclimate.com/github/best-doctor/flake8-variables-names/test_coverage)\n\nAn extension for flake8 that helps to make more readable variables names.\n\nWe believe, that variable name should unmistakably shows, what it contains.\nThats why we try not to use varnames with only one symbol or not to use\ntoo common names, such as `result`, `value` or `info`.\n\nThis extensions helps to detect such names. By default it works in\nnon-strict mode. You can change it with `--use-varnames-strict-mode`\nparameter end extend variable names blacklist even more.\n\n## Installation\n\n pip install flake8-variables-names\n\n\n## Example\n\nSample file:\n\n```python\n# test.py\n\na = 1\nfoo = 2\nresult = a + foo\n```\n\nUsage:\n\n```terminal\n$ flake8 test.py\ntest.py:1:1: VNE001 single letter variable names are not allowed\ntest.py:2:1: VNE002 variable name should be clarified\n```\n\nTested on Python 3.6 and flake8 3.5.0.\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": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/best-doctor/flake8-variables-names", "keywords": "flake8 naming", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "flake8-variables-names", "package_url": "https://pypi.org/project/flake8-variables-names/", "platform": "", "project_url": "https://pypi.org/project/flake8-variables-names/", "project_urls": { "Homepage": "https://github.com/best-doctor/flake8-variables-names" }, "release_url": "https://pypi.org/project/flake8-variables-names/0.0.2/", "requires_dist": null, "requires_python": "", "summary": "A flake8 extension that helps to make more readable variables names", "version": "0.0.2" }, "last_serial": 5752191, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "6f9bf778f6fd87c5361119cfe00e4ff3", "sha256": "728cfe7ca01fd2458fde22563e0bf53ff88018ada96471c73f6072f782218597" }, "downloads": -1, "filename": "flake8_variables_names-0.0.1.tar.gz", "has_sig": false, "md5_digest": "6f9bf778f6fd87c5361119cfe00e4ff3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3871, "upload_time": "2019-02-07T12:00:38", "url": "https://files.pythonhosted.org/packages/4d/da/be9645712f1f3045fc4c3d1367adad4715506ddb38fcce44c295f8a4d8ab/flake8_variables_names-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "aa03fb6add112159d23df345245acac7", "sha256": "f9ee2edf0892a73fff33ef3eda37a7182cb91cd4c3a19a592ad432b68b261927" }, "downloads": -1, "filename": "flake8_variables_names-0.0.2.tar.gz", "has_sig": false, "md5_digest": "aa03fb6add112159d23df345245acac7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3991, "upload_time": "2019-08-29T12:41:21", "url": "https://files.pythonhosted.org/packages/1e/61/768a11c630fe2cdcfa9e5efbd6f681474bb8e75e983ab2b78377d6a6a6a0/flake8_variables_names-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aa03fb6add112159d23df345245acac7", "sha256": "f9ee2edf0892a73fff33ef3eda37a7182cb91cd4c3a19a592ad432b68b261927" }, "downloads": -1, "filename": "flake8_variables_names-0.0.2.tar.gz", "has_sig": false, "md5_digest": "aa03fb6add112159d23df345245acac7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3991, "upload_time": "2019-08-29T12:41:21", "url": "https://files.pythonhosted.org/packages/1e/61/768a11c630fe2cdcfa9e5efbd6f681474bb8e75e983ab2b78377d6a6a6a0/flake8_variables_names-0.0.2.tar.gz" } ] }