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.3.0.tar.gz (52.2 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.3.0-py3-none-any.whl (90.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mpt_extension_sdk-6.3.0.tar.gz
Algorithm Hash digest
SHA256 d46517bf0f99357bbcadd91dc0b8d599766149e798b2568e0b4d67fbc14f46c4
MD5 482592da3ab89a3be7c504d2110c93e3
BLAKE2b-256 d7b8f28cfafee9721b252ff85c24466b5c41e213328e4f7d220a03cdad1c7e2b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mpt_extension_sdk-6.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae97753f7bb067349435e7f32c3032cbc0d221677f15cd5c7fc6d02278ad08af
MD5 d41a1050e9e99e8eb0f66eaf8ecc8f2c
BLAKE2b-256 9faf7f8ade7edb3c0d62ebe96ad5a36d39ac15f2c3124779665f1130274a4760

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