add modal endpoint and magpietts

README.md

@@ -12,3 +12,12 @@ short_description: Convert your library to the spoken word
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+## Modal backend configuration
+
+Set these as Hugging Face Space secrets if you want to use the optional Modal backend:
+
+- `SCRIPTORIUM_MODAL_BASE_URL`
+- `SCRIPTORIUM_MODAL_AUTH_TOKEN`
+
+`SCRIPTORIUM_MODAL_BASE_URL` must be the deployed `modal.run` web endpoint, not the Modal dashboard URL under `modal.com/apps/...`.

app.py

@@ -39,6 +39,15 @@ store = SessionStore(root=TEMP_ROOT, ttl_seconds=SESSION_TTL_SECONDS)
 synthesis_service = SynthesisService(session_root=TEMP_ROOT)
 
 
+def _warn_about_modal_configuration() -> None:
+    warning = synthesis_service.modal_client.configuration_warning()
+    if warning:
+        print(f"Modal configuration warning: {warning}")
+
+
+_warn_about_modal_configuration()
+
+
 def _session_root(session_id: str) -> Path:
     return store.ensure_session(session_id).root
 

backend/modal_client.py

@@ -3,6 +3,7 @@ import os
 import time
 from pathlib import Path
 from typing import Dict, Iterable, List, Optional
+from urllib.parse import urlparse
 
 import requests
 
@@ -36,6 +37,21 @@ class ModalSynthesisClient:
     def is_configured(self) -> bool:
         return bool(self.base_url)
 
+    def configuration_warning(self) -> Optional[str]:
+        if not self.base_url:
+            return None
+
+        parsed = urlparse(self.base_url)
+        host = (parsed.netloc or "").lower()
+        path = parsed.path or ""
+        if host == "modal.com" and path.startswith("/apps/"):
+            return (
+                "SCRIPTORIUM_MODAL_BASE_URL points to a Modal dashboard URL, not a callable web endpoint. "
+                "Use the deployed modal.run base URL instead, for example "
+                "'https://<your-app>.modal.run'."
+            )
+        return None
+
     def generate_preview(
         self,
         *,

tests/test_app_startup.py

@@ -1,5 +1,6 @@
 import importlib
 import sys
+from types import SimpleNamespace
 
 import gradio as gr
 
@@ -31,3 +32,19 @@ def test_launch_app_disables_ssr_for_custom_server_mode(monkeypatch) -> None:
     assert captured["server_port"] == 7860
     assert captured["ssr_mode"] is False
     assert captured["_app"] is module.app
+
+
+def test_app_import_warns_for_modal_dashboard_url(monkeypatch) -> None:
+    sys.modules.pop("app", None)
+    printed = []
+
+    monkeypatch.setenv(
+        "SCRIPTORIUM_MODAL_BASE_URL",
+        "https://modal.com/apps/mattkevan/main/deployed/scriptorium-tts",
+    )
+    monkeypatch.setattr("builtins.print", lambda *args, **kwargs: printed.append(" ".join(str(arg) for arg in args)))
+
+    importlib.import_module("app")
+
+    assert any("SCRIPTORIUM_MODAL_BASE_URL" in line for line in printed)
+    assert any("modal.run" in line for line in printed)

tests/test_modal_client.py

@@ -0,0 +1,17 @@
+from backend.modal_client import ModalSynthesisClient
+
+
+def test_modal_client_warns_when_configured_with_dashboard_url() -> None:
+    client = ModalSynthesisClient(base_url="https://modal.com/apps/mattkevan/main/deployed/scriptorium-tts")
+
+    warning = client.configuration_warning()
+
+    assert warning is not None
+    assert "modal.run" in warning
+    assert "dashboard" in warning.lower()
+
+
+def test_modal_client_accepts_modal_run_base_url() -> None:
+    client = ModalSynthesisClient(base_url="https://scriptorium-tts--mattkevan.modal.run")
+
+    assert client.configuration_warning() is None