eyeriss-plugin-sdk 0.1.2

Official Python SDK for building plugins for the Eyeriss API Gateway. Provides the base class, hook types, and data structures for Python and WASM plugin development.

Eyeriss Plugin SDK

Official Python SDK for building plugins for the Eyeriss API Gateway.

Installation

pip install eyeriss-plugin-sdk

Quick Start

Create a plugin directory with manifest.json, plugin.py, and eyeriss.sig:

from eyeriss_plugin_sdk import EyerissPlugin
from eyeriss_plugin_sdk.types import PluginContext, PluginResult

class Plugin(EyerissPlugin):
    @property
    def plugin_id(self) -> str:
        return "my-plugin"  # Must match manifest.json id

    async def pre_request(self, context: PluginContext) -> PluginResult:
        return PluginResult(
            proceed=True,
            modified_headers={"X-Custom-Header": "value"},
        )

Or use the built-in scaffold:

docker compose exec django python manage.py plugin new my-plugin --type python

Hooks

Hook	When	Can Block?	Can Modify?
pre_request	After auth, before proxying	Yes (proceed=False)	Headers, body
post_response	After backend response	No	Headers, body
on_error	On gateway error	No	Nothing (observational)

Lifecycle

Method	Purpose
initialize()	One-time setup at gateway startup
configure(config)	Apply config from admin UI
cleanup()	Teardown on shutdown or removal

Blocking a Request

from eyeriss_plugin_sdk.types import PluginResult, ErrorResponse

async def pre_request(self, context: PluginContext) -> PluginResult:
    if should_block(context):
        return PluginResult(
            proceed=False,
            error_response=ErrorResponse(
                status_code=403,
                body={"error": "Request denied"},
            ),
        )
    return PluginResult(proceed=True)

Configuration

Define config_schema in your manifest.json to expose settings in the Management UI. Supported field types: text, number, boolean, select, textarea, file.

See the Config Schema Reference for details.

Documentation

• Quick Start — build your first plugin in 5 minutes
• Development Guide — full Python plugin reference
• Config Schema — config field types and options
• Testing Guide — test your plugins with pytest
• Marketplace — browse plugins and templates

License

MIT