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.2.tar.gz (52.3 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.2-py3-none-any.whl (90.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mpt_extension_sdk-6.3.2.tar.gz
Algorithm Hash digest
SHA256 9a0f037321fe1c8320aa9419d24d8abffb178f034317becf844d060292564f81
MD5 64ade9e3c62952d4fa0fee90ee9ab8c7
BLAKE2b-256 5b41f92c632fc60447da1ad8278e679bbaa09364302d12ad884619ac4aed9aeb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mpt_extension_sdk-6.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2ac0e5a87ef45d2c7e7c3998930ae1ddf2f5983a4e5075b8f6821986fcbc890d
MD5 dd0bcfa945c4834232db0de7a20a2592
BLAKE2b-256 75910507c7518e2f67ee72e7e93cd3a8cd622a8f953b496219522bfc4caaaac3

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