Skip to content

Commit 0966cdf

Browse files
committed
README: Update after Ruff introduction
Close #75 Fixup issue #71 (drop poetry)
1 parent 2251a8b commit 0966cdf

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,17 @@ Read [here](https://www.butterfly.com.au/blog/website-development/clean-high-qua
4040
- can catch even duplicate code in different files! 🙌
4141
- helps you to start refactoring before your code becomes too messy
4242

43-
- [Flake8](http://flake8.readthedocs.io)
44-
- helps to write standard, clean, and documented code
45-
- wraps pep8, pyflakes, McCabe Complexity analysis
46-
- supports plugins
47-
48-
- [Isort](https://pycqa.github.io/isort/)
49-
- Keep imports sorted alphabetically and grouped (standard, third party, local)
43+
- [Ruff](https://github.com/astral-sh/ruff): an extremely fast Python linter and code formatter, written in Rust. Ruff can be used to replace Flake8 (plus dozens of plugins), Black, isort, pydocstyle, pyupgrade, autoflake, and more, all while executing tens or hundreds of times faster than any individual tool.
44+
- ⚡️ 10-100x faster than existing linters (like Flake8) and formatters (like Black)
45+
- 🐍 Installable via pip
46+
- 🛠️ pyproject.toml support
47+
- 🤝 Python 3.13 compatibility
48+
- ⚖️ Drop-in parity with Flake8, isort, and Black
49+
- 📦 Built-in caching, to avoid re-analyzing unchanged files
50+
- 🔧 Fix support, for automatic error correction (e.g., automatically remove unused imports)
51+
- 📏 Over 800 built-in rules, with native re-implementations of popular Flake8 plugins, like - flake8-bugbear
52+
- ⌨️ First-party editor integrations for VS Code and more
53+
- 🌎 Monorepo-friendly, with hierarchical and cascading configuration
5054

5155
- [MkDocs](https://www.mkdocs.org/)
5256
- generates html documentation
@@ -57,13 +61,6 @@ Read [here](https://www.butterfly.com.au/blog/website-development/clean-high-qua
5761
- `pip-sync` installs from requirements.txt
5862
- You can also have dev-requirements if you want
5963

60-
- [Poetry](https://python-poetry.org/)
61-
- Poetry comes with all the tools you might need to manage your projects in a deterministic way
62-
- Dependency resolver, isolation, cli
63-
- Check the state of your dependencies
64-
- Easily build and package your projects with a single command
65-
- Make your work known by publishing it to PyPI
66-
6764
- [just](https://github.com/casey/just)
6865
- rules them all together in your workflow
6966
- `just check` to make sure everything is OK
@@ -74,7 +71,6 @@ Read [here](https://www.butterfly.com.au/blog/website-development/clean-high-qua
7471

7572
- [Git](https://git-scm.com)
7673
- [Python3](https://docs.python.org/3/)
77-
- [Poetry](https://python-poetry.org/)
7874
- [just](https://github.com/casey/just)
7975

8076
## Usage
@@ -103,9 +99,9 @@ checks, pedantic):
10399

104100
just install-hooks
105101

106-
To install hook to black-format code before commit:
102+
To install hook to check code when commit:
107103

108-
just black-hook
104+
just ruff-hook
109105

110106
### Badges
111107

0 commit comments

Comments
 (0)