uv

.editorconfig

@@ -1,3 +0,0 @@
-[*.sh]
-indent_size = 4
-indent_style = space

.gitignore

@@ -1,3 +1,2 @@
 __pycache__
 /dist
-/.venv

readme.md

@@ -291,3 +291,4 @@ Handle project workflows in a unified way:
 * tex
 * translate to french
 * try to support nix
+* uv

spcd.sh

@@ -1,30 +1,30 @@
 #! /usr/bin/env sh
 
 gource \
-    --auto-skip-seconds 0.25 \
+	--auto-skip-seconds 0.25 \
-    --date-format "%Y / %m / %d  ⋅  %H : %M : %S" \
+	--date-format "%Y / %m / %d  ⋅  %H : %M : %S" \
-    --disable-input \
+	--disable-input \
-    --font-scale 2.5 \
+	--font-scale 2.5 \
-    --frameless \
+	--frameless \
-    --hide mouse,usernames \
+	--hide mouse,usernames \
-    --highlight-dirs \
+	--highlight-dirs \
-    --key \
+	--key \
-    --multi-sampling \
+	--multi-sampling \
-    --output-framerate 60 \
+	--output-framerate 60 \
-    --output-ppm-stream - \
+	--output-ppm-stream - \
-    --seconds-per-day 0.6 \
+	--seconds-per-day 0.6 \
-    --stop-at-end \
+	--stop-at-end \
-    --viewport "1920x1080" |
+	--viewport "1920x1080" |
-    ffmpeg \
+	ffmpeg \
-        -codec:v ppm \
+		-codec:v ppm \
-        -format image2pipe \
+		-format image2pipe \
-        -framerate 120 \
+		-framerate 120 \
-        -i - \
+		-i - \
-        -codec:v libx264 \
+		-codec:v libx264 \
-        -preset veryslow \
+		-preset veryslow \
-        -qp 28 \
+		-qp 28 \
-        -movflags \
+		-movflags \
-        +faststart \
+		+faststart \
-        -pix_fmt yuv420p \
+		-pix_fmt yuv420p \
-        -y \
+		-y \
-        spcd.mp4
+		spcd.mp4

spcd/__init__.py

@@ -44,8 +44,12 @@ def clone_project_branch() -> None:
         )
 
 
-def install_commands(path: str) -> None:
+def install_commands(path: Path) -> None:
-    """Make commands callable in the operating system."""
+    """Make commands callable in the operating system.
+
+    :param path: entry point that commands will call
+    :type path: Path
+    """
     step("Install commands")
     user = Path("/usr/local/bin")
     for command in [
@@ -72,10 +76,12 @@ def install_python_packages() -> None:
         "pydoclint",
         "pylint",
         "pytest",
+        "PyYAML",
         "ruff",
-        "sphinx",
+        "Sphinx",
         "sphinx-rtd-theme",
         "twine",
+        "types-PyYAML",
     ]
     for package in packages:
         log.info(package)
@@ -92,8 +98,12 @@ def list_environment_variables() -> None:
             log.info("%s", variable)
 
 
-def main(main_file: str) -> None:
+def main(main_file: Path) -> None:
-    """Entry point to initialize environment or run a specific command."""
+    """Entry point to initialize environment or run a specific command.
+
+    :param main_file: entry point file calling this function
+    :type main_file: Path
+    """
     paths = environ["PATH"].split(pathsep)
     if env.SPCD_PYTHON_VENV_BINARIES not in paths:
         environ["PATH"] = pathsep.join([env.SPCD_PYTHON_VENV_BINARIES, *paths])

spcd/__main__.py

@@ -4,6 +4,7 @@
 
 import importlib
 import sys
+from pathlib import Path
 
 if __name__ == "__main__":
     env = importlib.import_module("env")
@@ -11,4 +12,4 @@ if __name__ == "__main__":
         sys.path.insert(0, env.SPCD_PYTHON_VENV_PACKAGES)
     from spcd import main
 
-    main(__file__)
+    main(Path(__file__))

spcd/cmd.py

@@ -32,7 +32,13 @@ def spcd_check_project() -> None:
 def spcd_synchronize(
     target: str | None = None, source: str | None = None
 ) -> None:
-    """Synchronize output towards a target."""
+    """Synchronize output towards a target.
+
+    :param target: where to deploy to
+    :type target: str | None
+    :param source: where to deploy from
+    :type source: str | None
+    """
     if not target:
         user = "cd"
         host = env.SPCD_PROJECT_PATH

spcd/project.py

@@ -28,7 +28,11 @@ class Project:
     """Current project."""
 
     def __init__(self, projects: Projects) -> None:
-        """Set projects, branch, name, root & url."""
+        """Set projects, branch, name, root & url.
+
+        :param projects: parent class with environment
+        :type projects: Projects
+        """
         self.projects = projects
         # branch
         for variable in BRANCH: