# 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

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

```bash
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 |
|---|---|
| [`plesty check`](commands/check.md) | Validate a project against a Plesty compliance level |
| [`plesty init`](commands/init.md) | Scaffold new device or experiment projects from templates |
| [`plesty docs`](commands/docs.md) | Serve or deploy the project documentation |
| [`plesty license`](commands/license.md) | Apply and sync SPDX license headers |
| [`plesty manual`](commands/manual.md) | Generate Markdown/PDF manuals from a device's `DocDevice` |
| [`plesty update`](commands/update.md) | Update author, name, or CI stages in an existing project |