Skip to content

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

License

Notifications You must be signed in to change notification settings

rcbops/flake8-filename

Repository files navigation

flake8-filename

This project is currently not actively maintained

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-]+$
  1. 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.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published