Skip to main content

Aphelion Plugin SDK

Editor nodes, audio, inspector UI, windows, docks and commands are documented in the Editor SDK guide. New plugins use aphelion_sdk.editor.

Public API for plugins that run inside Aphelion Editor. This package sits beside aphelion-editor, not inside it.

Import aphelion_sdk only. Never import core, effects, render, or ui.

Video, audio, arbitrary graph nodes and editor extensions are available under aphelion_sdk.editor.

Version 0.1.0. Python 3.11+. Install with pip install aphelion-plugin-sdk. Import aphelion_sdk.

Install

pip install aphelion-plugin-sdk

From the aphelion-engine root, with a venv active:

pip install -e ./aphelion-editor
pip install -e ./aphelion-sdk

Installing the editor already depends on this package (aphelion-plugin-sdk @ file:../aphelion-sdk).

aphelion-sdk --version
python -m aphelion_sdk --help

Quick start

import aphelion_sdk


@aphelion_sdk.register_plugin
class GrayscaleEffect(aphelion_sdk.VideoEffectPlugin):
    plugin_name = "Grayscale"
    plugin_category = "Plugins"
    plugin_description = "Blend a frame toward grayscale."
    plugin_color = (140, 140, 140)

    def setup_effect_properties(self) -> None:
        self.set_property(
            "amount",
            aphelion_sdk.slider_property(
                100, 0, 100,
                label="Amount",
                suffix="%",
            ),
        )

    def process_frame(
        self,
        frame: aphelion_sdk.Frame,
        _frame_num: int,
    ) -> aphelion_sdk.Frame:
        amount = self.float_value("amount", 100.0) / 100.0
        luma = (
            frame[..., 0] * 0.2126
            + frame[..., 1] * 0.7152
            + frame[..., 2] * 0.0722
        )
        gray = luma[..., None].repeat(3, axis=2)
        return frame * (1.0 - amount) + gray * amount

Drop the file in the editor's plugins/ or userdata/plugins/, or pack a wheel (below). Time-independent effects should name the unused argument _frame_num.

Examples:

Documentation

Guide Contents
Authoring Effect class, properties, discovery rules
Widgets Panels, dialogs, primitives, PyQt6
API reference Public symbols
Packaging aphelion-sdk build, entry points, drop-in install
Editor plugins How the host loads and reloads plugins

Package a plugin

aphelion-sdk build examples/grayscale_effect.py -o dist
pip install dist/aphelion_plugin_grayscale-*.whl

Entry point group: aphelion.editor.plugins. Widgets are declared on the plugin (widgets = (MyDialog, MyPanel)); they are not registered on their own.

License

Proprietary (LicenseRef-Proprietary in pyproject.toml).

Metadata

Release files for aphelion-plugin-sdk 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aphelion-plugin-sdk 0.1.1
File Size Uploaded Provenance Actions
aphelion_plugin_sdk-0.1.1.tar.gz 28.7 kB Without provenance Details for aphelion_plugin_sdk-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aphelion-plugin-sdk 0.1.1
File Interpreter ABI Platform Actions
aphelion_plugin_sdk-0.1.1-py3-none-any.whl Python 3 none any Details for aphelion_plugin_sdk-0.1.1-py3-none-any.whl

Total release size: 70.2 kB

Release files / aphelion_plugin_sdk-0.1.1.tar.gz

Download URL aphelion_plugin_sdk-0.1.1.tar.gz
Size 28.7 kB
Tags Source
SHA-256 checksum
How to use checksums
168219bb9040c1f318dbc01c712367b47027d6d221e8e5a9a09508bb208d1edc
BLAKE2b-256 checksum
How to use checksums
00cfaaab72e9ce040eb17485508ab196f4a9451ed6d97ae93c12f317d92b5582
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Release files / aphelion_plugin_sdk-0.1.1-py3-none-any.whl

Download URL aphelion_plugin_sdk-0.1.1-py3-none-any.whl
Size 41.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c1480246bbbe94c08aa90e8c1fad9e2da9633e02779803c5cdd2af954c1ab9e6
BLAKE2b-256 checksum
How to use checksums
9362393d83cb5c10ce432581a9aa16043b2c4a0c193a9cd299c227e4ccf6cab8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Security for aphelion-plugin-sdk 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page