Implemented decorator :func:.manimation for building a scene from a construct method

.codespell_ignorewords

@@ -0,0 +1,5 @@
+ nam
+ sherif
+ falsy
+ medias
+ strager

.codespellrc

@@ -1,4 +1,4 @@
 [codespell]
-exclude-file=.codespell_ignorelines
-check-hidden=True
-ignore-words-list = nam,sherif,falsy
+check-hidden = True
+skip = .git,*.js,*.js.map,*.css,*.css.map,*.html,*.po,*.pot,poetry.lock,*.log,*.svg
+ignore-words = .codespell_ignorewords

.flake8

@@ -1,22 +1,26 @@
 [flake8]
 # Exclude the grpc generated code
-exclude = ./manim/grpc/gen/*
-max-complexity = 15
+exclude = ./manim/grpc/gen/*, __pycache__,.git,
+per-file-ignores = __init__.py:F401
+max-complexity = 29
 max-line-length = 88
 statistics = True
 # Prevents some flake8-rst-docstrings errors
 rst-roles = attr,class,func,meth,mod,obj,ref,doc,exc
 rst-directives = manim, SEEALSO, seealso
 docstring-convention=numpy
 
-select = A,A00,B,B9,C4,C90,D,E,F,F,PT,RST,SIM,W
+select = A,A00,B,B9,C4,C90,D,E,F,F,PT,RST,SIM,W,F401
 
                 # General Compatibility
 extend-ignore = E203, W503, D202, D212, D213, D404
 
                 # Misc
                 F401, F403, F405, F841, E501, E731, E402, F811, F821,
 
+                # multiple statements on one line (overload)
+                E704,
+
                 # Plug-in: flake8-builtins
                 A001, A002, A003,
 
@@ -26,9 +30,6 @@ extend-ignore = E203, W503, D202, D212, D213, D404
                 # Plug-in: flake8-simplify
                 SIM105, SIM106, SIM119,
 
-                # Plug-in: flake8-comprehensions
-                C901
-
                 # Plug-in: flake8-pytest-style
                 PT001, PT004, PT006, PT011, PT018, PT022, PT023,
 
@@ -40,4 +41,4 @@ extend-ignore = E203, W503, D202, D212, D213, D404
 
                 # Plug-in: flake8-rst-docstrings
                 RST201, RST203, RST210, RST212, RST213, RST215,
-                RST301, RST303,
+                RST301, RST303, RST499

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Switched to ruff format:
+24025b60d57301b0a59754c38d77bccd8ed69feb

.github/ISSUE_TEMPLATE/bug_report.md

@@ -70,14 +70,5 @@ PASTE HERE
 <!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
 </details>
 
-<details><summary>FFMPEG</summary>
-
-Output of `ffmpeg -version`:
-
-```
-PASTE HERE
-```
-</details>
-
 ## Additional comments
 <!-- Add further context that you think might be relevant for this issue here. -->

.github/ISSUE_TEMPLATE/installation_issue.md

@@ -53,14 +53,5 @@ PASTE HERE
 <!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
 </details>
 
-<details><summary>FFMPEG</summary>
-
-Output of `ffmpeg -version`:
-
-```
-PASTE HERE
-```
-</details>
-
 ## Additional comments
 <!-- Add further context that you think might be relevant for this issue here. -->

.github/manimdependency.json

@@ -4,7 +4,10 @@
             "standalone",
             "preview",
             "doublestroke",
-            "ms",
+            "count1to",
+            "multitoc",
+            "prelim2e",
+            "ragged2e",
             "everysel",
             "setspace",
             "rsfs",
@@ -29,7 +32,10 @@
             "standalone",
             "preview",
             "doublestroke",
-            "ms",
+            "count1to",
+            "multitoc",
+            "prelim2e",
+            "ragged2e",
             "everysel",
             "setspace",
             "rsfs",

.github/scripts/ci_build_cairo.py

@@ -0,0 +1,209 @@
+# Logic is as follows:
+# 1. Download cairo source code: https://cairographics.org/releases/cairo-<version>.tar.xz
+# 2. Verify the downloaded file using the sha256sums file: https://cairographics.org/releases/cairo-<version>.tar.xz.sha256sum
+# 3. Extract the downloaded file.
+# 4. Create a virtual environment and install meson and ninja.
+# 5. Run meson build in the extracted directory. Also, set required prefix.
+# 6. Run meson compile -C build.
+# 7. Run meson install -C build.
+
+import hashlib
+import logging
+import os
+import subprocess
+import sys
+import tarfile
+import tempfile
+import typing
+import urllib.request
+from contextlib import contextmanager
+from pathlib import Path
+from sys import stdout
+
+CAIRO_VERSION = "1.18.0"
+CAIRO_URL = f"https://cairographics.org/releases/cairo-{CAIRO_VERSION}.tar.xz"
+CAIRO_SHA256_URL = f"{CAIRO_URL}.sha256sum"
+
+VENV_NAME = "meson-venv"
+BUILD_DIR = "build"
+INSTALL_PREFIX = Path(__file__).parent.parent.parent / "third_party" / "cairo"
+
+logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
+logger = logging.getLogger(__name__)
+
+
+def is_ci():
+    return os.getenv("CI", None) is not None
+
+
+def download_file(url, path):
+    logger.info(f"Downloading {url} to {path}")
+    block_size = 1024 * 1024
+    with urllib.request.urlopen(url) as response, open(path, "wb") as file:
+        while True:
+            data = response.read(block_size)
+            if not data:
+                break
+            file.write(data)
+
+
+def verify_sha256sum(path, sha256sum):
+    with open(path, "rb") as file:
+        file_hash = hashlib.sha256(file.read()).hexdigest()
+    if file_hash != sha256sum:
+        raise Exception("SHA256SUM does not match")
+
+
+def extract_tar_xz(path, directory):
+    with tarfile.open(path) as file:
+        file.extractall(directory)
+
+
+def run_command(command, cwd=None, env=None):
+    process = subprocess.Popen(command, cwd=cwd, env=env)
+    process.communicate()
+    if process.returncode != 0:
+        raise Exception("Command failed")
+
+
+@contextmanager
+def gha_group(title: str) -> typing.Generator:
+    if not is_ci():
+        yield
+        return
+    print(f"\n::group::{title}")
+    stdout.flush()
+    try:
+        yield
+    finally:
+        print("::endgroup::")
+        stdout.flush()
+
+
+def set_env_var_gha(name: str, value: str) -> None:
+    if not is_ci():
+        return
+    env_file = os.getenv("GITHUB_ENV", None)
+    if env_file is None:
+        return
+    with open(env_file, "a") as file:
+        file.write(f"{name}={value}\n")
+    stdout.flush()
+
+
+def get_ld_library_path(prefix: Path) -> str:
+    # given a prefix, the ld library path can be found at
+    # <prefix>/lib/* or sometimes just <prefix>/lib
+    # this function returns the path to the ld library path
+
+    # first, check if the ld library path exists at <prefix>/lib/*
+    ld_library_paths = list(prefix.glob("lib/*"))
+    if len(ld_library_paths) == 1:
+        return ld_library_paths[0].absolute().as_posix()
+
+    # if the ld library path does not exist at <prefix>/lib/*,
+    # return <prefix>/lib
+    ld_library_path = prefix / "lib"
+    if ld_library_path.exists():
+        return ld_library_path.absolute().as_posix()
+    return ""
+
+
+def main():
+    if sys.platform == "win32":
+        logger.info("Skipping build on windows")
+        return
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        with gha_group("Downloading and Extracting Cairo"):
+            logger.info(f"Downloading cairo version {CAIRO_VERSION}")
+            download_file(CAIRO_URL, os.path.join(tmpdir, "cairo.tar.xz"))
+
+            logger.info("Downloading cairo sha256sum")
+            download_file(CAIRO_SHA256_URL, os.path.join(tmpdir, "cairo.sha256sum"))
+
+            logger.info("Verifying cairo sha256sum")
+            with open(os.path.join(tmpdir, "cairo.sha256sum")) as file:
+                sha256sum = file.read().split()[0]
+            verify_sha256sum(os.path.join(tmpdir, "cairo.tar.xz"), sha256sum)
+
+            logger.info("Extracting cairo")
+            extract_tar_xz(os.path.join(tmpdir, "cairo.tar.xz"), tmpdir)
+
+        with gha_group("Installing meson and ninja"):
+            logger.info("Creating virtual environment")
+            run_command([sys.executable, "-m", "venv", os.path.join(tmpdir, VENV_NAME)])
+
+            logger.info("Installing meson and ninja")
+            run_command(
+                [
+                    os.path.join(tmpdir, VENV_NAME, "bin", "pip"),
+                    "install",
+                    "meson",
+                    "ninja",
+                ]
+            )
+
+        env_vars = {
+            # add the venv bin directory to PATH so that meson can find ninja
+            "PATH": f"{os.path.join(tmpdir, VENV_NAME, 'bin')}{os.pathsep}{os.environ['PATH']}",
+        }
+
+        with gha_group("Building and Installing Cairo"):
+            logger.info("Running meson setup")
+            run_command(
+                [
+                    os.path.join(tmpdir, VENV_NAME, "bin", "meson"),
+                    "setup",
+                    BUILD_DIR,
+                    f"--prefix={INSTALL_PREFIX.absolute().as_posix()}",
+                    "--buildtype=release",
+                    "-Dtests=disabled",
+                ],
+                cwd=os.path.join(tmpdir, f"cairo-{CAIRO_VERSION}"),
+                env=env_vars,
+            )
+
+            logger.info("Running meson compile")
+            run_command(
+                [
+                    os.path.join(tmpdir, VENV_NAME, "bin", "meson"),
+                    "compile",
+                    "-C",
+                    BUILD_DIR,
+                ],
+                cwd=os.path.join(tmpdir, f"cairo-{CAIRO_VERSION}"),
+                env=env_vars,
+            )
+
+            logger.info("Running meson install")
+            run_command(
+                [
+                    os.path.join(tmpdir, VENV_NAME, "bin", "meson"),
+                    "install",
+                    "-C",
+                    BUILD_DIR,
+                ],
+                cwd=os.path.join(tmpdir, f"cairo-{CAIRO_VERSION}"),
+                env=env_vars,
+            )
+
+        logger.info(f"Successfully built cairo and installed it to {INSTALL_PREFIX}")
+
+
+if __name__ == "__main__":
+    if "--set-env-vars" in sys.argv:
+        with gha_group("Setting environment variables"):
+            # append the pkgconfig directory to PKG_CONFIG_PATH
+            set_env_var_gha(
+                "PKG_CONFIG_PATH",
+                f"{Path(get_ld_library_path(INSTALL_PREFIX), 'pkgconfig').as_posix()}{os.pathsep}"
+                f'{os.getenv("PKG_CONFIG_PATH", "")}',
+            )
+            set_env_var_gha(
+                "LD_LIBRARY_PATH",
+                f"{get_ld_library_path(INSTALL_PREFIX)}{os.pathsep}"
+                f'{os.getenv("LD_LIBRARY_PATH", "")}',
+            )
+        sys.exit(0)
+    main()

.github/workflows/cffconvert.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out a copy of the repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Check whether the citation metadata from CITATION.cff is valid
         uses: citation-file-format/[email protected]