Skip to content

Commit a04ed04

Browse files
chore: Migrate to Ruff as unified linter/formatter
- Replace legacy linting/formatting stack (flake8, black, isort) with Ruff. - Add comprehensive Ruff configuration (ruff.toml). - Update documentation in README.md with new setup instructions. - Remove obsolete config files (.flake8, .isort.cfg etc.) - Clean up dependencies from old tools. - Ensure new configuration enforces same coding standards. BREAKING CHANGE: Removed all previous linter/formatter dependencies. Developers must run `pip install -r requirements.txt` to get Ruff-based setup.
1 parent ea419a5 commit a04ed04

File tree

8 files changed

+39
-53
lines changed

8 files changed

+39
-53
lines changed

.flake8

Lines changed: 0 additions & 9 deletions
This file was deleted.

.isort.cfg

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
- [📂 Step 1: Clone the Repository](#-step-1-clone-the-repository)
3131
- [🖥 Step 2: Create and activate a virtual environment](#-step-2-create-and-activate-a-virtual-environment)
3232
- [🔃 Step 3: Installing Dependencies](#-step-3-installing-dependencies)
33-
- [🛠️ Dependencies for development (dev)](#%EF%B8%8F-dependencies-for-development-dev)
34-
- [Linters](#-linters)
33+
34+
- [Code Quality](#-code-quality)
3535
- [🧩 Usage](#-usage)
3636
- [🔨 Function Signature](#-function-signature)
3737
- [📤 Example](#-example)
@@ -84,31 +84,26 @@ source venv/Scripts/activate # Windows
8484

8585
### 🔃 Step 3: Installing Dependencies
8686

87-
Dependencies are divided into two groups:
88-
89-
- **For development (dev)** – additional dependencies for development.
90-
- **For code analysis (flake8)** – additional dependencies for code analysis.
91-
92-
#### 🛠️ Dependencies for development (dev)
93-
94-
Install the dependencies for local development (they include all **flake8** dependencies)
87+
Install the dependencies for local development:
9588

9689
```bash
97-
pip install -r requirements/dev.txt
90+
pip install -r requirements.txt
9891
```
9992

100-
Now you can use the parser.
101-
10293

103-
## Linters
94+
## Code Quality
10495

105-
If there are any changes, I recommend using linters:
96+
For code consistency and quality checks, use Ruff - a unified linter/formatter:
10697

10798
```bash
99+
# Run linting checks.
100+
ruff check .
101+
102+
# Auto-fix fixable lint issues
103+
ruff check . --fix
108104

109-
flake8 . --count --show-source --statistics # Use to view PEP8 errors.
110-
black . --verbose # Use to format code.
111-
isort . --verbose # Use to format the order of imports.
105+
# Format code.
106+
ruff format .
112107
```
113108

114109

pyproject.toml

Lines changed: 0 additions & 5 deletions
This file was deleted.

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ruff==0.11.6

requirements/dev.txt

Lines changed: 0 additions & 4 deletions
This file was deleted.

requirements/flake8.txt

Lines changed: 0 additions & 11 deletions
This file was deleted.

ruff.toml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
line-length = 79
2+
exclude = ["migrations", "venv"]
3+
4+
5+
[lint]
6+
select = ["N", "F", "W", "E", "I", "Q", "TID", "COM", "C4", "ERA", "RET", "PTH", "ISC", "C90", "SIM"]
7+
8+
9+
[format]
10+
quote-style = "single"
11+
indent-style = "space"
12+
skip-magic-trailing-comma = false
13+
line-ending = "auto"
14+
15+
16+
[lint.isort]
17+
force-sort-within-sections = true
18+
19+
20+
[lint.flake8-quotes]
21+
inline-quotes = "single"
22+
23+
24+
[lint.flake8-tidy-imports]
25+
ban-relative-imports = "all"

0 commit comments

Comments
 (0)