=?utf-8?q?Public_plugin_contract_for_the_NeMo_Platform_=E2=80=94_the_only_package_plugin_authors_need=2E?=
Project description
nemo-platform-plugin
nemo-platform-plugin is the only package NeMo Platform plugin authors install. It re-exports all base classes, schemas, and utilities needed to build fully-featured NeMo Platform plugins.
Surfaces
| Surface | Base class | Entry-point group | Purpose |
|---|---|---|---|
| HTTP service | NemoService |
nemo.services |
Contributes FastAPI routers mounted at /apis/<name>/... |
| CLI | NemoCLI |
nemo.cli |
Contributes nemo <name> <cmd> subcommands |
| Job | NemoJob |
nemo.jobs |
Contributes schedulable, container-executable jobs. Auto-generates run / submit / explain CLI verbs. |
| Controller | NemoController |
nemo.controllers |
Contributes background reconcile-loop controllers |
| Configuration | NemoConfig |
(none)¹ | Typed plugin configuration with env var / YAML loading |
| Entity | NemoEntity |
(none)¹ | Entity definitions stored in the NeMo Platform entity store |
¹ Not discovered via entry-points — used directly by plugin code.
Installation
uv add nemo-platform-plugin nemo-platform
nemo-platform is required for entity client injection at runtime.
How plugins are discovered
Declare surfaces in pyproject.toml entry-point groups. Install the package and the platform picks them up at startup — no registration code needed. See QUICKSTART.md for the full template.
The name rule
Every surface class requires a non-empty name: ClassVar[str]. Checked at class-definition time — missing raises TypeError. Must exactly match the entry-point key; mismatch logs a warning at startup.
Next steps
- QUICKSTART.md — build your first plugin end-to-end
- SERVICE.md — HTTP routes, CRUD patterns, testing
- JOB.md — jobs, CLI commands, auto-generated job commands
- CONTROLLER.md — reconcile loops, state machines, service principal
- CONFIG.md — typed configuration, env vars, YAML, test overrides
- ENTITY.md — entity store, CRUD client, pagination, optimistic locking
- INFERENCE_MIDDLEWARE.md — inference request/response middleware, typed bodies, and response annotations
- ARCHITECTURE.md — discovery, startup, all surfaces, SDK surface
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 Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nemo_platform_plugin-0.1.0-py3-none-any.whl.
File metadata
- Download URL: nemo_platform_plugin-0.1.0-py3-none-any.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
91c985ef9ab49693589aae42ccd06def48ea4bea72b672501c08c313169f1dc1
|
|
| MD5 |
5f1b04db6a036398fc23a523116acf65
|
|
| BLAKE2b-256 |
5175b6244928413cac90c71e15bb063417b1cb9823f697ce23e2e3b533633b42
|