https://github.com/rcbops/flake8-filename
A flake8 linter plug-in for validating that certain files comply with a user defined pattern.
https://github.com/rcbops/flake8-filename
Last synced: 8 months ago
JSON representation
A flake8 linter plug-in for validating that certain files comply with a user defined pattern.
- Host: GitHub
- URL: https://github.com/rcbops/flake8-filename
- Owner: rcbops
- License: apache-2.0
- Created: 2018-05-25T15:20:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T07:44:48.000Z (over 3 years ago)
- Last Synced: 2025-09-21T10:56:40.868Z (9 months ago)
- Language: Python
- Size: 30.3 KB
- Stars: 0
- Watchers: 44
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- License: LICENSE
Awesome Lists containing this project
README
===============
flake8-filename
===============
**This project is currently not actively maintained**
.. image:: https://img.shields.io/travis/rcbops/flake8-filename.svg
:target: https://travis-ci.org/rcbops/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
.. code-block:: ini
[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.
.. _CONTRIBUTING.rst: CONTRIBUTING.rst
.. _configuration: docs/configuration.rst
.. _violation_codes: docs/violation_codes.rst
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage