chore(dev): move to Rye instead of PDM (#420)

* test: re-add opencv-python

* chore(dev): move to Rye instead of PDM

* try fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: build backend

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: string quotes?

* small fixes

* upgrade typing

* fix(ci): rye install on Windows

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix(ci): typos

* fix

* fix(ci): actually use right python version

* fix(deps): manimgl

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix docs

* another fix

* cleanup

* make sure to use trusted publisher

* chore(docs): remove PDM

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jeertmans

.github/workflows/publish.yml

@@ -18,15 +18,22 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    - name: Install PDM
-      uses: pdm-project/setup-pdm@v4
-      with:
-        python-version: '3.10'
-        cache: true
+    - name: Setup Rye
+      env:
+        RYE_INSTALL_OPTION: --yes
+      run: |
+        curl -sSf https://rye-up.com/get | bash
+        echo "$HOME/.rye/shims" >> $GITHUB_PATH
+
+    - name: Configure Rye
+      run: rye config --set-bool behavior.use-uv=true
+
+    - name: Build package
+      run: rye build
 
     - name: Publish to PyPI
       if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-      run: pdm publish
+      uses: pypa/gh-action-pypi-publish@release/v1
 
   publish-docker:
     name: Publish Docker image

.github/workflows/tests.yml

@@ -25,28 +25,30 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    - name: Install PDM
-      uses: pdm-project/setup-pdm@v4
-      with:
-        python-version: ${{ matrix.pyversion }}
-        cache: true
-
-      # Path related stuff
-    - name: Append to Path on MacOS
-      if: matrix.os == 'macos-latest'
+    - name: Setup Rye
+      if: matrix.os != 'windows-latest'
+      env:
+        RYE_TOOLCHAIN_VERSION: ${{ matrix.pyversion}}
+        RYE_INSTALL_OPTION: --yes
       run: |
-        echo "${HOME}/.local/bin" >> $GITHUB_PATH
-        echo "/Users/runner/Library/Python/${{ matrix.pyversion }}/bin" >> $GITHUB_PATH
-
-    - name: Append to Path on Ubuntu
-      if: matrix.os == 'ubuntu-latest'
-      run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
+        curl -sSf https://rye-up.com/get | bash
+        echo "$HOME/.rye/shims" >> $GITHUB_PATH
 
-    - name: Append to Path on Windows
+    # Stolen from https://github.com/bluss/pyproject-local-kernel/blob/2b641290694adc998fb6bceea58d3737523a68b7/.github/workflows/ci.yaml
+    - name: Install Rye (Windows)
       if: matrix.os == 'windows-latest'
-      run: echo "${HOME}/.local/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+      shell: bash
+      run: |
+        C:/msys64/usr/bin/wget.exe -q 'https://github.com/astral-sh/rye/releases/latest/download/rye-x86_64-windows.exe' -O rye-x86_64-windows.exe
+        ./rye-x86_64-windows.exe self install --toolchain-version ${{ matrix.pyversion }} --modify-path -y
+        echo "$HOME\\.rye\\shims" >> $GITHUB_PATH
+
+    - name: Configure Rye
+      shell: bash
+      run: |
+        rye config --set-bool behavior.use-uv=true
+        rye pin ${{ matrix.pyversion }}
 
-      # OS dependencies
     - name: Install manim dependencies on MacOS
       if: matrix.os == 'macos-latest'
       run: brew install ffmpeg py3cairo
@@ -68,16 +70,17 @@ jobs:
       uses: ssciwr/setup-mesa-dist-win@v2
 
     - name: Install Manim Slides
-      run: |
-        pdm sync -Ggithub-action -Gtest
+      shell: bash
+      run: rye sync
 
     - name: Run pytest
+      shell: bash
       if: matrix.os != 'ubuntu-latest' || matrix.pyversion != '3.11'
-      run: pdm run pytest
+      run: rye run pytest
 
     - name: Run pytest and coverage
       if: matrix.os == 'ubuntu-latest' && matrix.pyversion == '3.11'
-      run: pdm run pytest --cov-report xml --cov=manim_slides tests/
+      run: rye run pytest --cov-report xml --cov=manim_slides tests/
 
     - name: Upload to codecov.io
       if: matrix.os == 'ubuntu-latest' && matrix.pyversion == '3.11'

.python-version

@@ -0,0 +1 @@
+3.11.8

CHANGELOG.md

@@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [#417](https://github.com/jeertmans/manim-slides/pull/417)
 - Create FAQ page and clear FAQ from README.md.
   [#418](https://github.com/jeertmans/manim-slides/pull/418)
+- Used Rye instead of PDM for faster development.
+  [#420](https://github.com/jeertmans/manim-slides/pull/420)
 
 (unreleased-fixed)=
 ### Fixed

docs/source/contributing/workflow.md

@@ -24,61 +24,25 @@ the repository, and clone it locally.
 
 As for every Python project, using virtual environment is recommended to avoid
 conflicts between modules.
-For this project, we use [PDM](https://pdm-project.org/) to easily manage project
+For this project, we use [Rye](https://rye-up.com/) to easily manage project
 and development dependencies. If not already, please install this tool.
 
 ## Installing Python modules
 
-With PDM, installation becomes straightforward:
+With Rye, installation becomes straightforward:
 
 ```bash
-pdm install
+rye sync --all-features
 ```
 
-This, however, only installs the minimal set of dependencies to run the package.
-
-If you would like to install Manim or ManimGL,
-as documented in the [quickstart](/quickstart),
-you can use the `-G|--group` option:
-
-```bash
-pdm install -Gmanim   # For Manim
-# or
-pdm install -Gmanimgl # For ManimGL
-```
-
-Additionally, Manim Slides comes with groups of dependencies for development purposes:
-
-```bash
-pdm install -Gdev  # For linters and formatters
-# or
-pdm install -Gdocs # To build the documentation locally
-# or
-pdm install -Gtest # To run tests
-```
-
-:::{note}
-You can combine any number of groups or extras when installing the package locally.
-
-You can also install everything with `pdm install -G:all`.
-:::
-
 ## Running commands
 
 Because modules are installed in a new Python environment,
 you cannot use them directly in the shell.
-Instead, you either need to prepend `pdm run` to any command, e.g.:
-
-```bash
-pdm run manim-slides wizard
-```
-
-or [enter a new shell](https://pdm-project.org/latest/usage/venv/#activate-a-virtualenv)
-that uses this new Python environment:
+Instead, you either need to prepend `rye run` to any command, e.g.:
 
 ```bash
-eval $(pdm venv activate)  # Click on the link above to see shell-specific command
-manim-slides wizard
+rye run manim-slides wizard
 ```
 
 ## Testing your code
@@ -87,7 +51,7 @@ Most of the tests are done with GitHub actions, thus not on your computer.
 The only command you should run locally is:
 
 ```bash
-pdm run pre-commit run --all-files
+rye run pre-commit run --all-files
 ```
 
 This runs a few linter and formatter to make sure the code quality and style stay
@@ -97,7 +61,7 @@ If a warning or an error is displayed, please fix it before going to next step.
 For testing your code, simply run:
 
 ```bash
-pdm run pytest
+rye run pytest
 ```
 
 ## Building the documentation
@@ -109,7 +73,7 @@ To generate the documentation, run the following:
 
 ```bash
 cd docs
-pdm run make html
+rye run make html
 ```
 
 Then, the output index file is located at `docs/build/html/index.html` and

docs/source/installation.md

@@ -106,7 +106,9 @@ Along with the optional dependencies for Manim and ManimGL,
 Manim Slides offers additional *extras*, that can be activated
 using optional dependencies:
 
-- `full`, to include `magic`, `manim`, `manimgl`, and
+- `full`, to include `magic`, `manim`, and
+  `sphinx-directive` extras (see below);
+- `full-gl`, to include `magic`, `manimgl`, and
   `sphinx-directive` extras (see below);
 - `magic`, to include a Jupyter magic to render
   animations inside notebooks. This automatically installs `manim`,

docs/source/manim_or_manimgl.md

@@ -15,7 +15,6 @@ the slides.
 If both modules are present in {py:data}`sys.modules`, then Manim Slides will
 prefer using `manim`.
 
-
 ### Usage
 
 The simplest way to use Manim Slides with the correct Manim API is to:

docs/source/reference/magic_example.ipynb

@@ -18,6 +18,7 @@
    "outputs": [],
    "source": [
     "from manim import *\n",
+    "\n",
     "from manim_slides import *"
    ]
   },

manim_slides/__init__.py

@@ -29,7 +29,7 @@ def __getattr__(self, name: str) -> Any:
 
         return ModuleType.__getattribute__(self, name)
 
-    def __dir__(self) -> List[str]:
+    def __dir__(self) -> list[str]:
         result = list(new_module.__all__)
         result.extend(
             (

manim_slides/config.py

@@ -4,7 +4,7 @@
 from inspect import Parameter, signature
 from pathlib import Path
 from textwrap import dedent
-from typing import Any, Callable, Dict, List, Optional, Set, Tuple
+from typing import Any, Callable, Optional
 
 import rtoml
 from pydantic import (
@@ -24,7 +24,7 @@
 
 
 class Signal(BaseModel):  # type: ignore[misc]
-    __receivers: List[Receiver] = PrivateAttr(default_factory=list)
+    __receivers: list[Receiver] = PrivateAttr(default_factory=list)
 
     def connect(self, receiver: Receiver) -> None:
         self.__receivers.append(receiver)
@@ -47,14 +47,14 @@ def key_id(name: str) -> PositiveInt:
 class Key(BaseModel):  # type: ignore[misc]
     """Represents a list of key codes, with optionally a name."""
 
-    ids: List[PositiveInt] = Field(unique=True)
+    ids: list[PositiveInt] = Field(unique=True)
     name: Optional[str] = None
 
     __signal: Signal = PrivateAttr(default_factory=Signal)
 
     @field_validator("ids")
     @classmethod
-    def ids_is_non_empty_set(cls, ids: Set[Any]) -> Set[Any]:
+    def ids_is_non_empty_set(cls, ids: set[Any]) -> set[Any]:
         if len(ids) <= 0:
             raise ValueError("Key's ids must be a non-empty set")
         return ids
@@ -98,8 +98,8 @@ class Keys(BaseModel):  # type: ignore[misc]
 
     @model_validator(mode="before")
     @classmethod
-    def ids_are_unique_across_keys(cls, values: Dict[str, Key]) -> Dict[str, Key]:
-        ids: Set[int] = set()
+    def ids_are_unique_across_keys(cls, values: dict[str, Key]) -> dict[str, Key]:
+        ids: set[int] = set()
 
         for key in values.values():
             if len(ids.intersection(key["ids"])) != 0:
@@ -296,8 +296,8 @@ def from_pre_slide_config_and_files(
 
 
 class PresentationConfig(BaseModel):  # type: ignore[misc]
-    slides: List[SlideConfig] = Field(min_length=1)
-    resolution: Tuple[PositiveInt, PositiveInt] = (1920, 1080)
+    slides: list[SlideConfig] = Field(min_length=1)
+    resolution: tuple[PositiveInt, PositiveInt] = (1920, 1080)
     background_color: Color = "black"
 
     @classmethod

manim_slides/convert.py

@@ -2,15 +2,14 @@
 import os
 import platform
 import subprocess
-import sys
 import tempfile
 import webbrowser
 from base64 import b64encode
 from collections import deque
 from enum import Enum
 from importlib import resources
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Type, Union
+from typing import Any, Callable, Optional, Union
 
 import av
 import click
@@ -53,7 +52,7 @@ def open_with_default(file: Path) -> None:
 
 def validate_config_option(
     ctx: Context, param: Parameter, value: Any
-) -> Dict[str, str]:
+) -> dict[str, str]:
     config = {}
 
     for c_option in value:
@@ -121,7 +120,7 @@ def open(self, file: Path) -> Any:
         raise NotImplementedError
 
     @classmethod
-    def from_string(cls, s: str) -> Type["Converter"]:
+    def from_string(cls, s: str) -> type["Converter"]:
         """Return the appropriate converter from a string name."""
         return {
             "html": RevealJS,
@@ -329,7 +328,7 @@ class RevealJS(Converter):
     auto_animate_easing: AutoAnimateEasing = AutoAnimateEasing.ease
     auto_animate_duration: float = 1.0
     auto_animate_unmatched: JsBool = JsBool.true
-    auto_animate_styles: List[str] = Field(
+    auto_animate_styles: list[str] = Field(
         default_factory=lambda: [
             "opacity",
             "color",
@@ -379,9 +378,6 @@ def load_template(self) -> str:
         if isinstance(self.template, Path):
             return self.template.read_text()
 
-        if sys.version_info < (3, 9):
-            return resources.read_text(templates, "revealjs.html")
-
         return resources.files(templates).joinpath("revealjs.html").read_text()
 
     def open(self, file: Path) -> bool:
@@ -658,13 +654,13 @@ def callback(ctx: Context, param: Parameter, value: bool) -> None:
 @show_config_options
 @verbosity_option
 def convert(
-    scenes: List[str],
+    scenes: list[str],
     folder: Path,
     dest: Path,
     to: str,
     open_result: bool,
     force: bool,
-    config_options: Dict[str, str],
+    config_options: dict[str, str],
     template: Optional[Path],
 ) -> None:
     """Convert SCENE(s) into a given format and writes the result in DEST."""