Skip to content

Commit

Permalink
chore: update README on ruff
Browse files Browse the repository at this point in the history
refs: ATV-201
  • Loading branch information
voneiden committed Dec 31, 2024
1 parent 28b027b commit 3d1668a
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,15 @@ The project is now running at [localhost:8000](http://localhost:8000)

## Code format

This project uses
[`black`](https://github.com/ambv/black),
[`flake8`](https://gitlab.com/pycqa/flake8) and
[`isort`](https://github.com/timothycrosley/isort)
for code formatting and quality checking. Project follows the basic
black config, without any modifications.

Basic `black` commands:
This project uses [Ruff](https://docs.astral.sh/ruff/) for code formatting and quality checking.

* To let `black` do its magic: `black .`
* To see which files `black` would change: `black --check .`
Basic `ruff` commands:

* lint: `ruff check`
* apply safe lint fixes: `ruff check --fix`
* check formatting: `ruff format --check`
* format: `ruff format`

[`pre-commit`](https://pre-commit.com/) can be used to install and
run all the formatting tools as git hooks automatically before a
Expand Down

0 comments on commit 3d1668a

Please sign in to comment.