| Name | flake8-author JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | None |
| Summary | Flake8 __author__ checker |
| upload_time | 2025-07-08 13:02:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
flake8
__author__
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=========================
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
Raw data
{
"_id": null,
"home_page": null,
"name": "flake8-author",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "flake8, __author__",
"author": null,
"author_email": "Jon Parise <jon@indelible.org>",
"download_url": "https://files.pythonhosted.org/packages/95/2a/d21c8a979d76c808e3d40b310b28f094b10d55d8d04093e996f8e557bddf/flake8_author-2.2.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",
"bugtrack_url": null,
"license": null,
"summary": "Flake8 __author__ checker",
"version": "2.2.0",
"project_urls": {
"Changelog": "https://github.com/jparise/flake8-author/blob/main/CHANGELOG.rst",
"Homepage": "https://github.com/jparise/flake8-author",
"Issues": "https://github.com/jparise/flake8-author/issues",
"Repository": "https://github.com/jparise/flake8-author"
},
"split_keywords": [
"flake8",
" __author__"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "782d0ae1b6297ba435bb0f75ada60306fc67ec239c5006b303d68442eddd11cd",
"md5": "c87effa90cf3f418983276e4c2284e49",
"sha256": "183bd80499214334aefe2b6406f6b9a2389f75d43b05cc1ddadbbdb6f5dd3503"
},
"downloads": -1,
"filename": "flake8_author-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c87effa90cf3f418983276e4c2284e49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5032,
"upload_time": "2025-07-08T13:02:30",
"upload_time_iso_8601": "2025-07-08T13:02:30.897765Z",
"url": "https://files.pythonhosted.org/packages/78/2d/0ae1b6297ba435bb0f75ada60306fc67ec239c5006b303d68442eddd11cd/flake8_author-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "952ad21c8a979d76c808e3d40b310b28f094b10d55d8d04093e996f8e557bddf",
"md5": "53c74efafd184d58d33f596bdcdc6c61",
"sha256": "72504c616b4fb96826ee16e2c7be7e86f85eb9756d1afb10f84897ba28ed0005"
},
"downloads": -1,
"filename": "flake8_author-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "53c74efafd184d58d33f596bdcdc6c61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5669,
"upload_time": "2025-07-08T13:02:32",
"upload_time_iso_8601": "2025-07-08T13:02:32.140413Z",
"url": "https://files.pythonhosted.org/packages/95/2a/d21c8a979d76c808e3d40b310b28f094b10d55d8d04093e996f8e557bddf/flake8_author-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 13:02:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jparise",
"github_project": "flake8-author",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flake8-author"
}
