ZLayer Python SDK
Plugin Development Kit for building WASM plugins in Python targeting ZLayer.
Requirements
- Python 3.11+
- componentize-py for WASM compilation
Installation
# Using uv (recommended)
uv add zlayer-sdk
# Or with pip
pip install zlayer-sdk
Development Setup
# Clone and install in development mode
cd clients/zlayer-sdk/python
uv sync --all-extras
# Install componentize-py for WASM compilation
uv add --dev componentize-py
Usage
Basic Plugin Structure
from zlayer import kv, log
def handle_request(request: bytes) -> bytes:
"""Plugin entry point called by ZLayer runtime."""
# Access key-value storage
value = kv.get("my-key")
# Log messages to host
log.info("Processing request")
# Return response
return b"OK"
Building WASM Component
# Generate WIT bindings and compile to WASM
componentize-py -d ../../wit -w zlayer-plugin componentize my_plugin -o my_plugin.wasm
Available Host Capabilities
The SDK provides access to ZLayer host functions:
- kv - Key-value storage operations
- log - Structured logging
- http - Outbound HTTP requests
- config - Plugin configuration access
Project Structure
zlayer/
__init__.py # Package root with version
py.typed # PEP 561 type marker
examples/
.gitkeep # Example plugins (coming soon)
Type Checking
This package is fully typed and includes a py.typed marker for PEP 561 compliance.
# Run type checks
uv run mypy zlayer/
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for zlayer-sdk 0.14.3
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 | |
|---|---|---|---|---|
| zlayer_sdk-0.14.3.tar.gz | 11.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zlayer_sdk-0.14.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.4 kB
Release files / zlayer_sdk-0.14.3.tar.gz
| Download URL | zlayer_sdk-0.14.3.tar.gz |
|---|---|
| Size | 11.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
128aaa55632361368c6e7cc50f2d95184cf48bfccfde71a77cd888dff1e48476
|
|
BLAKE2b-256 checksum How to use checksums |
6dfa3a6193d60e5398e2b4beca7ee5326ffb699e8abf4338fc7dfc061bc95512
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Release files / zlayer_sdk-0.14.3-py3-none-any.whl
| Download URL | zlayer_sdk-0.14.3-py3-none-any.whl |
|---|---|
| Size | 11.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
353cd43e5acc10b9a9ef3d414bc10fca5c29fdf6c09a0747b6a89403bc249290
|
|
BLAKE2b-256 checksum How to use checksums |
3261673daa947839801243b592dcd38b82e4ee35c5e4b2832860efb6623b077c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Security for zlayer-sdk 0.14.3
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.
