=========================
Flake8 __author__ Checker
=========================
|PyPI Version| |Python Versions|
``flake8-author`` is a `Flake8 <http://flake8.pycqa.org/>`_ extension that
checks Python modules for module-level ``__author__`` attributes.
There is no official standard on ``__author__`` usage. It is used largely by
convention. Guido had this to say `back in 2001`__:
Anothor source of discomfort is that there's absolutely no standard for
this kind of meta-data variables. We've got __version__, and I believe we
once agreed on that (in 1994 or so :-). But __author__? __credits__?
What next -- __cute_signoff__?
__ https://mail.python.org/pipermail/python-dev/2001-March/013328.html
This extension can therefore be configured to explicitly require or forbid
``__author__`` attributes. By default, ``__author__`` is considered optional.
If the ``__author__`` attribute is allowed, its value can also be validated
using a configurable regular expression pattern.
The ``__author__`` attribute is generally assigned to a string, but multiple
authors can be listed using a list (or tuple or set) of strings.
.. |PyPI Version| image:: https://img.shields.io/pypi/v/flake8-author.svg
:target: https://pypi.python.org/pypi/flake8-author
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/flake8-author.svg
:target: https://pypi.python.org/pypi/flake8-author
Installation
------------
Install from PyPI using ``pip``:
.. code-block:: sh
$ pip install flake8-author
The extension will be activated automatically by ``flake8``. You can verify
that it has been loaded by inspecting the ``flake8 --version`` string.
.. code-block:: sh
$ flake8 --version
6.1.0 (author: 2.1.0, ...) CPython 3.11.5 on Darwin
Error Codes
-----------
This extension adds three new `error codes`__ (using the ``A40`` prefix):
- ``A400``: a module-level ``__author__`` attribute is required
- ``A401``: ``__author__`` attributes are not allowed
- ``A402``: ``__author__`` attribute value does not match *pattern*
__ http://flake8.pycqa.org/en/latest/user/error-codes.html
Configuration
-------------
Configuration values are specified in the ``[flake8]`` section of your `config
file`_ or as command line arguments (e.g. ``--author-attribute=required``).
- ``author-attribute``: "optional", "required", "forbidden" (default: optional)
- ``author-pattern``: ``__author__`` validation `re`_ pattern (default: ``''``)
.. _config file: http://flake8.pycqa.org/en/latest/user/configuration.html
.. _re: https://docs.python.org/library/re.html
Copyright (c) 2016 Jon Parise
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Changes
=======
2.1.0 (2023-09-17)
------------------
* Drop support for Python 3.7, and add 3.11.
* Multiple authors can be listed by setting the ``__author__`` attribute to a
list (or tuple or set) of strings. Each entry will be validated against the
configured pattern.
2.0.0 (2021-12-30)
------------------
* Drop support for Python 2.7 and 3.6, and add 3.10.
* Drop support for flake8 2.x versions.
1.2.0 (2020-10-12)
------------------
* Drop Python 3.5 support and add versions 3.8 and 3.9.
* Minor documentation improvements.
1.1.4 (2017-07-29)
------------------
* Minor code and packaging cleanup.
1.1.3 (2017-07-28)
------------------
* Drop the ``setup_requires`` dependency on flake8.
1.1.2 (2017-01-12)
------------------
* Only apply the author regular expression pattern check when a pattern has
actually been configured.
1.1.1 (2016-11-06)
------------------
* Fix configuration file parsing for flake8 3.0+.
1.1.0 (2016-08-15)
------------------
* Support flake8 3.0.0 (required for development)
1.0.2 (2016-06-02)
------------------
* Support flake8 version 2.6.0
* Drop test dependency on pytest (development only)
1.0.1 (2016-05-11)
------------------
* Fixed parser validation for configuration-based options
1.0.0 (2016-04-30)
------------------
* Initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/jparise/flake8-author",
"name": "flake8-author",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "flake8 __author__",
"author": "Jon Parise",
"author_email": "jon@indelible.org",
"download_url": "https://files.pythonhosted.org/packages/40/bd/30d8a6b862ccf930ec2918959503d814a3d169b5dd262b142f1b1b59c4c6/flake8-author-2.1.0.tar.gz",
"platform": null,
"description": "=========================\nFlake8 __author__ Checker\n=========================\n\n|PyPI Version| |Python Versions|\n\n``flake8-author`` is a `Flake8 <http://flake8.pycqa.org/>`_ extension that\nchecks Python modules for module-level ``__author__`` attributes.\n\nThere is no official standard on ``__author__`` usage. It is used largely by\nconvention. Guido had this to say `back in 2001`__:\n\n Anothor source of discomfort is that there's absolutely no standard for\n this kind of meta-data variables. We've got __version__, and I believe we\n once agreed on that (in 1994 or so :-). But __author__? __credits__?\n What next -- __cute_signoff__?\n\n__ https://mail.python.org/pipermail/python-dev/2001-March/013328.html\n\nThis extension can therefore be configured to explicitly require or forbid\n``__author__`` attributes. By default, ``__author__`` is considered optional.\n\nIf the ``__author__`` attribute is allowed, its value can also be validated\nusing a configurable regular expression pattern.\n\nThe ``__author__`` attribute is generally assigned to a string, but multiple\nauthors can be listed using a list (or tuple or set) of strings.\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/flake8-author.svg\n :target: https://pypi.python.org/pypi/flake8-author\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/flake8-author.svg\n :target: https://pypi.python.org/pypi/flake8-author\n\n\nInstallation\n------------\n\nInstall from PyPI using ``pip``:\n\n.. code-block:: sh\n\n $ pip install flake8-author\n\nThe extension will be activated automatically by ``flake8``. You can verify\nthat it has been loaded by inspecting the ``flake8 --version`` string.\n\n.. code-block:: sh\n\n $ flake8 --version\n 6.1.0 (author: 2.1.0, ...) CPython 3.11.5 on Darwin\n\n\nError Codes\n-----------\n\nThis extension adds three new `error codes`__ (using the ``A40`` prefix):\n\n- ``A400``: a module-level ``__author__`` attribute is required\n- ``A401``: ``__author__`` attributes are not allowed\n- ``A402``: ``__author__`` attribute value does not match *pattern*\n\n__ http://flake8.pycqa.org/en/latest/user/error-codes.html\n\nConfiguration\n-------------\n\nConfiguration values are specified in the ``[flake8]`` section of your `config\nfile`_ or as command line arguments (e.g. ``--author-attribute=required``).\n\n- ``author-attribute``: \"optional\", \"required\", \"forbidden\" (default: optional)\n- ``author-pattern``: ``__author__`` validation `re`_ pattern (default: ``''``)\n\n.. _config file: http://flake8.pycqa.org/en/latest/user/configuration.html\n.. _re: https://docs.python.org/library/re.html\n\nCopyright (c) 2016 Jon Parise\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nChanges\n=======\n\n2.1.0 (2023-09-17)\n------------------\n\n* Drop support for Python 3.7, and add 3.11.\n* Multiple authors can be listed by setting the ``__author__`` attribute to a\n list (or tuple or set) of strings. Each entry will be validated against the\n configured pattern.\n\n2.0.0 (2021-12-30)\n------------------\n\n* Drop support for Python 2.7 and 3.6, and add 3.10.\n* Drop support for flake8 2.x versions.\n\n1.2.0 (2020-10-12)\n------------------\n\n* Drop Python 3.5 support and add versions 3.8 and 3.9.\n* Minor documentation improvements.\n\n1.1.4 (2017-07-29)\n------------------\n\n* Minor code and packaging cleanup.\n\n1.1.3 (2017-07-28)\n------------------\n\n* Drop the ``setup_requires`` dependency on flake8.\n\n1.1.2 (2017-01-12)\n------------------\n\n* Only apply the author regular expression pattern check when a pattern has\n actually been configured.\n\n1.1.1 (2016-11-06)\n------------------\n\n* Fix configuration file parsing for flake8 3.0+.\n\n1.1.0 (2016-08-15)\n------------------\n\n* Support flake8 3.0.0 (required for development)\n\n\n1.0.2 (2016-06-02)\n------------------\n\n* Support flake8 version 2.6.0\n* Drop test dependency on pytest (development only)\n\n\n1.0.1 (2016-05-11)\n------------------\n\n* Fixed parser validation for configuration-based options\n\n\n1.0.0 (2016-04-30)\n------------------\n\n* Initial release\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flake8 __author__ checker",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/jparise/flake8-author",
"Issue Tracker": "https://github.com/jparise/flake8-author/issues",
"Source Code": "https://github.com/jparise/flake8-author"
},
"split_keywords": [
"flake8",
"__author__"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "831d228a8bed55829c67cef94ea36619c07b7b2731693d9cf4cdf5e89be4dabb",
"md5": "3fb5e28205d3aeeeb12edc26ae69ed09",
"sha256": "926bbf36d2b4266c48b0829bd20ae872ea72e2280090c08eed8c337c0b70cc53"
},
"downloads": -1,
"filename": "flake8_author-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fb5e28205d3aeeeb12edc26ae69ed09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6141,
"upload_time": "2023-09-18T02:55:59",
"upload_time_iso_8601": "2023-09-18T02:55:59.068770Z",
"url": "https://files.pythonhosted.org/packages/83/1d/228a8bed55829c67cef94ea36619c07b7b2731693d9cf4cdf5e89be4dabb/flake8_author-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "40bd30d8a6b862ccf930ec2918959503d814a3d169b5dd262b142f1b1b59c4c6",
"md5": "3cbf54b3a1bf0b96eedb74a332786fb0",
"sha256": "47494a19d8b8c7e95fcc24c0b1df06c1946053f0ae248334d2e54eebdb1f0136"
},
"downloads": -1,
"filename": "flake8-author-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3cbf54b3a1bf0b96eedb74a332786fb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6275,
"upload_time": "2023-09-18T02:56:00",
"upload_time_iso_8601": "2023-09-18T02:56:00.741750Z",
"url": "https://files.pythonhosted.org/packages/40/bd/30d8a6b862ccf930ec2918959503d814a3d169b5dd262b142f1b1b59c4c6/flake8-author-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-18 02:56:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jparise",
"github_project": "flake8-author",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "flake8-author"
}
JSON
