nself-plugin-sdk 1.2.5

Python plugin authoring SDK for nSelf. Parity with the Go SDK at github.com/nself-org/cli/sdk/go.

nself-plugin

Python plugin authoring SDK for nSelf. Parity with plugin-sdk-go v0.1.0.

Install

pip install nself-plugin

For database migrations:

pip install 'nself-plugin[db]'

Quick start

from nself_plugin import Plugin, PluginContext, HealthStatus

plugin = Plugin(name="my-notify", version="1.0.0")

@plugin.install
async def install(ctx: PluginContext) -> None:
    ctx.env.require(["SMTP_HOST", "SMTP_PORT"])

@plugin.start
async def start(ctx: PluginContext) -> None:
    app = ctx.http.create_app()
    app.post("/notify/send")(handler)
    await ctx.http.listen(ctx.port)

@plugin.health
async def health(ctx: PluginContext) -> HealthStatus:
    return await ctx.http.ping("/notify/healthz")

Scaffold a plugin

nself plugin new my-plugin --lang python

License

MIT