Skip to content

Commit 69a378e

Browse files
refactor: Update README.md.
1 parent 956ddd9 commit 69a378e

File tree

2 files changed

+52
-2
lines changed

2 files changed

+52
-2
lines changed

.flake8

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
[flake8]
22
max-line-length = 79
33
import-order-style = google
4-
exclude = */migrations/, venv/, env/, venv, .git, __pycache__
4+
exclude =
5+
*/migrations/,
6+
venv/,
7+
.git,
8+
__pycache__
59
max-complexity = 10
610
max-expression-complexity = 7
711

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1-
# linters
1+
# Python Linters Configuration
2+
3+
This repository contains a set of configurations for linters and formatters that I use in my Python projects. It includes configurations for **flake8** (with a range of plugins), **Black**, and **isort**. These linters helps ensure a consistent code style and improve code quality across projects.
4+
5+
## Repository Structure
6+
7+
- **requirements/flake8-plugins.txt**
8+
List of dependencies for flake8 plugins:
9+
- flake8-absolute-import==1.0.0.2
10+
- flake8-bugbear==24.8.19
11+
- flake8-clean-block==0.1.2
12+
- flake8-commas==4.0.0
13+
- flake8-eradicate==1.5.0
14+
- flake8-expression-complexity==0.0.11
15+
- flake8-implicit-str-concat==0.5.0
16+
- flake8-print==5.0.0
17+
- flake8-quotes==3.4.0
18+
- flake8-return==1.2.0
19+
- flake8-use-pathlib==0.3.0
20+
- pep8-naming==0.14.1
21+
22+
- **requirements/linters**
23+
Dependency file for the main tools:
24+
- black==24.8.0
25+
- flake8==7.1.1
26+
- isort==5.13.2
27+
28+
- **.flake8**
29+
flake8 configuration:
30+
- Maximum line length: 79 characters
31+
- Import order style: google
32+
- Excluded directories: `*/migrations/`, `venv/`, `.git`, `__pycache__`
33+
- Complexity limits: `max-complexity = 10`, `max-expression-complexity = 7`
34+
- The flake8-quotes plugin is set to use single quotes
35+
36+
- **.isort.cfg**
37+
Configuration for sorting imports with the Black profile:
38+
- Excluded directories: `migrations`, `venv/`
39+
- Line length: 79 characters
40+
- Enforce sorting within sections
41+
42+
- **pyproject.toml**
43+
Configuration for Black:
44+
- Maximum line length: 79 characters
45+
- String normalization disabled
46+
- Target Python version: py313
47+
- Excluded directory: `.venv`

0 commit comments

Comments
 (0)