Metadata-Version: 2.4
Name: plesty-sdk
Version: 0.2.0
Summary: Command-line application for developing Python modules compliant with the Plesty standard.
Author: Plesty Development Team
License-Expression: LGPL-3.0-or-later
License-File: COPYING
License-File: COPYING.LESSER
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: bluesky>=1.14.6
Requires-Dist: click>=3.8
Requires-Dist: copier>=9.15.1
Requires-Dist: licenseheaders>=0.8.8
Requires-Dist: livereload>=2.7.1
Requires-Dist: md2pdf>=3.1.1
Requires-Dist: mypy>=1.0
Requires-Dist: myst-parser>=5.0.0
Requires-Dist: pydata-sphinx-theme<1.0,>=0.17.1
Requires-Dist: pytest-cov>=5.0
Requires-Dist: pytest>=9.0.0
Requires-Dist: reuse>=6.2.0
Requires-Dist: ruff>=0.14
Requires-Dist: sphinx-autoapi>=3.6.1
Requires-Dist: sphinx-copybutton>=0.5.2
Requires-Dist: sphinx-design>=0.7.0
Requires-Dist: sphinx-external-toc>=1.1.0
Requires-Dist: sphinx>=9.1.0
Requires-Dist: sphinxcontrib-mermaid>=2.0.0
Requires-Dist: watchfiles>=1.1.1
Provides-Extra: gui
Requires-Dist: pyside6-essentials>=6.11.0; extra == 'gui'
Description-Content-Type: text/markdown

# plesty-sdk

The official command-line tool for developing Python modules compliant with the
[Plesty standard](https://gitlab.com/plesty/governance). It provides project scaffolding,
compliance checking, documentation tooling, license header management, and device manual
generation.

## Installation

```bash
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

```bash
# 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` | Apply SPDX license headers to all Python source files |
| `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)](LICENSE).
