Command-line application for developing Python modules compliant with the Plesty standard.
Project description
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. Run the full [SDK] compliance check manually at any time
plesty check
# 4. 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).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file plesty_sdk-0.2.3.tar.gz.
File metadata
- Download URL: plesty_sdk-0.2.3.tar.gz
- Upload date:
- Size: 218.2 kB
- Tags: Source
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd61e83738d1baaf5578acce59195fadf64ede07404cf3bdc99318a94ab7f3bb
|
|
| MD5 |
3d5b12ade5ed69231e1cb4be01657b90
|
|
| BLAKE2b-256 |
39546ab4a8c1380dbec89a346bd4dd21b509afa460e70f3dd3aec8488b1a6b78
|
File details
Details for the file plesty_sdk-0.2.3-py3-none-any.whl.
File metadata
- Download URL: plesty_sdk-0.2.3-py3-none-any.whl
- Upload date:
- Size: 92.0 kB
- Tags: Python 3
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d7be250236c232ed0e24836ccfae0fae31238a5838893622926ce5c5edc148b0
|
|
| MD5 |
ead29901dcff4704fb4a0f03fd672532
|
|
| BLAKE2b-256 |
10fea85b6ee53d14fadbfc67ec0271f68aa83e24d82725e4f90c972d90e0e185
|
