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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
nself_plugin_sdk-1.3.2.tar.gz
(10.5 kB
view details)
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 nself_plugin_sdk-1.3.2.tar.gz.
File metadata
- Download URL: nself_plugin_sdk-1.3.2.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a5a16794aebc9ce42b146eb909379b225cca8cf65922ed2bf7b0d3103a8dfcb1
|
|
| MD5 |
56aa03e31f4bd0054e0b1658be0fb25a
|
|
| BLAKE2b-256 |
46ea1e4bd37b31c8332f1cd717c0a30e3708bafd806f7b2bece78d6ed02428b9
|
File details
Details for the file nself_plugin_sdk-1.3.2-py3-none-any.whl.
File metadata
- Download URL: nself_plugin_sdk-1.3.2-py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a1ec8cababc8b6451654fbfb9daf54241d0086230f7bf29a2366953bf4459345
|
|
| MD5 |
f719663957059b619057f6161ba06ea8
|
|
| BLAKE2b-256 |
3ad6cb107e34684fb03e9f97d0184217642079ee8a2ed101728d1dab624be269
|
