yams-sdk
Python SDK for building YAMS plugins.
Installation
pip install yams-sdk
Quick Start
Create a plugin:
from yams_sdk import BasePlugin, rpc
class MyPlugin(BasePlugin):
def manifest(self):
return {
"name": "my_plugin",
"version": "1.0.0",
"interfaces": ["content_extractor_v1"]
}
@rpc("extractor.extract")
def extract(self, source: dict) -> dict:
return {"text": "extracted content", "metadata": {}}
if __name__ == "__main__":
MyPlugin().run()
Test it:
echo '{"id":1,"method":"handshake.manifest"}' | python my_plugin.py
Use with YAMS
# Trust your plugin
yams plugin trust add /path/to/my_plugin.py
# Load it
yams plugin load my_plugin.py
# Verify
yams plugin list
Documentation
- Developer Guide - Testing, contributing, publishing
- API Reference - Module and interface documentation
- Examples - Real plugin implementations
License
GPL-3.0-only
1 maintainer
Metadata
1 maintainer
Release files for yams-sdk 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| yams_sdk-0.0.1.tar.gz | 36.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yams_sdk-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 74.8 kB
Release files / yams_sdk-0.0.1.tar.gz
| Download URL | yams_sdk-0.0.1.tar.gz |
|---|---|
| Size | 36.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
babe84348a43de34eb31226137cc8a8b3a67eb8de7c99afdc3d11a15a4241544
|
|
BLAKE2b-256 checksum How to use checksums |
db308f65ef5a27cb06873ddf94444779d972dada9d51013497d8957f975f7f2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / yams_sdk-0.0.1-py3-none-any.whl
| Download URL | yams_sdk-0.0.1-py3-none-any.whl |
|---|---|
| Size | 37.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa68347b2f75773ec8ff0350344a934f9f56c12ccf237fcc6e4a382adb4c7366
|
|
BLAKE2b-256 checksum How to use checksums |
406c3676842e0e41629702b73998c98d84871e22903b32370ec0b3e400faab0d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for yams-sdk 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
