cclauss / flake8-filename

A flake8 linter plug-in for validating that certain files comply with a user defined pattern.

flake8-filename

A flake8 linter plug-in for validating that certain Python files comply with a user defined pattern.

Quick Start Guide

1. Install flake8-filename from PyPI with pip:

   $ pip install flake8-filename

2. Configure a mark that you would like to validate:

   $ cd project_root/
   $ vi .flake8

[flake8]
filename_check1 = filter_regex=test_.+
                  filename_regex=test_[\w-]+$

3. Run flake8:

   $ flake8 tests/

Gotchas

1. It is highly recommended to use this plugin inside of a virtualenv
2. A configuration is required by this plugin, if none is found the plugin will throw a N401 validation error for every file

Violation Codes

All possible violation codes are documented in violation_codes

Example Configurations

More example configurations can be found in configuration

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.