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).

Release files for plesty-sdk 0.5.0.dev1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for plesty-sdk 0.5.0.dev1
File	Size	Uploaded
plesty_sdk-0.5.0.dev1.tar.gz	403.7 kB	Sep 25, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for plesty-sdk 0.5.0.dev1
File	Interpreter	ABI	Platform	Reset
plesty_sdk-0.5.0.dev1-py3-none-any.whl 194.9 kB Sep 25, 2026	Python 3	none	any	Details

Total release size: 598.6 kB

Release files / plesty_sdk-0.5.0.dev1.tar.gz

Download URL	plesty_sdk-0.5.0.dev1.tar.gz
Size	403.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`94c608d595006c59bf88acb968d45af05d3b51a326537a968849efe8792bc2c4`
BLAKE2b-256 checksum How to use checksums	`6d53cbc5e7e8cc3e0a2d5c1c444aed50d6bf787833703e1936c0d793ed33778e`
Upload date	Sep 25, 2026
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.0.dev1-py3-none-any.whl

Download URL	plesty_sdk-0.5.0.dev1-py3-none-any.whl
Size	194.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4e270d4860e2d55afb0cb6e506f01be87627109b966832a9b22cc91198489ccb`
BLAKE2b-256 checksum How to use checksums	`b03695ee6637207c11a9a433a242d681c8845853ac89bf3995555e84e6881f6d`
Upload date	Sep 25, 2026
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}`