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.
Commands at a glance#
Command |
Description |
|---|---|
Validate a project against a Plesty compliance level |
|
Scaffold new device or experiment projects from templates |
|
Serve or deploy the project documentation |
|
Apply and sync SPDX license headers |
|
Generate Markdown/PDF manuals from a device’s |
|
Update author, name, or CI stages in an existing project |