Skip to main content

Extensions SDK for SoftwareONE Marketplace Platform

Project description

SDK Usage

This guide is the entry point for building an extension package on top of mpt-extension-sdk. Topic-specific examples live in smaller documents under sdk_usage/.

Usage Topics

  • Application setup: install the SDK, shape an extension package, create ExtensionApp, include routers, and configure the runtime.
  • Event routes: register task and non-task event handlers.
  • Authenticated API routes: expose authenticated endpoints, validate bodies, read request/auth context, return API responses, and use pagination.
  • UI plugs: register PlugRouter providers and reference static assets.
  • Contexts and pipelines: adapt execution contexts and compose processing pipelines.
  • Marketplace services: use ctx.mpt_api_service from handlers and pipeline steps.

Runtime Commands

Use the mpt-ext CLI command when running an extension built on top of the SDK:

mpt-ext run --local
mpt-ext run
mpt-ext meta generate
mpt-ext meta validate
  • mpt-ext run --local starts the local FastAPI + uvicorn runtime.
  • mpt-ext run writes meta.yaml, registers the extension instance, and starts the platform runtime with mrok/ziticorn.
  • mpt-ext meta generate writes metadata derived from ext_app.to_meta_config().
  • mpt-ext meta validate compares the checked-in meta.yaml with generated metadata, validates plug static assets, and writes meta.generated.yaml when validation fails.

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

mpt_extension_sdk-6.2.0.tar.gz (52.6 kB view details)

Uploaded Source

Built Distribution

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

mpt_extension_sdk-6.2.0-py3-none-any.whl (90.9 kB view details)

Uploaded Python 3

File details

Details for the file mpt_extension_sdk-6.2.0.tar.gz.

File metadata

  • Download URL: mpt_extension_sdk-6.2.0.tar.gz
  • Upload date:
  • Size: 52.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.22

File hashes

Hashes for mpt_extension_sdk-6.2.0.tar.gz
Algorithm Hash digest
SHA256 1768514250be478b6490198e4aa26c736897f27a2de8693bd662901025b10fe5
MD5 2164fd8a0684e1ffdb7135577bdd52fb
BLAKE2b-256 d604a25464094a605c932b3a239a2aec155986c66d75f528ba65d18ae356563c

See more details on using hashes here.

File details

Details for the file mpt_extension_sdk-6.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mpt_extension_sdk-6.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65c388e6a700bca547b7ae5ac236bbf5b3062da1ef25597e258c3064c8094ad0
MD5 b1e7e094e1c13950c1143ba2a48402f0
BLAKE2b-256 94545d21804f14064bb3f836a3ec7566f63da931f80c4e03db7efdbe9265e910

See more details on using hashes here.

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