plesty-sdk
The official command-line tool for developing Python modules compliant with the Plesty standard. It provides project scaffolding, compliance checking, documentation tooling, REUSE license compliance, and device manual generation.
Installation
pip install plesty-sdk
After installation the plesty command is available in your environment. For development
inside the SDK repository itself, use uv run plesty.
Quick start
# 1. Scaffold a new device module
mkdir plesty-power-meter && cd plesty-power-meter
plesty init device --author "Jane Doe" --email jane@example.com
# 2. Develop your module — the pre-push hook runs compliance checks automatically
# 3. Drive the instrument from a control panel built out of your device schema
uv sync --extra gui
python -m plesty.power_meter --gui
# 4. Run the full [SDK] compliance check manually at any time
plesty check
# 5. Preview the documentation locally
plesty docs serve
Commands
| Command | Description |
|---|---|
plesty init |
Scaffold a new device or experiment module from the official template |
plesty check |
Validate a project against the Plesty compliance standard |
plesty docs serve |
Preview documentation locally with live reload |
plesty docs deploy |
Build and push documentation to a remote pages branch |
plesty license update |
Ensure the declared license text exists in LICENSES/ and verify REUSE compliance |
plesty license lint |
Check the project against the REUSE specification |
plesty manual generate |
Generate Markdown/PDF reference manuals from a DocDevice class |
plesty update |
Update author, name, or CI stages in an existing project |
Full documentation is available at the project's GitLab Pages site and locally via
plesty docs serve run from within this repository.
License
plesty-sdk is free software licensed under the GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later).
1 maintainer
Metadata
1 maintainer
Release files for plesty-sdk 0.5.6
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 | Actions |
|---|---|---|---|---|
| plesty_sdk-0.5.6.tar.gz | 416.4 kB | Without provenance | Details for plesty_sdk-0.5.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| plesty_sdk-0.5.6-py3-none-any.whl | Python 3 | none | any | Details for plesty_sdk-0.5.6-py3-none-any.whl |
Total release size: 615.8 kB
Release files / plesty_sdk-0.5.6.tar.gz
| Download URL | plesty_sdk-0.5.6.tar.gz |
|---|---|
| Size | 416.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2fa464f2dc97e7adf298c34326af33f31f74a9acffaf04cce6c4ac8bafc42287
|
|
BLAKE2b-256 checksum How to use checksums |
c11efdb19c60b04f3bd87b74ac3d17cf4cb59c7046c53fa6f031f8410fb842e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","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":true}
|
Release files / plesty_sdk-0.5.6-py3-none-any.whl
| Download URL | plesty_sdk-0.5.6-py3-none-any.whl |
|---|---|
| Size | 199.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
62b040e1152a91502744086d9a0eee32d5d7a9dc857628726a4d649b5ae485dd
|
|
BLAKE2b-256 checksum How to use checksums |
d4bfbe458917e92145956bbe9fec71cac4e6ece9d4a61bc9342b11ce93ea10e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","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":true}
|
Security for plesty-sdk 0.5.6
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.
