Skip to main content

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

Metadata

Release files for plesty-sdk 0.4.2

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.4.2
File Size Uploaded Provenance
plesty_sdk-0.4.2.tar.gz 369.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for plesty-sdk 0.4.2
File Interpreter ABI Platform
plesty_sdk-0.4.2-py3-none-any.whl Python 3 none any Details

Total release size: 545.6 kB

Release files / plesty_sdk-0.4.2.tar.gz

Download URL plesty_sdk-0.4.2.tar.gz
Size 369.7 kB
Tags Source
SHA-256 checksum
How to use checksums
09455fa2178bb56d4d951579d1a589284e19b6126efbfeb431e724568070b996
BLAKE2b-256 checksum
How to use checksums
e637fab06067a3392eead35a7a30bb629245257bd1d0c06a0d1adf7db0b3b82e
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.2-py3-none-any.whl

Download URL plesty_sdk-0.4.2-py3-none-any.whl
Size 175.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7401b6b32ffc30eab892be0dcff5401ccb98d4d7810ffb8f65eeddcb804e14cf
BLAKE2b-256 checksum
How to use checksums
054886f1912ced9c02db9b4c63991aa1d0618310071eeccce04497cbbc24958b
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.4.2

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page