Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Flake8 __author__ checker

Project Description

Build Status PyPI Version Python Versions

flake8-author is a Flake8 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__?

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.

Installation

Install from PyPI using pip:

$ 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.

$ flake8 --version
3.4.1 (author: 1.1.4, mccabe: 0.6.1, pycodestyle: 2.3.1, pyflakes: 1.5.0) CPython 2.7.13 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

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: '')

Changes

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

Release history Release notifications

This version
History Node

1.1.4

History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
flake8_author-1.1.4-py2-none-any.whl (7.0 kB) Copy SHA256 hash SHA256 Wheel py2 Jul 30, 2017
flake8_author-1.1.4-py3-none-any.whl (7.0 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 31, 2017
flake8-author-1.1.4.tar.gz (5.7 kB) Copy SHA256 hash SHA256 Source None Jul 30, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page