showrunner 0.1.0__tar.gz

showrunner-0.1.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.3
+Name: showrunner
+Version: 0.1.0
+Summary: A collection of tools for live performances including script parsing, cue management, and more.
+Requires-Dist: fastapi>=0.135.2
+Requires-Dist: nicegui>=2.0
+Requires-Dist: pluggy>=1.6.0
+Requires-Dist: screenplay-tools>=0.0.10
+Requires-Dist: sqlmodel>=0.0.37
+Requires-Dist: watchfiles>=1.0.0
+Requires-Dist: sqladmin>=0.20.1 ; extra == 'admin'
+Requires-Dist: showrunner[admin] ; extra == 'all'
+Requires-Dist: showrunner[cli] ; extra == 'all'
+Requires-Dist: showrunner[pdf] ; extra == 'all'
+Requires-Dist: typer>=0.24.1 ; extra == 'cli'
+Requires-Dist: fpdf2>=2.8.7 ; extra == 'pdf'
+Requires-Python: >=3.10, <4.0
+Provides-Extra: admin
+Provides-Extra: all
+Provides-Extra: cli
+Provides-Extra: pdf
+Description-Content-Type: text/markdown
+
+# ShowRunner
+
+An application to help running live shows!
+
+## About
+
+**ShowRunner** is a collection of tools for live performances including script parsing, cue management, and more. It is built using Python and is designed to be flexible, extensible, and powerful for stage managers, designers, directors, and crew members involved in live productions.
+
+## Documentation
+
+Documentation can be found in the `docs/` directory, or available online: [quaternionmedia.github.io/ShowRunner/](https://quaternionmedia.github.io/ShowRunner/)
+
+## Quick Start
+
+### Install with pip
+
+```bash
+pip install showrunner[all]
+```
+
+The `[all]` extra includes optional dependencies for the admin panel, CLI, and other tools. You can also install just the core API with `pip install showrunner` and add extras as needed.
+
+### Install from source
+
+Requires [uv](https://docs.astral.sh/uv/)
+
+#### Clone the repo
+
+```bash
+git clone https://github.com/quaternionmedia/ShowRunner.git
+cd ShowRunner
+```
+
+#### Create a virtual environment (recommended)
+
+```bash
+uv venv
+# Activate the virtual environment:
+source .venv/bin/activate
+```
+
+If you are not using a virtual environment, run commands with `uv run [cmd]`
+
+#### Install dependencies
+
+Including dev tools and optional extras (admin panel, CLI, etc.)
+
+```bash
+uv sync --all-extras
+```
+
+## Start the API server
+
+```bash
+sr start
+```
+
+Visit [http://localhost:8000](http://localhost:8000) to access the dashboard and tools.
+
+Use `sr --help` for CLI options and `sr [tool] --help` for tool-specific commands.
+
+## Tools
+
+- **ShowDashboard**: Show selector and control dashboard mounted at [/](http://localhost:8000/)
+- **ShowScripter**: Script viewer (PDF, Fountain, etc.) with inline cue placement mounted at [/script](http://localhost:8000/script)
+- **ShowAdmin**: Web-based database admin panel mounted at [/admin](http://localhost:8000/admin) _(requires `admin` group)_
+- **ShowDesigner**: Allows users to design cues based on the parsed script, including setting up cue layers for specific integration with other tools
+- **ShowProgrammer**: Synchronization with QLab and other tools to automatically create and label cues from a script
+- **ShowMixer**: Operates sound mixers to monitor and control channels and effects during a performance (Behringer, Allen & Heath, etc.)
+- **ShowLighter**: Integrates cues directly with lighting control systems for design and performance (ETC Eos, Chamsys, MA Lighting, etc.)
+- **ShowManager**: Designed for Stage Managers to manage cues during a live performance, including triggering cues
+- **ShowStopper**: A stopwatch with helpful features for live performances, such as logging and cue timing
+- **ShowPrompter**: A teleprompter application that can display scripts and cues for performers and crew
+- **ShowComms**: A communication tool for crew members to coordinate during a performance, including messaging and cue notifications
+- **ShowCmd**: A command-line interface to interact with the system with a CLI or TUI
+- **ShowRecorder**: A tool for archiving, annotating, and reviewing rehearsals and performances, including cue logs and performance notes
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, testing, linting, and plugin authoring guidelines.
+
+```bash
+uv run pytest          # run tests
+uv run ruff check .    # lint
+```
+
+## Credit
+
+Designed and developed by [Quaternion Media](https://quaternion.media)

showrunner-0.1.0/README.md

@@ -0,0 +1,89 @@
+# ShowRunner
+
+An application to help running live shows!
+
+## About
+
+**ShowRunner** is a collection of tools for live performances including script parsing, cue management, and more. It is built using Python and is designed to be flexible, extensible, and powerful for stage managers, designers, directors, and crew members involved in live productions.
+
+## Documentation
+
+Documentation can be found in the `docs/` directory, or available online: [quaternionmedia.github.io/ShowRunner/](https://quaternionmedia.github.io/ShowRunner/)
+
+## Quick Start
+
+### Install with pip
+
+```bash
+pip install showrunner[all]
+```
+
+The `[all]` extra includes optional dependencies for the admin panel, CLI, and other tools. You can also install just the core API with `pip install showrunner` and add extras as needed.
+
+### Install from source
+
+Requires [uv](https://docs.astral.sh/uv/)
+
+#### Clone the repo
+
+```bash
+git clone https://github.com/quaternionmedia/ShowRunner.git
+cd ShowRunner
+```
+
+#### Create a virtual environment (recommended)
+
+```bash
+uv venv
+# Activate the virtual environment:
+source .venv/bin/activate
+```
+
+If you are not using a virtual environment, run commands with `uv run [cmd]`
+
+#### Install dependencies
+
+Including dev tools and optional extras (admin panel, CLI, etc.)
+
+```bash
+uv sync --all-extras
+```
+
+## Start the API server
+
+```bash
+sr start
+```
+
+Visit [http://localhost:8000](http://localhost:8000) to access the dashboard and tools.
+
+Use `sr --help` for CLI options and `sr [tool] --help` for tool-specific commands.
+
+## Tools
+
+- **ShowDashboard**: Show selector and control dashboard mounted at [/](http://localhost:8000/)
+- **ShowScripter**: Script viewer (PDF, Fountain, etc.) with inline cue placement mounted at [/script](http://localhost:8000/script)
+- **ShowAdmin**: Web-based database admin panel mounted at [/admin](http://localhost:8000/admin) _(requires `admin` group)_
+- **ShowDesigner**: Allows users to design cues based on the parsed script, including setting up cue layers for specific integration with other tools
+- **ShowProgrammer**: Synchronization with QLab and other tools to automatically create and label cues from a script
+- **ShowMixer**: Operates sound mixers to monitor and control channels and effects during a performance (Behringer, Allen & Heath, etc.)
+- **ShowLighter**: Integrates cues directly with lighting control systems for design and performance (ETC Eos, Chamsys, MA Lighting, etc.)
+- **ShowManager**: Designed for Stage Managers to manage cues during a live performance, including triggering cues
+- **ShowStopper**: A stopwatch with helpful features for live performances, such as logging and cue timing
+- **ShowPrompter**: A teleprompter application that can display scripts and cues for performers and crew
+- **ShowComms**: A communication tool for crew members to coordinate during a performance, including messaging and cue notifications
+- **ShowCmd**: A command-line interface to interact with the system with a CLI or TUI
+- **ShowRecorder**: A tool for archiving, annotating, and reviewing rehearsals and performances, including cue logs and performance notes
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, testing, linting, and plugin authoring guidelines.
+
+```bash
+uv run pytest          # run tests
+uv run ruff check .    # lint
+```
+
+## Credit
+
+Designed and developed by [Quaternion Media](https://quaternion.media)

showrunner-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "showrunner"
+version = "0.1.0"
+description = "A collection of tools for live performances including script parsing, cue management, and more."
+readme = "README.md"
+requires-python = ">=3.10,<4.0"
+dependencies = [
+    "fastapi>=0.135.2",
+    "nicegui>=2.0",
+    "pluggy>=1.6.0",
+    "screenplay-tools>=0.0.10",
+    "sqlmodel>=0.0.37",
+    "watchfiles>=1.0.0",
+]
+
+[project.scripts]
+sr = "showrunner.cli:cli"
+
+[project.optional-dependencies]
+admin = ["sqladmin>=0.20.1"]
+cli = ["typer>=0.24.1"]
+pdf = ["fpdf2>=2.8.7"]
+all = ["showrunner[admin]", "showrunner[cli]", "showrunner[pdf]"]
+
+[dependency-groups]
+dev = ["black>=26.3.1", "pytest>=9.0.2", "ruff>=0.15.8", "uvicorn>=0.42.0"]
+docs = ["zensical>=0.0.31"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+# Plugins are loaded in dependency order (DB before Admin/Dashboard), not alphabetically.
+"src/showrunner/plugins/__init__.py" = ["I001"]
+# Inline JS strings in the scripter UI are intentionally long.
+"src/showrunner/plugins/scripter.py" = ["E501"]
+
+[build-system]
+requires = ["uv_build>=0.11.2,<0.12"]
+build-backend = "uv_build"

showrunner-0.1.0/src/showrunner/__init__.py

@@ -0,0 +1,12 @@
+"""ShowRunner - A collection of tools for live performances."""
+
+import pluggy
+
+# hookimpl must be defined before importing ShowRunner (which transitively
+# imports plugins that do ``import showrunner; showrunner.hookimpl``).
+hookimpl = pluggy.HookimplMarker("showrunner")
+"""Marker to be used in plugin hook implementations."""
+
+from .app import ShowRunner  # noqa: E402
+
+__all__ = ["hookimpl", "ShowRunner"]

showrunner-0.1.0/src/showrunner/app.py

@@ -0,0 +1,138 @@
+"""ShowRunner core application.
+
+Manages the plugin lifecycle and wires plugins into the FastAPI application.
+"""
+
+from __future__ import annotations
+
+import inspect
+import logging
+from importlib.metadata import entry_points
+from pathlib import Path
+
+import pluggy
+from fastapi import FastAPI
+
+from . import plugins
+from .config import ConfigWatcher, ShowRunnerConfig, load_config
+from .hookspecs import ShowRunnerSpec
+
+logger = logging.getLogger(__name__)
+
+
+def get_plugin_manager(
+    config: ShowRunnerConfig | None = None,
+) -> pluggy.PluginManager:
+    """Create and configure a PluginManager with built-in plugins loaded.
+
+    Plugins whose name (case-insensitive) appears in
+    ``config.plugins.disabled`` are skipped.
+    """
+    pm = pluggy.PluginManager("showrunner")
+    pm.add_hookspecs(ShowRunnerSpec)
+
+    disabled = set()
+    if config is not None:
+        disabled = {n.lower() for n in config.plugins.disabled}
+
+    # Register all built-in plugins
+    for plugin_class in plugins.get_builtin_plugins():
+        name = plugin_class.__name__.lower()
+        if name in disabled:
+            logger.info("Skipping disabled plugin %s", plugin_class.__name__)
+            continue
+        pm.register(plugin_class())
+
+    # Discover external plugins installed via setuptools entry points.
+    # We load them manually (instead of pm.load_setuptools_entrypoints)
+    # so that entry points pointing to a class are instantiated first —
+    # pluggy requires hook methods to be bound (i.e. on an instance).
+    for ep in entry_points(group="showrunner"):
+        if pm.get_plugin(ep.name) is not None:
+            continue
+        plugin = ep.load()
+        if inspect.isclass(plugin):
+            plugin = plugin()
+        name = getattr(plugin, "__name__", type(plugin).__name__).lower()
+        if name in disabled:
+            logger.info("Skipping disabled external plugin %s", name)
+            continue
+        pm.register(plugin, name=ep.name)
+
+    return pm
+
+
+class ShowRunner:
+    """Main ShowRunner application.
+
+    Holds the plugin manager and the FastAPI app instance.
+    Provides lifecycle management for all registered plugins.
+    """
+
+    def __init__(self, config_path: Path | None = None) -> None:
+        self.config = load_config(config_path)
+        self._config_path = config_path or self.config._source_path
+
+        # Configure logging from show.toml unless already set by the CLI.
+        # basicConfig is a no-op when handlers already exist, so CLI
+        # flags (--log-level, --verbose, --quiet) take precedence.
+        logging.basicConfig(
+            level=self.config.logging.level.upper(),
+            format="%(levelname)-8s %(name)s: %(message)s",
+        )
+
+        self.pm = get_plugin_manager(self.config)
+        self._config_watcher: ConfigWatcher | None = None
+        self.api = FastAPI(title="ShowRunner", version="0.1.0", docs_url="/api")
+        self._mount_routes()
+
+    def _mount_routes(self) -> None:
+        """Collect APIRouters from all plugins and include them in the FastAPI app."""
+        routers = self.pm.hook.showrunner_get_routes()
+        for router in routers:
+            if router is not None:
+                self.api.include_router(router)
+
+    def startup(self) -> None:
+        """Invoke the startup hook on all plugins and start the config watcher."""
+        self.pm.hook.showrunner_startup(app=self)
+
+        if self._config_path is not None:
+            self._config_watcher = ConfigWatcher(self._config_path, self)
+            self._config_watcher.start()
+            logger.info("Watching %s for changes", self._config_path)
+            print(f"  Config:     {self._config_path} (watching for changes)")
+
+    def shutdown(self) -> None:
+        """Invoke the shutdown hook on all plugins and stop the config watcher."""
+        if self._config_watcher is not None:
+            self._config_watcher.stop()
+            self._config_watcher = None
+        self.pm.hook.showrunner_shutdown(app=self)
+
+    def list_plugins(self) -> list[dict]:
+        """Return metadata from all registered plugins."""
+        return self.pm.hook.showrunner_register()
+
+    def list_commands(self) -> list[dict]:
+        """Collect CLI commands from all plugins."""
+        results = self.pm.hook.showrunner_get_commands()
+        # Flatten the list-of-lists into a single list
+        return [cmd for group in results if group for cmd in group]
+
+
+def _create_app() -> FastAPI:
+    """Create and start a ShowRunner instance, returning its FastAPI app.
+
+    Used as the ASGI entry point for ``uvicorn showrunner.app:app --reload``.
+    """
+    show = ShowRunner()
+    show.startup()
+    return show.api
+
+
+def __getattr__(name: str):
+    if name == "app":
+        globals()["app"] = _create_app()
+        return globals()["app"]
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")