Skip to content

Commit b57d7bd

Browse files
authored
chore: switch to Ruff formatter
1 parent ec2a6a7 commit b57d7bd

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ Project template for a Python Package using Copier.
1212
- Testing with Pytest using GitHub actions.
1313
- Packaging powered by [poetry].
1414
- Optionally generates a CLI entry point powered by [Typer] and [Rich].
15-
- Follows the [black] style guide.
16-
- Uses [Ruff] for linting.
17-
- Comes with [pre-commit] hook config for [black] and [Ruff].
15+
- Uses [Ruff] for formatting and linting.
16+
- Comes with [pre-commit] hook config for [Ruff].
1817
- Style guide enforced on CI.
1918
- Dependencies kept up to date by [Renovate].
2019
- Follow the [all-contributors] specification.
@@ -58,8 +57,8 @@ When you first push to GitHub, it'll start a `ci` GitHub workflow that you can s
5857

5958
- The `test` job will run your test suite with Pytest against all Python version from 3.8 to 3.11
6059
- A few things will run in the lint job:
61-
- black in check mode
62-
- Ruff with several flake8 plugins, isort and pyupgrade plugins.
60+
- Ruff format
61+
- Ruff lint with several flake8, isort and pyupgrade plugins.
6362

6463
A `labels` workflow will also run and synchronise the GitHub labels based on the `.github/labels.toml` file.
6564

@@ -142,7 +141,6 @@ This project follows the [all-contributors](https://github.com/all-contributors/
142141
[poetry]: https://python-poetry.org
143142
[Typer]: https://typer.tiangolo.com
144143
[Rich]: https://rich.readthedocs.io
145-
[black]: https://github.com/psf/black
146144
[Ruff]: https://pypi.org/project/ruff/
147145
[pre-commit]: https://pre-commit.com/
148146
[renovate]: https://docs.renovatebot.com/

project/README.md.jinja

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
<a href="https://python-poetry.org/">
1818
<img src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" alt="Poetry">
1919
</a>
20-
<a href="https://github.com/ambv/black">
21-
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
20+
<a href="https://github.com/astral-sh/ruff">
21+
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
2222
</a>
2323
<a href="https://github.com/pre-commit/pre-commit">
2424
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">

0 commit comments

Comments
 (0)