Convert existing Flake8 configuration files (setup.cfg, tox.ini, or .flake8) for use with
Ruff.
Generates a Ruff-compatible pyproject.toml section.
Available as flake8-to-ruff on PyPI:
pip install flake8-to-ruffTo run flake8-to-ruff:
flake8-to-ruff path/to/setup.cfg
flake8-to-ruff path/to/tox.ini
flake8-to-ruff path/to/.flake8flake8-to-ruff will print the relevant pyproject.toml sections to standard output, like so:
[tool.ruff]
exclude = [
'.svn',
'CVS',
'.bzr',
'.hg',
'.git',
'__pycache__',
'.tox',
'.idea',
'.mypy_cache',
'.venv',
'node_modules',
'_state_machine.py',
'test_fstring.py',
'bad_coding2.py',
'badsyntax_*.py',
]
select = [
'A',
'E',
'F',
'Q',
]
ignore = []
[tool.ruff.flake8-quotes]
inline-quotes = 'single'
[tool.ruff.pep8-naming]
ignore-names = [
'foo',
'bar',
]flake8-to-ruff will attempt to infer any activated plugins based on the settings provided in your
configuration file.
For example, if your .flake8 file includes a docstring-convention property, flake8-to-ruff
will enable the appropriate flake8-docstrings
checks.
Alternatively, you can manually specify plugins on the command-line:
flake8-to-ruff path/to/.flake8 --plugin flake8-builtins --plugin flake8-quotes- Ruff only supports a subset of the Flake configuration options.
flake8-to-ruffwill warn on and ignore unsupported options in the.flake8file (or equivalent). (Similarly, Ruff has a few configuration options that don't exist in Flake8.) - Ruff will omit any rule codes that are unimplemented or unsupported by Ruff, including rule codes from unsupported plugins. (See the Ruff README for the complete list of supported plugins.)
MIT
Contributions are welcome and hugely appreciated. To get started, check out the contributing guidelines.