plesty-sdk
plesty-sdk is the official command-line tool for developing Python modules that comply with the Plesty standard. It provides tools for enforcing code hygiene, managing documentation, applying license headers, scaffolding new projects, and generating device manuals.
Installation
pip install plesty-sdk
After installation, the plesty command is available in your environment.
The --project-dir option
All plesty commands operate on a Python project directory. By default this is the current
working directory, but you can point to any directory using the global --project-dir (-d)
option:
plesty --project-dir /path/to/my-project check
plesty -d ../my-device docs serve
Every command reads pyproject.toml, the .plesty cache, and all source paths relative to
this directory.
The --quiet option
The second global option, --quiet (-q), suppresses progress and guidance output —
plesty check’s per-gate progress lines, the numbered Next steps plesty init ends
with. Failures, their guidance, and the result line always print, so a quiet run still
says what broke and whether it passed:
plesty --quiet check
plesty -q --project-dir plesty-foo-bar init device
Global options go before the command name: plesty --quiet check, not
plesty check --quiet.
Commands at a glance
Command |
Description |
|---|---|
Validate a project against a Plesty compliance level |
|
Scaffold new library, device, analyzer or experiment projects from templates, and add a mock test or field test to an existing device |
|
Serve or deploy the project documentation |
|
Apply and sync SPDX license headers |
|
Generate Markdown/PDF manuals from a device’s |
|
Update author, name, CI standard, pre-push hook or snapshot versioning in an existing project |