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.4.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 | |
|---|---|---|---|
| plesty_sdk-0.4.1.tar.gz | 366.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| plesty_sdk-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 541.1 kB
Release files / plesty_sdk-0.4.1.tar.gz
| Download URL | plesty_sdk-0.4.1.tar.gz |
|---|---|
| Size | 366.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
44592e40b611da34c0207988354fdcd60a6e9e5de405135d8f57b45f9f75804a
|
|
BLAKE2b-256 checksum How to use checksums |
e8bb8c4d261562e68433a04991c952050e6ffe9c80b396fa21ef5545cdfd49eb
|
| 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.4.1-py3-none-any.whl
| Download URL | plesty_sdk-0.4.1-py3-none-any.whl |
|---|---|
| Size | 174.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28ddaad0b149f2a575d18496fe3bf3e69651820a34a791930e6b0049533f74e7
|
|
BLAKE2b-256 checksum How to use checksums |
fc54bd2e3990cc6b6172b1af34da217bf66f6e1815226c047073fc4dc148ce16
|
| 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}
|
