🔧 📝 Switch to dependency groups

* Update README
* Update readthedocs config
* Update GitHub workflow

Author: veit

.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
       run: |
         uv venv
         echo "$PWD/.venv/bin" >> $GITHUB_PATH
-        uv pip install -e ".[docs]"
+        uv pip install --group=docs
     - name: Build HTML and check links
       run: |
         make html

.readthedocs.yaml

@@ -13,6 +13,10 @@ build:
     - plantuml
   tools:
     python: "3.12"
+  jobs:
+    install:
+      - python -m pip install --upgrade pip
+      - python -m pip install --group=docs
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -22,11 +26,3 @@ sphinx:
 formats:
   - epub
   - pdf
-
-# Optionally declare the Python requirements required to build your docs
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs

README.rst

@@ -49,7 +49,7 @@ Installation
       $ python3 -m venv .venv
       $ . .venv/bin/activate
       $ python -m pip install --upgrade pip
-      $ python -m pip install -e ".[dev]"
+      $ python -m pip install --group dev
 
    … on Windows:
 
@@ -58,7 +58,7 @@ Installation
       C:> py -m venv .venv
       C:> .\.venv\Scripts\activate.bat
       C:> python -m pip install --upgrade pip
-      C:> python -m pip install -e ".[dev]"
+      C:> python -m pip install --group dev
 
 #. Create HTML documentation:
 

docs/document/sphinx/test.rst

@@ -101,13 +101,13 @@ whether the documentation is being built and the links are valid. In
    [testenv:docs]
    # Keep base_python in sync with ci.yml and .readthedocs.yaml.
    base_python = py312
-   extras = docs
+   dependency_groups = docs
    commands =
      sphinx-build -n -T -W -b html -d {envtmpdir}/doctrees docs docs/_build/html
 
    [testenv:docs-linkcheck]
    base_python = {[testenv:docs]base_python}
-   extras = {[testenv:docs]extras}
+   dependency_groups = docs
    commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/html
 
 You can then define the following jobs for GitHub, for example:
@@ -300,7 +300,7 @@ example:
    :caption: pyproject.toml
    :emphasize-lines: 4, 8-
 
-   [project.optional-dependencies]
+   [dependency-groups]
    tests = [
        "coverage[toml]",
        "interrogate",

docs/packs/dataprep/pyproject.toml

@@ -21,7 +21,7 @@ dependencies = [
     "pandas",
 ]
 
-[project.optional-dependencies]
+[dependency-groups]
 tests = [
     "coverage[toml]",
     "pytest>=6.0",
@@ -33,8 +33,9 @@ docs = [
     "sphinx_inline_tabs"
 ]
 dev = [
-    "dataprep[tests, docs]",
-    "pre-commit"
+    {include-group = "tests"},
+    {include-group = "docs"},
+    "pre-commit",
 ]
 
 [project.urls]

docs/packs/distribution.rst

@@ -253,28 +253,28 @@ as:
      <https://packaging.python.org/en/latest/specifications/pyproject-toml/#declaring-project-metadata-the-project-table>`_
    * :pep:`345`
 
-Optional dependencies
-~~~~~~~~~~~~~~~~~~~~~
+Dependency groups
+~~~~~~~~~~~~~~~~~
 
-``project.optional-dependencies``
-    allows you to specify optional dependencies for your package. You can also
+``dependency-groups``
+    allows you to specify dependency groups for your package. You can also
     distinguish between different sets:
 
 .. literalinclude:: dataprep/pyproject.toml
    :language: toml
    :lines: 24-34
    :lineno-start: 34
 
-Recursive optional dependencies are also possible with pip ≥ 21.2. For example,
-for ``dev`` you can take over all dependencies from ``docs`` and ``test`` in
-addition to ``pre-commit``:
+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``:
 
 .. literalinclude:: dataprep/pyproject.toml
    :language: toml
    :lines: 35-39
    :lineno-start: 35
 
-You can install these optional dependencies, for example with:
+You can install these dependency groups, for example with:
 
 .. tab:: Linux/macOS
 
@@ -284,7 +284,7 @@ You can install these optional dependencies, for example with:
       $ python3 -m venv .venv
       $ . .venv/bin/activate
       $ python -m pip install --upgrade pip
-      $ python -m pip install -e ".[dev]"
+      $ python -m pip install --group dev
 
 .. tab:: Windows
 
@@ -294,7 +294,12 @@ You can install these optional dependencies, for example with:
       > python3 -m venv .venv
       > .venv\Scripts\activate.bat
       > python -m pip install --upgrade pip
-      > python -m pip install -e ".[dev]"
+      > python -m pip install --group dev
+
+.. seealso::
+   * :pep:`735`
+   * `Dependency Groups
+     <https://packaging.python.org/en/latest/specifications/dependency-groups/>`_
 
 :file:`src` package
 -------------------

docs/test/tox.rst

@@ -99,13 +99,13 @@ Before you can run tox, you must ensure that you have installed tox-uv:
 
    .. code-block:: console
 
-      $ uv sync --extra dev
+      $ uv sync --group dev
 
 .. tab:: Windows
 
    .. code-block:: ps1con
 
-      C:> uv sync --extra dev
+      C:> uv sync --group dev
 
 To run tox, simply start tox:
 
@@ -348,8 +348,7 @@ We can also call individual tests with tox by making another change so that
    skip_missing_interpreters = True
 
    [testenv]
-   extras =
-     tests: tests
+   dependency_groups = tests
    deps =
      tests: coverage[toml]
    allowlist_externals = coverage
@@ -564,17 +563,16 @@ You can install ``tox`` and ``tox-uv`` with:
 
 If you want to use ``uv sync`` with a ``uv.lock`` file for a Tox environment,
 you must change the runner for this Tox environment to ``uv-venv-lock-runner``.
-You should also use the extras configuration in such environments to instruct
-``uv`` to install the specified extras, for example:
+You should also use the dependency_groups configuration in such environments
+to instruct ``uv`` to install the specified dependency group, for example:
 
 .. code-block:: ini
    :caption: tox.ini
 
    [testenv]
    runner = uv-venv-lock-runner
-   extras =
-       dev
+   dependency_groups = dev
    commands = pytest
 
 ``dev`` uses the ``uv-venv-lock-runner`` and uses ``uv sync`` to install
-dependencies in the environment with the ``dev`` extras.
+dependencies in the environment with the ``dev`` dependency group.

pyproject.toml

@@ -14,7 +14,7 @@ classifiers = [
 ]
 dependencies = []
 
-[project.optional-dependencies]
+[dependency-groups]
 docs = [
     "furo",
     "ipython",
@@ -31,7 +31,7 @@ docs = [
 ]
 
 dev = [
-    "python-basics-tutorial[docs]",
+    { include-group = "docs" },
     "pre-commit",
     "codespell",
     "vale"