Merge pull request #158 from eshwen/esh-use-ruff-format

Replace Black with Ruff format

.github/workflows/api-docs.yml

@@ -15,7 +15,7 @@ jobs:
       contents: 'write'
       actions: 'write'
 
-    uses: eshwen/adrenaline/.github/workflows/api-docs-build.yml@v0.2.5
+    uses: eshwen/adrenaline/.github/workflows/api-docs-build.yml@v0.3.0
     with:
       python-version: '3.10'
       changelog: 'CHANGELOG.md'

.github/workflows/quality-check.yml

@@ -14,7 +14,7 @@ concurrency:
 
 jobs:
   lint:
-    uses: eshwen/adrenaline/.github/workflows/python-quality-check.yml@v0.2.5
+    uses: eshwen/adrenaline/.github/workflows/python-quality-check.yml@v0.3.0
     with:
       python-version: '3.10'
       path: 'my_project/'

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Test
-        uses: eshwen/adrenaline/test-python@v0.2.5
+        uses: eshwen/adrenaline/test-python@v0.3.0
         with:
           python-version: '3.10'
           path: 'my_project/'

.pre-commit-config.yaml

@@ -27,15 +27,11 @@ repos:
       - id: auto-walrus
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.1.9'  # Must match requirements-dev.txt
+    rev: 'v0.1.15'  # Must match requirements-dev.txt
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix ]
-
-  - repo: https://github.com/psf/black
-    rev: 23.12.1  # Must match requirements-dev.txt
-    hooks:
-      - id: black
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.8.0  # Must match requirements-dev.txt

.vscode/settings.json

@@ -15,11 +15,6 @@
         "--ignore=E712,W503"
     ],
 
-    "python.formatting.provider": "black",
-    "python.formatting.blackArgs": [
-        "--line-length 120"
-    ],
-
     "[python]": {
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {

README.md

@@ -6,8 +6,7 @@
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 [![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://docker.com/)
 
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 [![pydocstyle](https://img.shields.io/badge/pydocstyle-enabled-AD4CD3)](http://www.pydocstyle.org/en/stable/)

docs/tooling/pipelines.md

@@ -4,7 +4,7 @@ Several pipelines are included to execute automatically on various triggers:
 
 | What                                             | When                                 | How                   |
 |--------------------------------------------------|--------------------------------------|-----------------------|
-| Check code with `black`, `ruff`, and `mypy`      | On PR creation and subsequent pushes | [quality-check.yml]   |
+| Check code with `ruff` and `mypy`                | On PR creation and subsequent pushes | [quality-check.yml]   |
 | Unit test with `pytest`                          | On PR creation and subsequent pushes | [test.yml]            |
 | Build the API documentation                      | On the creation of a new release     | [api-docs.yml]        |
 | Check for dependency updates and vulnerabilities | On a schedule (check the file)       | [dependabot.yml]      |

docs/tooling/quality.md

@@ -22,45 +22,27 @@ To automatically fix any issues, run
 ruff --fix my_project/ tests/
 ```
 
-### PyCharm integration
-
-You can also install the [Ruff plugin for PyCharm] to run it automatically on file changes. In **Preferences** |
-**Tools** | **Ruff**, configure it as you like.
-
-To aid in documentation, in PyCharm go to **Preferences** | **Tools** | **Python Integrated Tools**. Under
-**Docstrings**, select the docstring format as Google.
-
-## Black
-
-[Black] is a widely-used tool to ensure consistently-formatted code.
+Ruff now contains a formatter to replace [Black]. It ensures consistently-formatted, highly readable code.
 
-To automatically reformat your code, run
+To automatically format your code, run
 
 ```shell
-black my_project/ tests/
+ruff format my_project/ tests/
 ```
 
-To instead just show what `black` would change, run
+To instead just show what `ruff` would change, run
 
 ```shell
-black --diff my_project/ tests/
+ruff format --diff my_project/ tests/
 ```
 
 ### PyCharm integration
 
-`black` is integrated into PyCharm as of v2023.2. Go to **Settings** | **Tools** | **Black** to configure.
-
-??? tip "For older versions"
-
-    PyCharm supports file watchers, which automatically run a command when a file is saved. This is useful for
-    transparently formatting code.
-
-    To include `black` as a file watcher, go to **Settings** | **Tools** | **File Watchers** and import the
-    [watchers.xml]. This will automatically apply formatting to Python files and Jupyter notebooks. You may need to
-    edit the **Program** path to point to your `black` executable.
+You can also install the [Ruff plugin for PyCharm] to run it automatically on file changes. In **Preferences** |
+**Tools** | **Ruff**, configure it as you like.
 
-Otherwise, to set it up yourself, follow the instructions
-at <https://black.readthedocs.io/en/stable/integrations/editors.html>.
+To aid in documentation, in PyCharm go to **Preferences** | **Tools** | **Python Integrated Tools**. Under
+**Docstrings**, select the docstring format as Google.
 
 ## Mypy
 
@@ -112,8 +94,7 @@ The [.pre-commit-config.yaml] file contains hooks to run
 
 - built-in `pre-commit` checks
 - Automatic use of the walrus operator
-- `ruff` for linting (fixes fixable issues)
-- `black` for formatting (fixes fixable issues)
+- `ruff` for linting and formatting (fixes fixable issues)
 - `mypy` type-hinting errors
 - `poetry` dependency status (`poetry.lock` and requirements files are up-to-date)
 
@@ -132,8 +113,6 @@ pre-commit run -a
 
 [pyproject.toml]: https://github.com/eshwen/ds-python-boilerplate/blob/main/pyproject.toml
 
-[watchers.xml]: https://github.com/eshwen/ds-python-boilerplate/blob/main/pycharm/watchers.xml
-
 [pre-commit]: https://pre-commit.com/
 
 [Ruff]: https://beta.ruff.rs/docs/

pyproject.toml

@@ -48,8 +48,7 @@ PyYAML = "*"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.3.3"
-black = { version = "^23.12.1", extras = ["jupyter"] }
-ruff = "^0.1.9"
+ruff = "^0.1.15"
 
 # Type hinting
 mypy = "^1.8.0"
@@ -78,10 +77,6 @@ mkdocs-literate-nav = "^0.6.1"
 mkdocs-section-index = "^0.3.8"
 git-changelog = "^2.4.0"
 
-[tool.black]
-target-version = ['py310']
-line-length = 120
-
 [tool.mypy]
 python_version = "3.10"
 warn_return_any = true
@@ -135,6 +130,12 @@ extend-exclude = [
     "D103", # D103 complains when there is no docstring in a function
 ]
 
+[tool.ruff.format]
+# Like Black
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
 
 [tool.ruff.pydocstyle]
 convention = "google"