ci: add slophammer baseline gate

Author: osolmaz

.github/workflows/slophammer.yml

@@ -0,0 +1,19 @@
+name: Slophammer
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+      - name: Run Slophammer
+        run: uvx slophammer-py@0.3.0 check . --baseline

AGENTS.md

@@ -0,0 +1,9 @@
+# AGENTS.md
+
+These instructions apply to this repository.
+
+- Keep generated changes small and reviewable by maintainers.
+- Preserve the public package API unless the change is explicitly scoped as breaking.
+- Add or update tests when changing behavior.
+- Run the relevant local checks before submitting a change.
+- Use the existing project style and avoid unrelated formatting churn.

manim_voiceover/helper.py

@@ -18,7 +18,7 @@ def chunks(lst: list, n: int):
 
 
 def remove_bookmarks(input: str) -> str:
-    return re.sub("<bookmark\s*mark\s*=['\"]\w*[\"']\s*/>", "", input)
+    return re.sub(r"<bookmark\s*mark\s*=['\"]\w*[\"']\s*/>", "", input)
 
 
 def wav2mp3(wav_path, mp3_path=None, remove_wav=True, bitrate="312k"):

manim_voiceover/py.typed

@@ -0,0 +1 @@
+

manim_voiceover/services/elevenlabs.py

@@ -149,8 +149,7 @@ def generate_from_text(
         path: Optional[str] = None,
         **kwargs,
     ) -> dict:
-        if cache_dir is None:
-            cache_dir = self.cache_dir  # type: ignore
+        cache_dir_path = Path(cache_dir) if cache_dir is not None else Path(self.cache_dir)
 
         input_text = remove_bookmarks(text)
         input_data = {
@@ -163,7 +162,7 @@ def generate_from_text(
         }
 
         # if not config.disable_caching:
-        cached_result = self.get_cached_result(input_data, cache_dir)
+        cached_result = self.get_cached_result(input_data, cache_dir_path)
 
         if cached_result is not None:
             return cached_result
@@ -180,7 +179,7 @@ def generate_from_text(
                 model=self.model,
                 output_format=self.output_format,
             )
-            save(audio, str(Path(cache_dir) / audio_path))  # type: ignore
+            save(audio, str(cache_dir_path / audio_path))
         except Exception as e:
             logger.error(e)
             raise Exception("Failed to initialize ElevenLabs.")

slophammer-baseline.json

@@ -0,0 +1,33 @@
+{
+  "version": 1,
+  "findings": [
+    {
+      "rule_id": "py.complexity-required",
+      "path": "pyproject.toml"
+    },
+    {
+      "rule_id": "py.coverage-required",
+      "path": ".github/workflows"
+    },
+    {
+      "rule_id": "py.dependency-audit-required",
+      "path": ".github/workflows"
+    },
+    {
+      "rule_id": "py.dry-required",
+      "path": ".github/workflows"
+    },
+    {
+      "rule_id": "py.format-required",
+      "path": ".github/workflows"
+    },
+    {
+      "rule_id": "py.mutation-required",
+      "path": ".github/workflows"
+    },
+    {
+      "rule_id": "py.typecheck-required",
+      "path": ".github/workflows"
+    }
+  ]
+}