feat: Implement Sideline plugin system with consistent terminology

This commit implements the Sideline/Mainline split with a clean plugin architecture:

## Core Changes

### Sideline Framework (New Directory)
- Created  directory containing the reusable pipeline framework
- Moved pipeline core, controllers, adapters, and registry to
- Moved display system to
- Moved effects system to
- Created plugin system with security and compatibility management in
- Created preset pack system with ASCII art encoding in
- Added default font (Corptic) to
- Added terminal ANSI constants to

### Mainline Application (Updated)
- Created  for Mainline stage component registration
- Updated  to register Mainline stages at startup
- Updated  as a compatibility shim re-exporting from sideline

### Terminology Consistency
- : Base class for all pipeline components (sources, effects, displays, cameras)
- : Base class for distributable plugin packages (was )
- : Base class for visual effects (was )
- Backward compatibility aliases maintained for existing code

## Key Features
- Plugin discovery via entry points and explicit registration
- Security permissions system for plugins
- Compatibility management with semantic version constraints
- Preset pack system for distributable configurations
- Default font bundled with Sideline (Corptic.otf)

## Testing
- Updated tests to register Mainline stages before discovery
- All StageRegistry tests passing

Note: This is a major refactoring that separates the framework (Sideline) from the application (Mainline), enabling Sideline to be used by other applications.
This commit is contained in:
2026-03-23 20:42:33 -07:00
parent 2d28e92594
commit e4b143ff36
58 changed files with 10163 additions and 50 deletions

78
sideline/plugins/base.py Normal file
View File

@@ -0,0 +1,78 @@
"""
Base classes for Sideline plugins.
Provides Plugin base class and PluginMetadata for plugin registration.
"""
from abc import ABC, abstractmethod
from dataclasses import dataclass, field
from typing import ClassVar, Set
@dataclass
class PluginMetadata:
"""Plugin metadata with security and compatibility information."""
name: str
version: str
author: str
description: str
sideline_version: str # Compatible Sideline version (semver constraint)
permissions: Set[str] = field(default_factory=set) # Required security permissions
capabilities: Set[str] = field(default_factory=set) # Provided capabilities
def validate(self) -> None:
"""Validate metadata fields."""
if not self.name:
raise ValueError("Plugin name cannot be empty")
if not self.version:
raise ValueError("Plugin version cannot be empty")
if not self.author:
raise ValueError("Plugin author cannot be empty")
if not self.sideline_version:
raise ValueError("Plugin sideline_version cannot be empty")
class StagePlugin(ABC):
"""Base class for Sideline stage plugins (distributable pipeline components).
A StagePlugin represents a distributable unit that can contain one or more
pipeline stages. Plugins provide metadata for security, compatibility,
and versioning.
Subclasses must implement:
- validate_security(granted_permissions) -> bool
"""
metadata: ClassVar[PluginMetadata]
@abstractmethod
def validate_security(self, granted_permissions: Set[str]) -> bool:
"""Check if plugin has required permissions.
Args:
granted_permissions: Set of granted security permissions
Returns:
True if plugin has all required permissions
"""
pass
@classmethod
def get_metadata(cls) -> PluginMetadata:
"""Get plugin metadata."""
return cls.metadata
@classmethod
def get_required_permissions(cls) -> Set[str]:
"""Get required security permissions."""
return cls.metadata.permissions
@classmethod
def get_provided_capabilities(cls) -> Set[str]:
"""Get provided capabilities."""
return cls.metadata.capabilities
# Backward compatibility alias
Plugin = StagePlugin