3lc-compute-plugin-sdk

The public Python SDK for building 3LC compute-service plugins — the import-light contract a plugin programs against. Install this (not the full service) and you have everything you need to write, run, and serve a plugin.

pip install 3lc-compute-plugin-sdk          # import name: tlc_plugin_sdk

What it gives you

• ComputePlugin — the base class you subclass. Implement compute / get_ui_fragment; job and lifecycle hooks ship as no-op defaults.

• JobContext — the surface a long-running job programs against: progress / metric / log / result, emit for rich UI, and cooperative cancelled.

• The worker (python -m tlc_plugin_sdk.worker) — serves your plugin’s Litestar route handlers as an ASGI app, out-of-process in the plugin’s own venv.

Contents

• 3LC Compute Service — Plugin Development Guide
  • Overview
  • Architecture
  • Plugin Types
  • Step-by-Step: Creating a Plugin
  • The PLUGIN_API Bridge
  • Custom REST Endpoints
  • Long-Running Jobs (run_job(ctx))
  • Real-Time Updates: window.PluginJobs + custom events
  • The job page is a launcher — the Queue is the durable view
  • Styling & UI Conventions
  • Existing Plugins Reference
  • The Dev Loop (Development)
  • Version & Compatibility
  • Publishing via a Catalog
  • Checklist
  • For AI coding agents
• API reference
  • The contract
  • The browser contract
  • The worker
  • Shared utilities