Skip to main content

Convert existing Flake8 configuration to Ruff.

Project description

flake8-to-ruff

Convert existing Flake8 configuration files (setup.cfg, tox.ini, or .flake8) for use with Ruff.

Generates a Ruff-compatible pyproject.toml section.

Installation and Usage

Installation

Available as flake8-to-ruff on PyPI:

pip install flake8-to-ruff

Usage

To run Ruff, try any of the following:

flake8-to-ruff path/to/setup.cfg
flake8-to-ruff path/to/tox.ini
flake8-to-ruff path/to/.flake8

Limitations

  1. Ruff only supports a subset of the Flake configuration options. flake8-to-ruff will warn on and ignore unsupported options in the .flake8 file (or equivalent). (Similarly, Ruff has a few configuration options that don't exist in Flake8.)
  2. Ruff will omit any error codes that are unimplemented or unsupported by Ruff, including error codes from unsupported plugins. (See the Ruff README for the complete list of supported plugins.)
  3. flake8-to-ruff does not auto-detect your Flake8 plugins, so any reliance on Flake8 plugins that implicitly enable third-party checks will be ignored. Instead, add those error codes to your select or extend-select fields, so that flake8-to-ruff can pick them up.

License

MIT

Contributing

Contributions are welcome and hugely appreciated. To get started, check out the contributing guidelines.

Project details


Download files

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

Source Distribution

flake8_to_ruff-0.0.93.dev0.tar.gz (219.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_to_ruff-0.0.93.dev0-py3-none-macosx_10_7_x86_64.whl (652.9 kB view details)

Uploaded Python 3macOS 10.7+ x86-64

File details

Details for the file flake8_to_ruff-0.0.93.dev0.tar.gz.

File metadata

  • Download URL: flake8_to_ruff-0.0.93.dev0.tar.gz
  • Upload date:
  • Size: 219.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/0.13.2

File hashes

Hashes for flake8_to_ruff-0.0.93.dev0.tar.gz
Algorithm Hash digest
SHA256 9c077d383d1aea08059708696a858b31989503cc02d7772afe4148c73922720c
MD5 09fef58760e1bf3775075c39d86c06f8
BLAKE2b-256 fb532ddad9034f72cd3a1d94f503faa639d602016ed8a209e52f52c01d75487c

See more details on using hashes here.

File details

Details for the file flake8_to_ruff-0.0.93.dev0-py3-none-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for flake8_to_ruff-0.0.93.dev0-py3-none-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 d5c2373aec9d942552787020afb2ea5f942615120e16aee704c9623930e9d43d
MD5 de16d4428829534537aa53cd478f4c80
BLAKE2b-256 725f04a9f2f279848c8535eeffc473646f5da16527511341e80bedf9f3d7eff5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page