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.3.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.3.tar.gz.
File metadata
- Download URL: nself_plugin_sdk-1.3.3.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 |
11924b525cc3c2dbccdd836fabdd972e6f2c12a34258353d9adeac5202ddf182
|
|
| MD5 |
3430d1830e560b37b71d064740f88be5
|
|
| BLAKE2b-256 |
0820dc7bf0e368fae35a5820d16d7c3c26c93a688d0582e85adac3028c62e5b6
|
File details
Details for the file nself_plugin_sdk-1.3.3-py3-none-any.whl.
File metadata
- Download URL: nself_plugin_sdk-1.3.3-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 |
cff285301e55d4f55a8793675f376419e4cff7b59cb8e2bf899c6b2178692b86
|
|
| MD5 |
f5571b56d1020714fc8882fdba9c97de
|
|
| BLAKE2b-256 |
8efb225f97f5cc2538fefbe5e91679b946577063f324caa2f7a71434c757b33a
|
