Metadata-Version: 2.5
Name: ruff-config-generator
Version: 3.0.1
Summary: Generates ruff configuration
Project-URL: homepage, https://github.com/KRunchPL/ruff-config-generator
Project-URL: repository, https://github.com/KRunchPL/ruff-config-generator
Project-URL: documentation, https://github.com/KRunchPL/ruff-config-generator
Author-email: KRunchPL <krunchfrompoland@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.15
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.15
Requires-Dist: beautifulsoup4<5.0.0,>=4.15.0
Requires-Dist: loguru<0.8.0,>=0.7.3
Requires-Dist: pydantic<3.0.0,>=2.13.5
Requires-Dist: requests<3.0.0,>=2.34.2
Requires-Dist: typer-config<2.0.0,>=1.5.1
Requires-Dist: typer<0.28.0,>=0.27.2
Description-Content-Type: text/markdown

# Ruff Configuration Generator

Tool that generates [`ruff`](https://github.com/astral-sh/ruff) configuration with all available options.

## Usage

```console
ruff-config-generator [--config adjustments.toml]
```

The command will download the settings HTML page, analyze it, and generate two `toml` files. Both `toml` files will contain all available `ruff` options along with their descriptions. The difference between the two files is that one will have all settings set to their default values, while the other will have values adjusted according to provided config file.

For an example of `adjustments.toml` file, see `krunch_pl_config.toml` on the repository.

Output files will be saved in the `workdir` folder as `settings.html`, `default.toml` (default values) and `adjusted.toml`.

On the repository, the `workdir` folder contains result of the above command for latest ruff version I have been using.

## Additional documentation

[Development documentation](README-DEV.md)

[Changelog](CHANGELOG.md)
