YLPlugin — native plugin containers for Python
Read public YLSpec metadata directly, inspect and build indexed .ylplugin
containers, verify resources and signatures, and check host compatibility before
activating a plugin. Python calls the shared native C/C++ core through a typed
ctypes API; metadata uses the original native YLSpec parser.
This README describes 0.1.3. The standalone metadata APIs and bundled CLI are new in that version; 0.1.2 platform wheels contain the SDK runtime only.
Install the SDK, core and command together
python -m pip install ylplugin
ylplugin --version
python -m ylplugin --version
Supported platform wheels include both the native SDK runtime and the native
ylplugin executable. Pip registers the command in the active environment's
scripts directory. A virtual environment exposes it while activated; --user
installs require Python's user scripts directory on PATH. Administrator access,
a separate core download, an import-time network request and a C++ compiler are
not required for a supported wheel installation.
Wheels target Python 3.11+, Linux x86_64/ARM64 (glibc 2.39+), macOS x86_64/ARM64
(macOS 11+), and Windows x86_64. Source checkouts and unsupported systems require
a native build. Set YLPLUGIN_LIBRARY or pass Library('/absolute/runtime/path')
for a source-built SDK, and set YLPLUGIN_CLI for its executable. Native and
Python versions must match. Wheels contain their matching core; the Python
ylspec package is not a separate dependency.
Discover plugin information with bounded reads
import tomllib
from ylplugin import Library, Limits
sdk = Library()
metadata = sdk.read_metadata("package.ylplugin", Limits(metadata=1024 * 1024))
plugin_info = tomllib.loads(metadata)["data"]
print(plugin_info["id"], plugin_info["version"])
This reads only the 128-byte container header and its YLSpec metadata frame.
It does not construct a Package, scan the TOC, read resources, decrypt payloads
or read the signature region. A host-provided range source can use
sdk.read_metadata_reader(size, reader, limits), where reader(offset, count)
returns exactly the requested bytes. No second Python format parser is involved.
ylplugin metadata package.ylplugin
ylplugin metadata package.ylplugin --json
Discovery returns canonical TOML and unverified claims. It does not establish
payload integrity, authentic publisher identity or safe execution. --json
labels its scope metadata-only and integrity UNVERIFIED. A file handle is
opened to read the requested ranges; the complete file is not read or loaded.
Validate and read a resource
import json
from ylplugin import Library
with Library().open("data.ylplugin") as plugin:
plugin.validate()
print(json.loads(plugin.read("catalog.json"))["total"])
print(plugin.targets)
Library.create/sign and Package.metadata/inspect/targets/entrypoints/read/ read_slice/validate/verify/check/extract use the same core. open loads the
container index as well as metadata; use read_metadata for discovery alone.
Resource reads return bytes, metadata returns TOML, reports return dictionaries,
and permission integers remain exact Python integers. Use Limits and context
managers to control resources and deterministic handle cleanup.
Keys and trust providers are explicit host callbacks. Error.code exposes the
native status. Invalid ranges, bool limits and NUL paths fail before ctypes can
truncate them. A handle serializes operations and rejects callback close/reentry.
Signature verification and host preflight remain separate operations.
CLI and documentation
The installed command launches the native CLI, with create, metadata, inspect,
list, validate, check, extract, convert, sign, verify and encrypt operations.
ylplugin --help lists their arguments. The SDK and CLI do not execute plugin
code during discovery, validation or preflight, and are not an OS sandbox.
YLPlugin is experimental and licensed LGPL-3.0-only. License texts, project source archives and dependency notices ship with platform wheels. Third-party components retain their own licenses. See licensing and corresponding sources.
Metadata
Release files for ylplugin 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| ylplugin-0.1.3-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details for ylplugin-0.1.3-py3-none-win_amd64.whl |
| ylplugin-0.1.3-py3-none-manylinux_2_39_x86_64.whl | Python 3 | none | Linux glibc 2.39+ x86-64 | Details for ylplugin-0.1.3-py3-none-manylinux_2_39_x86_64.whl |
| ylplugin-0.1.3-py3-none-manylinux_2_39_aarch64.whl | Python 3 | none | Linux glibc 2.39+ ARM64 | Details for ylplugin-0.1.3-py3-none-manylinux_2_39_aarch64.whl |
| ylplugin-0.1.3-py3-none-macosx_11_0_x86_64.whl | Python 3 | none | macOS 11.0+ x86-64 | Details for ylplugin-0.1.3-py3-none-macosx_11_0_x86_64.whl |
| ylplugin-0.1.3-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details for ylplugin-0.1.3-py3-none-macosx_11_0_arm64.whl |
Total release size: 25.2 MB
Release files / ylplugin-0.1.3-py3-none-win_amd64.whl
| Download URL | ylplugin-0.1.3-py3-none-win_amd64.whl |
|---|---|
| Size | 4.7 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ac167d67ffba6551d51b8a36278ac58232984fee1f26631d8e06b2b7e028502e
|
|
BLAKE2b-256 checksum How to use checksums |
8359dea2195f13930503148b21a6eba48e4583c5fed475ae6a4bb8ddf2aae858
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / ylplugin-0.1.3-py3-none-manylinux_2_39_x86_64.whl
| Download URL | ylplugin-0.1.3-py3-none-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | Linux glibc 2.39+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
61a8170329983a7b7f3d08c8882d6f95e54794016a5759199c8a6d9965e9a690
|
|
BLAKE2b-256 checksum How to use checksums |
d1ed33483c5cd772cd1b45123198572d0d4b79e21e55162ddaa00c0cff8b3c2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / ylplugin-0.1.3-py3-none-manylinux_2_39_aarch64.whl
| Download URL | ylplugin-0.1.3-py3-none-manylinux_2_39_aarch64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | Linux glibc 2.39+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
2c839fc941e9a87efa42fde01fda5bacce2945fcf39ab085e68256bb101eac2b
|
|
BLAKE2b-256 checksum How to use checksums |
ef51c61b146162ab31856ae25add572ac3b4e90205bd790bc87e7c419977853c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / ylplugin-0.1.3-py3-none-macosx_11_0_x86_64.whl
| Download URL | ylplugin-0.1.3-py3-none-macosx_11_0_x86_64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | Python 3 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
05a4a87d9759f5eb198d8c44ed3a4fabdb59bc9d05fda1f447de0963e4b2e2fd
|
|
BLAKE2b-256 checksum How to use checksums |
3dc2d63b153c4c6427f589718f2b5c0aa63f0d40967474c3d40b78efb8161eea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / ylplugin-0.1.3-py3-none-macosx_11_0_arm64.whl
| Download URL | ylplugin-0.1.3-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.4 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
81ca43514ffc8462c61a56fcbc61bdf2cde85c3157689365cddf4110a7473e62
|
|
BLAKE2b-256 checksum How to use checksums |
536c0be37a90d218b5177077c8ab61fcd870808b3ef884b40e98f2837c90810a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Security for ylplugin 0.1.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.