fix(lib): Manim fixes, bump to >= 0.18, and tests (#447)

* fix(lib): Manim fixes, bump to >= 0.18, and tests

* chore(ci): tests and happy mypy

* chore(deps): fix override

* fix(tests): correct skipping

* fix(ci): coverage

* fix(docs): dead links

* fix(tests): deps fixes

* fix(deps): add missing override

* fix(tests): correctly ignore

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

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

* chore(tests): no filterwarning

* chore(tests): add a check to see if we can install package

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

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

* chore(ci): typo

* fix(ci): typo

* oops

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

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

* fix(ci): double quote instead of single

* chore(ci): add OSes requirements

* chore(tests): removed `full-gl` extra

* chore(ci): automatically cancel jobs

* fix(docs): typo

---------

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

Author: jeertmans

.github/workflows/tests.yml

@@ -7,7 +7,52 @@ on:
 
 name: Tests
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
+  pip-install:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        pyversion: ['3.9', '3.10', '3.11', '3.12']
+        extras: [pyside6-full, manimgl]
+        exclude:
+        - pyversion: '3.12'
+          extras: manimgl
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.pyversion }}
+        cache: pip
+
+    - name: Install manim dependencies on MacOS
+      if: matrix.os == 'macos-latest'
+      run: brew install ffmpeg py3cairo pango pkg-config scipy
+
+    - name: Install manim dependencies on Ubuntu
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        sudo apt-get update
+        sudo apt-get install build-essential python3-dev libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev xvfb
+        nohup Xvfb $DISPLAY &
+
+    - name: Install Windows dependencies
+      if: matrix.os == 'windows-latest'
+      run: choco install ffmpeg
+
+    - name: Install package
+      shell: bash
+      env:
+        extras: ${{ matrix.extras }}
+      run: pip install ".[$extras]"
   pytest:
     strategy:
       fail-fast: false
@@ -74,15 +119,9 @@ jobs:
 
     - name: Run pytest
       shell: bash
-      if: matrix.os != 'ubuntu-latest' || matrix.pyversion != '3.11'
       run: rye run pytest
 
-    - name: Run pytest and coverage
-      if: matrix.os == 'ubuntu-latest' && matrix.pyversion == '3.11'
-      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'
       uses: codecov/codecov-action@v4
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -45,6 +45,7 @@ paper/paper.pdf
 paper/media/
 
 # Others
+.coverage
 coverage.xml
 
 rendering_times.csv

.readthedocs.yaml

@@ -15,4 +15,7 @@ sphinx:
   fail_on_warning: true
 python:
   install:
-  - requirements: requirements-dev.lock
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs

CHANGELOG.md

@@ -19,6 +19,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [samuelcolvin/rtoml#74](https://github.com/samuelcolvin/rtoml/issues/74)
   is solved.
   [#432](https://github.com/jeertmans/manim-slides/pull/432)
+- Removed an old validation check that prevented setting `loop=True` with
+  `auto_next=True` on `next_slide()`
+  [#445](https://github.com/jeertmans/manim-slides/pull/445)
+- Improved (and fixed) tests for Manim(GL), bumped minimal ManimCE version,
+  improved coverage, and override dependency conflicts.
+  [#447](https://github.com/jeertmans/manim-slides/pull/447)
 
 (unreleased-fixed)=
 ### Fixed
@@ -28,12 +34,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed whitespace issue in default RevealJS template.
   [#442](https://github.com/jeertmans/manim-slides/pull/442)
 
-(unreleased-chore)=
-### Chore
+(unreleased-removed)=
+### Removed
 
-- Removed an old validation check that prevented setting `loop=True` with
-  `auto_next=True` on `next_slide()`
-  [#445](https://github.com/jeertmans/manim-slides/pull/445)
+- Removed `full-gl` extra, because it does not make sense to ship both
+  `manimgl` and `manim` together.
+  [#447](https://github.com/jeertmans/manim-slides/pull/447)
 
 (v5.1.7)=
 ## [v5.1.7](https://github.com/jeertmans/manim-slides/compare/v5.1.6...v5.1.7)

docs/source/gallery.md

@@ -23,10 +23,10 @@ using Manim Slides presentations.
 
 Daniel publishes his presentations on *Cosmology, String Theory and related*
 topics on his
-[personal website](https://panopepino.github.io/web_page/main_page/slides.html).
+[personal website](https://panopepino.github.io/Web_Page/main_page/slides.html).
 
 For example, below are the slides of a seminar he gave titled
-[Our Universe on a (Dark) Bubble](https://panopepino.github.io/web_page/main_page/presentations/2023_11_long/LS.html).
+[Our Universe on a (Dark) Bubble](https://panopepino.github.io/Web_Page/main_page/presentations/2023_11_long/LS.html).
 
 <div style="position:relative;padding-bottom:56.25%;">
     <iframe

docs/source/installation.md

@@ -108,8 +108,6 @@ using optional dependencies:
 
 - `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`,
   and does not work with ManimGL;

manim_slides/slide/manim.py

@@ -2,6 +2,8 @@
 from typing import Any, Optional
 
 from manim import Scene, ThreeDScene, config
+from manim.renderer.opengl_renderer import OpenGLRenderer
+from manim.utils.color import rgba_to_color
 
 from ..config import BaseSlideConfig
 from .base import BaseSlide
@@ -13,25 +15,40 @@ class Slide(BaseSlide, Scene):  # type: ignore[misc]
     for slides rendering.
     """
 
+    @property
+    def _frame_shape(self) -> tuple[float, float]:
+        if isinstance(self.renderer, OpenGLRenderer):
+            return self.renderer.camera.frame_shape  # type: ignore
+        else:
+            return (
+                self.renderer.camera.frame_height,
+                self.renderer.camera.frame_width,
+            )
+
     @property
     def _frame_height(self) -> float:
-        return config["frame_height"]  # type: ignore
+        return self._frame_shape[0]
 
     @property
     def _frame_width(self) -> float:
-        return config["frame_width"]  # type: ignore
+        return self._frame_shape[1]
 
     @property
     def _background_color(self) -> str:
-        color = self.camera.background_color
-        if hex_color := getattr(color, "hex", None):
-            return hex_color  # type: ignore
-        else:  # manim>=0.18, see https://github.com/ManimCommunity/manim/pull/3020
-            return color.to_hex()  # type: ignore
+        if isinstance(self.renderer, OpenGLRenderer):
+            return rgba_to_color(self.renderer.background_color).to_hex()  # type: ignore
+        else:
+            return self.renderer.camera.background_color.to_hex()  # type: ignore
 
     @property
     def _resolution(self) -> tuple[int, int]:
-        return config["pixel_width"], config["pixel_height"]
+        if isinstance(self.renderer, OpenGLRenderer):
+            return self.renderer.get_pixel_shape()  # type: ignore
+        else:
+            return (
+                self.renderer.camera.pixel_width,
+                self.renderer.camera.pixel_height,
+            )
 
     @property
     def _partial_movie_files(self) -> list[Path]:

pyproject.toml

@@ -42,20 +42,35 @@ name = "manim-slides"
 requires-python = ">=3.9"
 
 [project.optional-dependencies]
+docs = [
+  "manim-slides[magic,manim,pyqt6,sphinx-directive]",
+  "furo>=2023.5.20",
+  "ipykernel>=6.25.1",
+  "myst-parser>=2.0.0",
+  "nbsphinx>=0.9.2",
+  "pandoc>=2.3",
+  "sphinx>=7.0.1",
+  "sphinx-click>=4.4.0",
+  "sphinx-copybutton>=0.5.1",
+  "sphinxext-opengraph>=0.7.5",
+]
 full = [
   "manim-slides[magic,manim,sphinx-directive]",
 ]
-full-gl = [
-  "manim-slides[magic,manimgl,sphinx-directive]",
-]
 magic = ["manim-slides[manim]", "ipython>=8.12.2"]
-manim = ["manim>=0.17.3"]
+manim = ["manim>=0.18.0"]
 manimgl = ["manimgl>=1.6.1;python_version<'3.12'"]
 pyqt6 = ["pyqt6>=6.6.1"]
 pyqt6-full = ["manim-slides[full,pyqt6]"]
-pyside6 = ["pyside6>=6.5.1,<6.5.3;python_version<'3.12'"]
+pyside6 = ["pyside6>=6.5.1,<6.5.3;python_version<'3.12'", "pyside6>=6.6.1;python_version>='3.12'"]
 pyside6-full = ["manim-slides[full,pyside6]"]
 sphinx-directive = ["docutils>=0.20.1", "manim-slides[manim]"]
+tests = [
+  "pytest>=7.4.0",
+  "pytest-cov>=4.1.0",
+  "pytest-env>=0.8.2",
+  "pytest-qt>=4.2.0",
+]
 
 [project.scripts]
 manim-slides = "manim_slides.__main__:cli"
@@ -161,13 +176,14 @@ python_version = "3.9"
 strict = true
 
 [tool.pytest.ini_options]
+addopts = [
+  "--cov-report=xml",
+  "--cov=manim_slides",
+]
 env = [
+  "QT_API=pyside6",
   "QT_QPA_PLATFORM=offscreen",
 ]
-filterwarnings = [
-  "error",
-  "ignore::DeprecationWarning",
-]
 
 [tool.ruff]
 extend-exclude = ["manim_slides/resources.py"]
@@ -193,27 +209,20 @@ extend-ignore = [
 extend-select = ["B", "C90", "D", "I", "N", "RUF", "UP", "T"]
 isort = {known-first-party = ["manim_slides", "tests"]}
 
+[tool.ruff.lint.per-file-ignores]
+"tests/test_slide.py" = ["N801"]
+
 [tool.rye]
 dev-dependencies = [
-  "manim-slides[magic,manim,manimgl,pyqt6,sphinx-directive]",
-  # dev
   "bump-my-version>=0.20.3",
   "pre-commit>=3.5.0",
-  # docs
-  "furo>=2023.5.20",
-  "ipykernel>=6.25.1",
-  "myst-parser>=2.0.0",
-  "nbsphinx>=0.9.2",
-  "pandoc>=2.3",
-  "sphinx>=7.0.1",
-  "sphinx-click>=4.4.0",
-  "sphinx-copybutton>=0.5.1",
-  "sphinxext-opengraph>=0.7.5",
-  # tests
-  "pytest>=7.4.0",
-  "pytest-cov>=4.1.0",
-  "pytest-env>=0.8.2",
-  "pytest-qt>=4.2.0",
-  "pytest-xdist>=3.3.1",
 ]
 managed = true
+
+[tool.uv]
+override-dependencies = [
+  # Bypass constraints from ManimGL
+  "manimpango>=0.5.0,<1.0.0",
+  "numpy<=1.24;python_version < '3.12'",
+  "numpy>=1.26;python_version >= '3.12'",
+]