Skip to main content

EthisysCore Plugin SDK for Python — build container-hosted plugins

Project description

EthisysCore Python Plugin SDK

ethisyscore-plugin-sdk — Build container-mode plugins with Python 3.11+.

Container plugins run as isolated Docker containers with Dapr sidecars, communicating with the EthisysCore platform via HTTP. Built on FastAPI and Pydantic.

Installation

pip install ethisyscore-plugin-sdk

Quick Start

from ethisyscore_plugin_sdk import (
    PluginBase, PluginHost, PluginManifest, McpToolDefinition,
    ToolResult, PluginContext,
)

class GreeterPlugin(PluginBase):
    @property
    def manifest(self) -> PluginManifest:
        return PluginManifest(
            id="greeter",
            name="Greeter Plugin",
            version="1.0.0",
            type="TenantPlugin",
            owner="acme-corp",
            compatible_core_version=">=1.0.0",
            mcp_version="1.0",
            execution_mode="Container",
            mcp_tools=[
                McpToolDefinition(
                    name="greet",
                    description="Say hello",
                    input_schema_json='{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}'
                )
            ],
        )

    async def on_invoke_tool(self, tool_name: str, args: dict, context: PluginContext) -> ToolResult:
        if tool_name == "greet":
            name = args.get("name", "World")
            return ToolResult(success=True, result_json=f'{{"greeting": "Hello, {name}!"}}')
        return ToolResult(success=False, error=f"Unknown tool: {tool_name}")

if __name__ == "__main__":
    PluginHost(GreeterPlugin()).start()

Lifecycle Hooks

All hooks are optional — override only what you need:

async def on_initialize(self, context: PluginContext) -> None     # After platform connects
async def on_enable(self, context: PluginContext) -> None         # Extension enabled for tenant
async def on_disable(self, context: PluginContext) -> None        # Extension disabled
async def on_get_resource(self, uri: str, context: PluginContext) -> ResourceResult
async def on_check_health(self) -> HealthResult                   # Health probe

Platform Services

Available through PluginContext:

# Key-value persistence (per plugin per tenant)
count = (await context.data_store.get("counter")) or 0
await context.data_store.set("counter", count + 1)

# Structured logging (synchronous — no await needed)
context.logger.info("Processing request")
context.logger.error("Something failed")

# Invoke tools from other plugins
result = await context.mcp_client.invoke_tool("other-tool", '{"key": "value"}')

# Publish domain events
await context.publish_event("ItemCreated", {"id": "123"})

Type Safety

Protocol-based typing for IDE autocompletion:

  • PluginDataStoreProtocolget(), set(), delete(), exists(), list_keys(), query()
  • PluginLoggerProtocolinfo(), warning(), error(), debug()
  • McpClientProtocolinvoke_tool(tool_name, arguments_json), list_tools(), get_resource(), list_resources()

Manifest fields accept both snake_case and camelCase (Pydantic populate_by_name).

HTTP Endpoints

PluginHost starts a Uvicorn/FastAPI server (port: DAPR_APP_PORT or 8080):

Endpoint Method Purpose
/plugin/initialize POST Platform connects, provides context
/plugin/enable POST Extension enabled for tenant
/plugin/disable POST Extension disabled
/plugin/invoke-tool POST MCP tool invocation
/plugin/get-resource POST MCP resource read
/plugin/health GET Health probe
/plugin/heartbeat GET Liveness check

Environment Variables

Variable Purpose Default
DAPR_APP_PORT Port the plugin listens on 8080
DAPR_HTTP_PORT Dapr sidecar HTTP port 3500
DAPR_API_TOKEN Dapr sidecar auth token

v1 Limitations

Compared to the .NET SDK:

  • Monolithic dispatch — all tools route through on_invoke_tool() (no handler-per-tool classes)
  • No middleware pipeline — no built-in error handling, logging, or validation middleware
  • No DI container — plugins manage their own dependencies

Handler-per-tool, middleware, and DI are planned for v2.

Development

pip install -e ".[dev]"
pytest

Dependencies: fastapi>=0.115.0, uvicorn[standard]>=0.32.0, httpx>=0.27.0, pydantic>=2.10.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ethisyscore_plugin_sdk-1.0.0a4.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ethisyscore_plugin_sdk-1.0.0a4-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file ethisyscore_plugin_sdk-1.0.0a4.tar.gz.

File metadata

  • Download URL: ethisyscore_plugin_sdk-1.0.0a4.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ethisyscore_plugin_sdk-1.0.0a4.tar.gz
Algorithm Hash digest
SHA256 3e24373cfa19bae27ed3078084a150c3c0ed7dc722aaebb4b9a4e9906272875a
MD5 347dfdd9cd416dd4c0d202c08ffadca8
BLAKE2b-256 272fdbbe3ccba0cf237f1aa8face9e8d1d2dd20cee7e26aa9762e29735e4da07

See more details on using hashes here.

Provenance

The following attestation bundles were made for ethisyscore_plugin_sdk-1.0.0a4.tar.gz:

Publisher: release.yml on ethisysltd/ethisyscore-plugin-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ethisyscore_plugin_sdk-1.0.0a4-py3-none-any.whl.

File metadata

File hashes

Hashes for ethisyscore_plugin_sdk-1.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 886b9138f043a4dad62f37f8e983df49072af869064e4c084ae0315a6a6bc749
MD5 f1910477c7a08d8911385fecb7588930
BLAKE2b-256 ee179d8d6865284f7dd1daf4261cb2ee79281ae38a159f6130a3cf549f6b0bdd

See more details on using hashes here.

Provenance

The following attestation bundles were made for ethisyscore_plugin_sdk-1.0.0a4-py3-none-any.whl:

Publisher: release.yml on ethisysltd/ethisyscore-plugin-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page