Overview¶
Welcome to the Prism Pipeline Python API documentation. This documentation provides comprehensive reference material for developers working with or extending the Prism Pipeline.
Quick Links¶
- API Reference - Browse the complete Python API documentation
- Prism Pipeline Website - Official Prism website
- GitHub Repository - Source code of Prism Core and open source plugins
- User Documentation - Prism Documentation for artists
Getting Started¶
The Prism Pipeline is built around several core modules:
- PrismCore - The main application core and central orchestrator
- PrismTray - System tray functionality for quick access
- PrismInstaller - Installation and DCC integration setup
- PrismSettings - User and application settings management
- ProjectSettings - Project-specific configuration
- PrismUtils - Utility modules for callbacks, plugins, configuration, and more
- Project Scripts - Project and asset management tools
Quick Example¶
import PrismCore
# Initialize Prism Core
core = PrismCore.create(prismArgs=["noUI"])
# Change to a project
core.changeProject("/path/to/project")
# Access utilities
print(core.projectName)
Documentation Structure¶
API Reference¶
Complete Python API reference with detailed documentation for all public classes, methods, and functions. Includes type annotations, parameter descriptions, and source code links.