Flake8 Copyright plugin
=======================
Checks for copyright notices in all python files. It runs a simple regular expression search for
strings like::
Copyright 2014 <author>
Copyright (C) 2014 <author>
``<author>`` can be anything unless you specify it with the ``copyright-author`` option (see below).
Install
-------
Install with pip::
pip install flake8-copyright
Then, activate copyright checks in your flake8 configuration with::
copyright-check = True
# C errors are not selected by default, so add them to your selection
select = E,F,W,C
Further options
---------------
copyright-min-file-size
Minimum number of characters in a file before requiring a copyright notice. This is to avoid
forcing yourself to add copyright notices to very small or empty files. Default: ``0``.
copyright-author
Checks for a specific author in the copyright notice.
copyright-regexp
If you're not happy with the regexp that is ran to look for copyright notices, you can change it
with this option. Default: ``Copyright\s+(\(C\)\s+)?\d{4}([-,]\d{4})*\s+%(author)s``. ``%(author)s`` is
replaced by the contents of ``copyright-author``.
Raw data
{
"_id": null,
"home_page": "https://github.com/savoirfairelinux/flake8-copyright",
"name": "flake8-copyright",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pep8 flake8 copyright",
"author": "Virgil Dupras",
"author_email": "virgil.dupras@savoirfairelinux.com",
"download_url": "https://files.pythonhosted.org/packages/f0/8d/2a98bea4c71203fe1cc01f36af5ac222664f816834ea5d778e0a237c5325/flake8-copyright-0.2.4.tar.gz",
"platform": null,
"description": "Flake8 Copyright plugin\n=======================\n\nChecks for copyright notices in all python files. It runs a simple regular expression search for\nstrings like::\n\n Copyright 2014 <author>\n Copyright (C) 2014 <author>\n\n``<author>`` can be anything unless you specify it with the ``copyright-author`` option (see below).\n\nInstall\n-------\n\nInstall with pip::\n\n pip install flake8-copyright\n\nThen, activate copyright checks in your flake8 configuration with::\n\n copyright-check = True\n # C errors are not selected by default, so add them to your selection\n select = E,F,W,C\n\n\nFurther options\n---------------\n\ncopyright-min-file-size\n Minimum number of characters in a file before requiring a copyright notice. This is to avoid\n forcing yourself to add copyright notices to very small or empty files. Default: ``0``.\n\ncopyright-author\n Checks for a specific author in the copyright notice.\n\ncopyright-regexp\n If you're not happy with the regexp that is ran to look for copyright notices, you can change it\n with this option. Default: ``Copyright\\s+(\\(C\\)\\s+)?\\d{4}([-,]\\d{4})*\\s+%(author)s``. ``%(author)s`` is\n replaced by the contents of ``copyright-author``.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Adds copyright checks to flake8",
"version": "0.2.4",
"split_keywords": [
"pep8",
"flake8",
"copyright"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6116e36be1703a28cb91e97aca402df49027ae3a05a6405d836a98b8dc24306",
"md5": "c766dfff231a86eefe006d6e3aa3ca68",
"sha256": "5d33d900c4183bb6748692407867229d1e5b84016a100e8899a7f58dcf52223f"
},
"downloads": -1,
"filename": "flake8_copyright-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c766dfff231a86eefe006d6e3aa3ca68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18447,
"upload_time": "2023-02-08T21:09:32",
"upload_time_iso_8601": "2023-02-08T21:09:32.257612Z",
"url": "https://files.pythonhosted.org/packages/b6/11/6e36be1703a28cb91e97aca402df49027ae3a05a6405d836a98b8dc24306/flake8_copyright-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f08d2a98bea4c71203fe1cc01f36af5ac222664f816834ea5d778e0a237c5325",
"md5": "7780b4d53d1abef4464d19f02a60f414",
"sha256": "b78491fcf575266d7e78dcfa899c876edd1c29929d247de3408bf4e3f971bf1c"
},
"downloads": -1,
"filename": "flake8-copyright-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "7780b4d53d1abef4464d19f02a60f414",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17180,
"upload_time": "2023-02-08T21:09:34",
"upload_time_iso_8601": "2023-02-08T21:09:34.565181Z",
"url": "https://files.pythonhosted.org/packages/f0/8d/2a98bea4c71203fe1cc01f36af5ac222664f816834ea5d778e0a237c5325/flake8-copyright-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 21:09:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "savoirfairelinux",
"github_project": "flake8-copyright",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "flake8-copyright"
}
JSON
