{ "info": { "author": "Leo Hanisch", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9" ], "description": "# pylint-file-header\n\n[![Pypi](https://img.shields.io/pypi/v/pylintfileheader.svg?style=flat-square)](https://pypi.python.org/pypi/pylintfileheader) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pylintfileheader.svg?style=flat-square)](https://pypi.python.org/pypi/pylintfileheader) [![PyPI - Downloads](https://img.shields.io/pypi/dm/pylintfileheader.svg?style=flat-square)](https://pypistats.org/packages/pylintfileheader) [![Stars](https://img.shields.io/github/stars/HaaLeo/pylint-file-header.svg?label=Stars&logo=github&style=flat-square)](https://github.com/HaaLeo/pylint-file-header/stargazers) \n[![PyPI - License](https://img.shields.io/pypi/l/pylintfileheader.svg?style=flat-square)](https://raw.githubusercontent.com/HaaLeo/pylint-file-header/master/LICENSE.txt) [![Build Status](https://img.shields.io/travis/HaaLeo/pylint-file-header/master.svg?style=flat-square)](https://travis-ci.org/HaaLeo/pylint-file-header) [![Codecov](https://img.shields.io/codecov/c/github/HaaLeo/pylint-file-header.svg?style=flat-square)](https://codecov.io/gh/HaaLeo/pylint-file-header) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) \n[![Donate](https://img.shields.io/badge/-Donate-blue.svg?logo=paypal&style=flat-square)](https://www.paypal.me/LeoHanisch)\n\nPylint plugin to enforce consistent file/module header.\n\n## Installation\n\nYou can install the package with `pip` from [pypi](https://pypi.org/project/pylintfileheader):\n\n```\npip install pylintfileheader\n```\n\n## Configuration\n\nGenerate a `.pylintrc` file by executing `pylint --generate-rcfile`.\nThen add `pylintfileheader` to the plugins to load and set the `file-header` option to the [regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) that the file header should match. \nWhen the `file-header` setting is omitted, pylint will pass.\n\n### Options\n\n* `file-header` is a regexp representing the file header that should be on top of a file.\n* `file-header-path` is the path to the file that contains the header. This is useful in case of long, multi-line headers, such as copyrights.\n* `file-header-ignore-empty-files` turns on the mode of ignoring the empty files, like `__init__.py`. The default value is `False`.\n\nIf both options `file-header` and `file-header-path` are set, then `file-header` will be used and the `file-header-path` is ignored.\n\n## Example\n\n### Setup\n\n* **.pylintrc**: \n\n ```pylintrc\n [MASTER]\n load-plugins=pylintfileheader\n\n file-header=# -----------\\n#[ \\w]*\\n# -----------\n ```\n\n* **valid_example.py**: \n\n ```python\n # -----------\n # lorem ipsum\n # -----------\n\n print('I am a valid example')\n ```\n\n* **invalid_example.py**: \n\n ```python\n # lorem ipsum\n\n print('I am an invalid example')\n ```\n\n### Evaluation\n\n* `pylint valid_example.py` evaluates to: \n ```\n Using config file /path/to/your/.pylintrc\n\n ------------------------------------\n Your code has been rated at 10.00/10\n ```\n\n* `pylint invalid_example.py` evaluates to: \n ```\n Using config file /path/to/your/.pylintrc\n ************* Module invalid_example\n C: 1, 0: File header should match regex \"# -----------\\n#[ \\w]*\\n# -----------\" (invalid-file-header)\n\n -----------------------------------\n Your code has been rated at 8.57/10\n ```\n\n## Contribution\n\nIf you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/pylint-file-header/issues/new/choose). \nPull Requests are welcome!\n\n## Support\n\nWhen you like this package make sure to [star the repository](https://github.com/HaaLeo/pylint-file-header/stargazers). I am always looking for new ideas and feedback. \nIn addition, it is possible to [donate via paypal](https://www.paypal.me/LeoHanisch).\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": "", "keywords": "pylintfileheader,pylint,file,module,header", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pylintfileheader", "package_url": "https://pypi.org/project/pylintfileheader/", "platform": "", "project_url": "https://pypi.org/project/pylintfileheader/", "project_urls": { "Changelog": "https://github.com/HaaLeo/pylint-file-header/blob/master/CHANGELOG.md#changelog", "Funding": "https://github.com/sponsors/HaaLeo", "Issue Tracker": "https://github.com/HaaLeo/pylint-file-header/issues", "Source": "https://github.com/HaaLeo/pylint-file-header" }, "release_url": "https://pypi.org/project/pylintfileheader/0.3.2/", "requires_dist": null, "requires_python": ">=2.7", "summary": "Enables pylint to force a consistent file header.", "version": "0.3.2", "yanked": false, "yanked_reason": null }, "last_serial": 11482817, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "a7b35bf3ea08ec82082688dd965ad7fe", "sha256": "969c0dc5f1c082a8201de61bd402ea321cc11dd818745931a4fbd9491e663286" }, "downloads": -1, "filename": "pylintfileheader-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a7b35bf3ea08ec82082688dd965ad7fe", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6026, "upload_time": "2018-11-25T18:38:02", "upload_time_iso_8601": "2018-11-25T18:38:02.262946Z", "url": "https://files.pythonhosted.org/packages/ac/35/d1067f3d743de3fd86cf46e9fc905ccbf857249619f5e052c02b61a44222/pylintfileheader-0.0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "33cec782d31d1da5b0cff6e3888082b4", "sha256": "2d209310e890e553fb99b9197e09dfc4ac364e81b1ff77bbb0fd41ece76e4c8c" }, "downloads": -1, "filename": "pylintfileheader-0.0.1.tar.gz", "has_sig": false, "md5_digest": "33cec782d31d1da5b0cff6e3888082b4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4561, "upload_time": "2018-11-25T18:38:04", "upload_time_iso_8601": "2018-11-25T18:38:04.583561Z", "url": "https://files.pythonhosted.org/packages/65/38/e170c69ed24c8ed72396eb08700f6d269c052a8ba7c4181235070cf3b64a/pylintfileheader-0.0.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "27bce09e78ff0da162ec993b51646eeb", "sha256": "214a445432b56c177b65bd1b8f10f2b3dafbb5bc002cea9309c9309bf66e7588" }, "downloads": -1, "filename": "pylintfileheader-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "27bce09e78ff0da162ec993b51646eeb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6349, "upload_time": "2018-11-28T21:08:22", "upload_time_iso_8601": "2018-11-28T21:08:22.093571Z", "url": "https://files.pythonhosted.org/packages/df/b6/34717415066015de869d3c2644d9fa1cd3b0fe689157e072086264286104/pylintfileheader-0.0.2-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "d1dab6388eb20d0550cf44c821917a59", "sha256": "333afb23262b2530964cd9181303c8ff16b5c3e7236efe3d1fca0684f2b3bd0c" }, "downloads": -1, "filename": "pylintfileheader-0.0.2.tar.gz", "has_sig": false, "md5_digest": "d1dab6388eb20d0550cf44c821917a59", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4662, "upload_time": "2018-11-28T21:08:23", "upload_time_iso_8601": "2018-11-28T21:08:23.657906Z", "url": "https://files.pythonhosted.org/packages/ca/d3/dbebbf48f8b84986d5a4048dba46d8be548b7974782b086c33e4589d7ba8/pylintfileheader-0.0.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "5afec4ce5653705ddd9789aa296870ac", "sha256": "dbcd7c504afea2a909a0bf3a5dfff1931645297de27c032296b432f5347bd7f5" }, "downloads": -1, "filename": "pylintfileheader-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5afec4ce5653705ddd9789aa296870ac", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6384, "upload_time": "2019-10-30T18:42:47", "upload_time_iso_8601": "2019-10-30T18:42:47.739027Z", "url": "https://files.pythonhosted.org/packages/03/78/3f48341006fd2651eb230cad20479ea005eeee40b5a981b076295db5da72/pylintfileheader-0.1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "65b3b77b533b57f12768c22891c6e999", "sha256": "1e404d21142ef1f38610b57f8bbdae3856442880212f189a8a296cff02793087" }, "downloads": -1, "filename": "pylintfileheader-0.1.0.tar.gz", "has_sig": false, "md5_digest": "65b3b77b533b57f12768c22891c6e999", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4920, "upload_time": "2019-10-30T18:42:48", "upload_time_iso_8601": "2019-10-30T18:42:48.763941Z", "url": "https://files.pythonhosted.org/packages/45/5b/278aa57c118e71e0b458af406d709225258e0b5736dea0bce37961a1b66a/pylintfileheader-0.1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "ec4025981d9d55b6e1b7444d7a21989f", "sha256": "2055acb1ee95f03d0f1fd6a715114fb23a3431ee4bec9ca829c067a79c1fcc92" }, "downloads": -1, "filename": "pylintfileheader-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "ec4025981d9d55b6e1b7444d7a21989f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6567, "upload_time": "2020-12-28T16:54:10", "upload_time_iso_8601": "2020-12-28T16:54:10.669982Z", "url": "https://files.pythonhosted.org/packages/81/03/5e4270767363a2dca31ec713bc65c21c2b7b916bcc77f6dcc8cce39df01e/pylintfileheader-0.2.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "52f6010adab4d59edd5427423af9d778", "sha256": "38c83b21cb2cc2018e8dc4c254ec506c915c505808e9af356d2e78dafcfd8a63" }, "downloads": -1, "filename": "pylintfileheader-0.2.0.tar.gz", "has_sig": false, "md5_digest": "52f6010adab4d59edd5427423af9d778", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 5106, "upload_time": "2020-12-28T16:54:11", "upload_time_iso_8601": "2020-12-28T16:54:11.878634Z", "url": "https://files.pythonhosted.org/packages/48/6c/d651364d70251788231b7e013fc3f256dc4e33bdacf46a24d9f610599ac2/pylintfileheader-0.2.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "d29d96521c2213a2d13b4baf97790384", "sha256": "7871193691484210268d467dc12d88ac5b3ba7eb7dec6239e24075797185a3b2" }, "downloads": -1, "filename": "pylintfileheader-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d29d96521c2213a2d13b4baf97790384", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6841, "upload_time": "2020-12-28T20:44:01", "upload_time_iso_8601": "2020-12-28T20:44:01.578632Z", "url": "https://files.pythonhosted.org/packages/8d/f3/81d61b0541a26051e565f63e08f9fe91f3e0191a8b4ee0627078c0cc2e27/pylintfileheader-0.3.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "d6961421a6fc43e1fe826687f0a23c21", "sha256": "a23f143b0fb4d65f984ffd824731d6e41f2840e26a5752a90df93f4454b5ccd1" }, "downloads": -1, "filename": "pylintfileheader-0.3.0.tar.gz", "has_sig": false, "md5_digest": "d6961421a6fc43e1fe826687f0a23c21", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 5392, "upload_time": "2020-12-28T20:44:02", "upload_time_iso_8601": "2020-12-28T20:44:02.912659Z", "url": "https://files.pythonhosted.org/packages/fa/5f/13aab6df0cc6adb711cdcc6a54b60717eec9b5654e9bee673cc985346283/pylintfileheader-0.3.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "5d2cd0f1e6e44fa444e6466fee944bc0", "sha256": "77a991cc07611c99f8cb75b83a8b85189070152ce55b64f746a9a5e741b9643c" }, "downloads": -1, "filename": "pylintfileheader-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5d2cd0f1e6e44fa444e6466fee944bc0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6844, "upload_time": "2021-09-17T20:51:30", "upload_time_iso_8601": "2021-09-17T20:51:30.346811Z", "url": "https://files.pythonhosted.org/packages/58/1e/1659056497d79a495a6a807cc195ebbbdba58ede9d72783499720df09dd8/pylintfileheader-0.3.2-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "af9722afbdbc3c0a339981bcf0771ad8", "sha256": "fb46995d4d84809be23b98310734a920322b3fff387d13ba23230c6f21bda4b9" }, "downloads": -1, "filename": "pylintfileheader-0.3.2.tar.gz", "has_sig": false, "md5_digest": "af9722afbdbc3c0a339981bcf0771ad8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 5398, "upload_time": "2021-09-17T20:51:32", "upload_time_iso_8601": "2021-09-17T20:51:32.281244Z", "url": "https://files.pythonhosted.org/packages/e4/49/bd7dfdc7eb5861d5ee99b80fd31a85bc9ed8047dfac18d47e35937486e16/pylintfileheader-0.3.2.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5d2cd0f1e6e44fa444e6466fee944bc0", "sha256": "77a991cc07611c99f8cb75b83a8b85189070152ce55b64f746a9a5e741b9643c" }, "downloads": -1, "filename": "pylintfileheader-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5d2cd0f1e6e44fa444e6466fee944bc0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 6844, "upload_time": "2021-09-17T20:51:30", "upload_time_iso_8601": "2021-09-17T20:51:30.346811Z", "url": "https://files.pythonhosted.org/packages/58/1e/1659056497d79a495a6a807cc195ebbbdba58ede9d72783499720df09dd8/pylintfileheader-0.3.2-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "af9722afbdbc3c0a339981bcf0771ad8", "sha256": "fb46995d4d84809be23b98310734a920322b3fff387d13ba23230c6f21bda4b9" }, "downloads": -1, "filename": "pylintfileheader-0.3.2.tar.gz", "has_sig": false, "md5_digest": "af9722afbdbc3c0a339981bcf0771ad8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 5398, "upload_time": "2021-09-17T20:51:32", "upload_time_iso_8601": "2021-09-17T20:51:32.281244Z", "url": "https://files.pythonhosted.org/packages/e4/49/bd7dfdc7eb5861d5ee99b80fd31a85bc9ed8047dfac18d47e35937486e16/pylintfileheader-0.3.2.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }