* 👷🔧📝 Switch to prek

  * Remove pre-commit

Author: veit

.github/workflows/ci.yml

@@ -12,19 +12,22 @@ concurrency:
 permissions: {}
 
 jobs:
-  pre-commit:
-    name: pre-commit
+  prek:
+    name: prek
+    # External pull requests should be checked, but not our own internal pull
+    # requests again, as these are already checked by the push on the branch.
+    # Without this if condition, the checks would be performed twice, as
+    # internal pull requests correspond to both the push and pull_request
+    # events.
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
       with:
         persist-credentials: false
-    - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
-    - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
-      with:
-        path: ~/.cache/pre-commit
-        key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
-    - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+    - uses: j178/prek-action@e98a699c41eb69ab013a45817a0406469a748f8d # v2.0.5
 
   docs:
     name: Build docs and check links

CHANGELOG.rst

@@ -16,6 +16,13 @@ emergencies when we need to start branches for older versions.
 `Unreleased <https://github.com/veit/python-basics-tutorial-de/compare/25.1.0...HEAD>`_
 ---------------------------------------------------------------------------------------
 
+Changed
+~~~~~~~
+
+* 👷🔧📝 Switch to prek
+
+  * Remove pre-commit
+
 `25.1.0 <https://github.com/veit/python-basics-tutorial/compare/24.3.0...25.1.0>`_
 ----------------------------------------------------------------------------------
 
@@ -35,7 +42,6 @@ Added
 Changed
 ~~~~~~~
 
-
 * 📝 Update cookiecutter templates
 
   * Add badges

docs/document/sphinx/test.rst

@@ -144,8 +144,8 @@ reST formatting
 Whether the :doc:`Sphinx <start>` documentation is written in valid :doc:`rest`
 format can be checked with `sphinx-lint
 <https://pypi.org/project/sphinx-lint/>`_. We usually include this in our
-:doc:`pre-commit
-<Python4DataScience:productive/git/advanced/hooks/pre-commit>` configuration:
+:doc:`prek <Python4DataScience:productive/git/advanced/hooks/prek>`
+configuration:
 
 .. code-block:: yaml
    :caption: .pre-commit-config.yaml
@@ -194,10 +194,10 @@ Code formatting
 The formatting of code blocks can be checked with `blacken-docs
 <https://github.com/adamchainz/blacken-docs>`_, which uses
 :doc:`Python4DataScience:productive/qa/black`. We usually integrate the library
-via the :doc:`pre-commit
-<Python4DataScience:productive/git/advanced/hooks/pre-commit>` framework:
+via :doc:`prek <Python4DataScience:productive/git/advanced/hooks/prek>`:
 
 .. code-block:: yaml
+   :caption: .pre-commit-config.yaml
 
    - repo: https://github.com/adamchainz/blacken-docs
      rev: 7ae9389351f4090e3993de28015a05a18ca6b8a7 # v1.12.1
@@ -310,8 +310,8 @@ You should then update your :ref:`.gitignore <gitignore>` file if necessary:
 
    styles/*
 
-You can configure Vale for the :doc:`pre-commit
-<Python4DataScience:productive/git/advanced/hooks/pre-commit>` framework with:
+You can configure Vale for :doc:`prek
+<Python4DataScience:productive/git/advanced/hooks/prek>` with:
 
 .. code-block:: yaml
    :caption: .pre-commit-config.yaml
@@ -381,8 +381,8 @@ example with
    commands =
        interrogate --quiet --fail-under 95 src tests
 
-You can also use ``interrogate`` with :doc:`pre-commit
-<Python4DataScience:productive/git/advanced/hooks/pre-commit>`:
+You can also use ``interrogate`` with :doc:`prek
+<Python4DataScience:productive/git/advanced/hooks/prek>`:
 
 .. code-block:: yaml
    :caption: .pre-commit-config.yaml

docs/packs/apps.rst

@@ -149,9 +149,8 @@ specific version.
       $ uv sync --exclude-newer-package "{PACKAGE}=P0D"
 
 .. tip::
-   You can also use the
-   :doc:`Python4DataScience:productive/git/advanced/hooks/pre-commit` to
-   regularly update your :file:`uv.lock` file:
+   You can also use :doc:`Python4DataScience:productive/git/advanced/hooks/prek`
+   to regularly update your :file:`uv.lock` file:
 
    .. code-block:: yaml
       :caption: .pre-commit-config.yaml
@@ -160,6 +159,7 @@ specific version.
         rev: 6a280ba12b7901e47757c868c8c13c6a624c9ecb # 0.11.7
         hooks:
           - id: uv-lock
+            args: ["--exclude-newer = 'P3D'", "--quiet"]
 
 Restrict platform and Python versions
 -------------------------------------

docs/packs/dataprep/pyproject.toml

@@ -31,7 +31,7 @@ License-File = [ "LICENSE" ]
 
 [dependency-groups]
 dev = [
-  "pre-commit",
+  "prek",
   { include-group = "docs" },
   { include-group = "tests" },
 ]

docs/packs/distribution.rst

@@ -317,7 +317,7 @@ Dependency groups
 
 Recursive dependency groups are also possible. For example, for ``dev`` you can
 take over all dependencies from ``docs`` and ``test`` in addition to
-``pre-commit``:
+``prek``:
 
 .. literalinclude:: dataprep/pyproject.toml
    :language: toml

docs/packs/templating/cruft.rst

@@ -79,8 +79,8 @@ Checking a project
 To see if a project has missed a template update, you can easily call ``cruft
 check``. If the project is out of date, an error and exit code 1 will be
 returned. ``cruft check`` can also be added to
-:doc:`Python4DataScience:productive/git/advanced/hooks/pre-commit` and CI
-pipelines to ensure projects don’t become unintentionally stale.
+:doc:`Python4DataScience:productive/git/advanced/hooks/prek` and CI pipelines to
+ensure projects don’t become unintentionally stale.
 
 Linking an existing project
 ---------------------------

docs/test/tox.rst

@@ -370,7 +370,7 @@ We can also call individual tests with tox by making another change so that
    [tool.tox]
    requires = [ "tox>=4" ]
    env_list = [
-     "pre-commit",
+     "prek",
      "docs",
      "py3{10-14}",
      "py{13-14}t",

pyproject.toml

@@ -25,7 +25,7 @@ urls.Homepage = "https://github.com/veit/python-basics-tutorial/"
 [dependency-groups]
 dev = [
   "codespell",
-  "pre-commit",
+  "prek",
   "vale",
   { include-group = "docs" },
 ]