plesty-sdk 0.1.0__tar.gz → 0.1.0.dev2__tar.gz

{plesty_sdk-0.1.0 → plesty_sdk-0.1.0.dev2}/.gitignore

@@ -1,7 +1,6 @@
 .venv/
 .uv-cache/
 __pycache__/
-uv.lock
 .python-version
 
 # Ignore build artifacts

plesty_sdk-0.1.0.dev2/.gitlab-ci.yml

@@ -0,0 +1,25 @@
+workflow:
+  rules:
+    # Create pipelines for merge requests
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    # Create branch pipelines for main and exp
+    - if: $CI_COMMIT_BRANCH == "main"
+    - if: $CI_COMMIT_BRANCH == "exp"
+    # Create pipelines for tags (dev and stable releases)
+    - if: $CI_COMMIT_TAG
+    # Otherwise do not create a pipeline
+    - when: never
+
+stages:
+  - check
+  - security
+  - deploy
+  - release
+
+include:
+  - component: $CI_SERVER_FQDN/plesty/plesty-ci/hub-module@exp
+    inputs:
+      standard: quantum
+      extra_branch: exp
+      access_token: $CI_BOT_TOKEN
+      pypi_token: $PYPI_TOKEN

plesty_sdk-0.1.0.dev2/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com).
+
+## [2026-06-24]
+
+### Added
+- `plesty init device/experiment` now scaffolds a `tests/` directory with smoke tests
+  covering all public methods, so gate 7 (≥80% coverage) passes without manual edits.
+
+### Changed
+- `plesty init` CI generation switched from per-component includes to the unified
+  `hub-module@exp` component; `--ci-stages` replaced by `--standard` / `--no-ci`.
+- `plesty init` (`--standard`, default `quantum`) and `plesty update` share the same
+  interface for regenerating `.gitlab-ci.yml`.
+- `__main__.py` template now guards entry-point code behind `if __name__ == "__main__"`
+  to prevent import-time side effects in generated projects.
+- Gate 2 mypy run now excludes `tests/` to avoid namespace-package double-discovery
+  when test files import from the `plesty` namespace.
+
+## [2026-06-22]
+
+### Added
+- Implemented all nine HUB module validation gates in `plesty check` (Gates 1–9),
+  covering metadata, code hygiene, API interfaces, data compliance, documentation,
+  dependency coexistence, test coverage, semantic versioning, and licensing.
+- `plesty init` now installs a pre-push git hook enforcing `plesty check --standard nebula`.
+- New dependencies: `mypy>=1.0`, `pytest-cov>=5.0`.
+
+### Changed
+- Restructured package from `plesty_sdk` to `plesty.sdk` namespace package for
+  consistency with the HUB module convention.
+- `plesty check` default standard changed from `pixel` to `nebula`.
+- Removed Bluesky runtime device check; API interface matching is now static (AST-based).
+- `pydata-sphinx-theme` pin relaxed from `==0.17.1` to `>=0.17.1,<1.0`.

plesty_sdk-0.1.0.dev2/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: plesty-sdk
+Version: 0.1.0.dev2
+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).

plesty_sdk-0.1.0.dev2/README.md

@@ -0,0 +1,51 @@
+# 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).

plesty_sdk-0.1.0.dev2/docs/commands/check.md

@@ -0,0 +1,74 @@
+# plesty check
+
+Validate a project against the Plesty compliance standard. Runs a suite of static analysis
+and runtime gates organised into two enforcement tiers.
+
+```bash
+plesty check [--standard LEVEL]
+```
+
+## Options
+
+| Option | Default | Description |
+|---|---|---|
+| `--standard` | `quantum` | Compliance level: `pixel`, `nebula`, or `quantum` |
+
+## Enforcement tiers
+
+Gates are divided into two tiers depending on whether they require network access or a clean
+install environment:
+
+- **`[SDK]`** — enforced locally by `plesty check`; pure static analysis, no network.
+  The pre-push git hook installed by `plesty init` runs these gates automatically before
+  every push.
+- **`[SDK+CI]`** — enforced locally and repeated by CI in a clean environment as the
+  authoritative final gate.
+
+## Compliance levels
+
+### Pixel
+
+Metadata and code hygiene only — fast check suitable for pre-commit hooks.
+
+| Gate | Tier | What is checked |
+|---|---|---|
+| Metadata & Namespace | `[SDK]` | `pyproject.toml` has required fields; package name matches `plesty-<module>`; `plesty/<module>/` directory exists |
+| Code Hygiene | `[SDK]` | `ruff` lint (E, F, W, D rules); `ruff format --check`; `mypy` type checking |
+
+### Nebula
+
+All Pixel gates plus the remaining `[SDK]` gates. This is the standard enforced by the
+pre-push hook.
+
+| Gate | Tier | What is checked |
+|---|---|---|
+| API Interface Matching | `[SDK]` | Classes that import from `plesty.lib.*` must inherit from the imported base class (e.g. `BaseDeviceSyncModel`) |
+| Data Layer Compliance | `[SDK]` | All public methods have explicit return type annotations |
+| Documentation Completeness | `[SDK]` | `docs/index.md` (or `index.rst`) exists; `CHANGELOG.md` exists and has been updated since the last git tag |
+| Dependency Coexistence | `[SDK]` | No exact pins (`==x.y.z`) in `pyproject.toml`; use `>=x.y,<x+1` |
+
+### Quantum
+
+Everything in Nebula plus the `[SDK+CI]` gates, run locally for full verification before a
+release. This is the default `plesty check` standard.
+
+| Gate | Tier | What is checked |
+|---|---|---|
+| Automated Test Coverage | `[SDK+CI]` | `pytest --cov` with a minimum threshold of **80%** |
+| Semantic Versioning | `[SDK+CI]` | Reminder to tag a new release when commits exist since the last tag; API-level diff against the published PyPI release runs in CI |
+| Licensing Compliance | `[SDK+CI]` | `LICENSE` and `COPYING` files present; `license` field declared in `pyproject.toml` |
+| Vulnerability Audit | `[SDK+CI]` | No known CVEs in declared dependencies; queries the OSV database via `pip-audit` |
+| Docs Build | `[SDK+CI]` | Full Sphinx build must complete with zero errors and zero warnings |
+
+## Examples
+
+```bash
+# Default quantum check in the current directory
+plesty check
+
+# Quick pixel check (metadata + code hygiene only)
+plesty check --standard pixel
+
+# Full quantum check on a project in another directory
+plesty --project-dir ../plesty-power-meter check --standard quantum
+```

{plesty_sdk-0.1.0 → plesty_sdk-0.1.0.dev2}/docs/commands/docs.md

@@ -41,31 +41,35 @@ Press **Ctrl+C** to stop the server.
 ## deploy
 
 ```bash
-plesty docs deploy --remote-url URL --target-branch BRANCH [--release]
+plesty docs deploy REMOTE_URL TARGET_BRANCH (--release | --latest)
 ```
 
-Builds the Sphinx documentation and pushes it to the specified branch on a remote repository,
-suitable for GitLab Pages or GitHub Pages.
+Builds the Sphinx documentation and pushes it to `TARGET_BRANCH` on the repository at
+`REMOTE_URL`, suitable for GitLab Pages. The branch is created as an orphan if it does not
+yet exist.
 
-### Options
+`--release` and `--latest` are mutually exclusive and one is required:
 
-| Option | Default | Description |
-|---|---|---|
-| `--remote-url` | required | Git remote URL to push the built docs to |
-| `--target-branch` | required | Branch that serves the documentation pages |
-| `--release` | off | Build as a versioned release; without this flag the docs are published as the latest development snapshot |
+| Flag | Behaviour |
+|---|---|
+| `--latest` | Publishes to `html/latest/` — for commits to the default branch |
+| `--release` | Publishes to `html/releases/<major>.<minor>/` — for tagged releases |
 
 ### Example
 
 ```bash
-# Deploy development snapshot
+# Deploy development snapshot (latest)
 plesty docs deploy \
-  --remote-url git@gitlab.com:plesty/my-device.git \
-  --target-branch pages
+  https://gitlab-ci-token:${CI_BOT_TOKEN}@gitlab.com/plesty/my-device.git \
+  docs-build \
+  --latest
 
 # Deploy a versioned release
 plesty docs deploy \
-  --remote-url git@gitlab.com:plesty/my-device.git \
-  --target-branch pages \
+  https://gitlab-ci-token:${CI_BOT_TOKEN}@gitlab.com/plesty/my-device.git \
+  docs-build \
   --release
 ```
+
+In practice this command is called by the `deploy-docs` CI component and does not need to
+be run manually.

{plesty_sdk-0.1.0 → plesty_sdk-0.1.0.dev2}/docs/commands/init.md

@@ -23,7 +23,7 @@ All Plesty projects follow a consistent naming scheme derived from the module na
 | Artifact | Convention | Example |
 |---|---|---|
 | Project folder | `plesty-<kebab-name>` | `plesty-foo-bar` |
-| Source folder | `<module_name>` | `foo_bar` |
+| Source folder | `plesty/<module_name>/` | `plesty/foo_bar/` |
 | PyPI distribution | `plesty-<kebab-name>` | `plesty-foo-bar` |
 | Python import | `plesty.<module_name>` | `plesty.foo_bar` |
 
@@ -48,6 +48,17 @@ name, so `plesty-foo-bar` → `foo_bar` without needing `--name`.
 - If `--project-dir` does not exist it is created automatically.
 - If it already exists it must be empty (hidden entries such as `.git` are ignored).
 
+## What init does
+
+After copying the template, `plesty init` automatically:
+
+1. **Formats generated files** — runs `ruff format` so the scaffold is already
+   `plesty check`-clean from the first commit.
+2. **Creates the initial git commit** — required by `versioningit` to resolve a package
+   version from git history.
+3. **Installs the pre-push hook** — writes `.git/hooks/pre-push` to run
+   `plesty check --standard nebula` automatically before every `git push`.
+
 ## Examples
 
 ```bash
@@ -76,14 +87,20 @@ plesty --project-dir ~/projects/plesty-internal-tool init device \
 
 ```
 plesty-foo-bar/
-├── foo_bar/
-│   ├── __init__.py
-│   └── __main__.py
-│   └── base_device.py       # device only
-│   └── device.py            # device only
+├── plesty/
+│   └── foo_bar/
+│       ├── __init__.py
+│       └── __main__.py
+│       └── base_device.py       # device only
+│       └── device.py            # device only
 ├── docs/
 │   └── index.md
-├── .gitlab-ci.yml           # omitted when --ci-stages ""
+├── tests/
+├── CHANGELOG.md
+├── .git/
+│   └── hooks/
+│       └── pre-push             # runs plesty check --standard nebula
+├── .gitlab-ci.yml               # omitted when --ci-stages ""
 ├── .gitignore
 ├── COPYING
 ├── LICENSE
@@ -94,10 +111,11 @@ plesty-foo-bar/
 ```
 
 The `pyproject.toml` is pre-configured with:
-- The PyPI distribution name `plesty-foo-bar` (kebab-case, no project-type suffix)
-- A hatchling sources mapping so the package installs under the `plesty` namespace (`import plesty.foo_bar`)
+- The PyPI distribution name `plesty-foo-bar` (kebab-case)
+- `packages = ["plesty"]` so the module installs under the `plesty` namespace (`import plesty.foo_bar`)
 - Dynamic versioning via `versioningit`
 - `plesty-lib` as a dependency
+- `pytest`, `pytest-cov`, and `mypy` under `[optional-dependencies] dev`
 - Sphinx docs settings under `[tool.plesty.docs]`
 
 Use `plesty update` to change author info, the PyPI name, or CI stages after initialisation.

{plesty_sdk-0.1.0 → plesty_sdk-0.1.0.dev2}/docs/getting-started.md

@@ -13,8 +13,9 @@ mkdir plesty-power-meter && cd plesty-power-meter
 plesty init device
 ```
 
-This produces a `power_meter/` source folder, a PyPI distribution named `plesty-power-meter`,
-and a package importable as `plesty.power_meter`. Alternatively, specify everything explicitly:
+This produces a `plesty/power_meter/` source folder, a PyPI distribution named
+`plesty-power-meter`, and a package importable as `plesty.power_meter`. Alternatively,
+specify everything explicitly:
 
 ```bash
 plesty --project-dir ~/projects/plesty-power-meter init device \
@@ -24,8 +25,11 @@ plesty --project-dir ~/projects/plesty-power-meter init device \
 ```
 
 This generates a project pre-configured with the expected repository structure,
-`pyproject.toml`, example source files, CI pipeline (`.gitlab-ci.yml`), and documentation
-stubs. Use `--ci-stages` to select which pipeline stages to include, or `--ci-stages ""`
+`pyproject.toml`, example source files, CI pipeline (`.gitlab-ci.yml`), documentation
+stubs, and a `CHANGELOG.md`. A pre-push git hook is also installed automatically —
+it runs `plesty check --standard nebula` before every `git push`.
+
+Use `--ci-stages` to select which pipeline stages to include, or `--ci-stages ""`
 to omit the CI file entirely.
 
 ## 2. Check compliance
@@ -37,9 +41,10 @@ cd plesty-power-meter
 plesty check
 ```
 
-By default this checks against the **Pixel** level. Add `--standard nebula` or
-`--standard quantum` to raise the bar. Fix any reported issues and re-run until the check
-passes.
+By default this checks against the **Nebula** level (all `[SDK]` gates). Add
+`--standard pixel` for a faster metadata + code hygiene only check, or
+`--standard quantum` to also run test coverage and semantic versioning gates locally.
+Fix any reported issues and re-run until the check passes.
 
 ## 3. Preview the documentation
 
@@ -81,10 +86,19 @@ plesty update --ci-stages "check,build,release"
 
 ## 6. Deploy documentation
 
-When ready to publish, push the built documentation to your remote pages branch:
+Documentation deployment is handled automatically by the `deploy-docs` CI component when
+commits land on the default branch or a release tag is pushed. To deploy manually:
 
 ```bash
-plesty docs deploy --remote-url git@gitlab.com:org/my-device.git --target-branch pages
+# Development snapshot
+plesty docs deploy \
+  https://gitlab-ci-token:${TOKEN}@gitlab.com/plesty/my-device.git \
+  docs-build \
+  --latest
+
+# Versioned release
+plesty docs deploy \
+  https://gitlab-ci-token:${TOKEN}@gitlab.com/plesty/my-device.git \
+  docs-build \
+  --release
 ```
-
-Use `--release` to tag it as a versioned release instead of the development snapshot.

{plesty_sdk-0.1.0 → plesty_sdk-0.1.0.dev2}/docs/index.md

@@ -31,7 +31,8 @@ this directory.
 | Command | Description |
 |---|---|
 | [`plesty check`](commands/check.md) | Validate a project against a Plesty compliance level |
-| [`plesty build`](commands/build.md) | Scaffold new device or experiment projects from templates |
+| [`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 |

plesty_sdk-0.1.0.dev2/docs/toc.yaml

@@ -0,0 +1,16 @@
+root: index.md
+entries:
+- file: getting-started.md
+  title: Getting started
+- file: commands/check.md
+  title: check
+- file: commands/init.md
+  title: init
+- file: commands/docs.md
+  title: docs
+- file: commands/license.md
+  title: license
+- file: commands/manual.md
+  title: manual
+- file: commands/update.md
+  title: update

plesty_sdk-0.1.0.dev2/gl-secret-detection-report.json

@@ -0,0 +1,50 @@
+{
+  "scan": {
+    "analyzer": {
+      "id": "secrets",
+      "name": "secrets",
+      "url": "https://gitlab.com/gitlab-org/security-products/analyzers/secrets",
+      "vendor": {
+        "name": "GitLab"
+      },
+      "version": "7.37.0"
+    },
+    "scanner": {
+      "id": "gitleaks",
+      "name": "Gitleaks",
+      "url": "https://github.com/gitleaks/gitleaks",
+      "vendor": {
+        "name": "GitLab"
+      },
+      "version": "8.30.1"
+    },
+    "type": "secret_detection",
+    "start_time": "2026-06-24T10:28:20",
+    "end_time": "2026-06-24T10:28:21",
+    "status": "success",
+    "observability": {
+      "events": [
+        {
+          "event": "collect_secrets_analyzer_scan_metrics_from_pipeline",
+          "time_s": 0.521656153,
+          "exit_code": 0,
+          "git_strategy": "FetchShallow",
+          "repo_size_kb": 553,
+          "commit_count": 1,
+          "bytes_scanned": 798,
+          "pipeline_type": "Tag"
+        },
+        {
+          "event": "collect_secrets_analyzer_ruleset_adoption_metrics_from_pipeline",
+          "custom_ruleset": false,
+          "passthrough_types": null,
+          "passthrough_count": 0,
+          "passthrough_auth_used": false,
+          "rules_version": "0.24.3"
+        }
+      ]
+    }
+  },
+  "version": "15.2.4",
+  "vulnerabilities": []
+}

plesty_sdk-0.1.0.dev2/plesty/sdk/assets/docs-build-gitlab-ci.yml

@@ -0,0 +1,11 @@
+stages: [deploy]
+
+pages:
+  stage: deploy
+  rules:
+    - exists:
+      - "html/latest/"
+  script:
+    - echo "Serving documentation on GitLab pages..."
+  pages:
+    publish: html/latest

{plesty_sdk-0.1.0/plesty_sdk → plesty_sdk-0.1.0.dev2/plesty/sdk}/assets/templates/copier.yml

@@ -26,7 +26,3 @@ project_type:
     - experiment
   default: device
 
-ci_stages:
-  type: str
-  help: "Comma-separated CI pipeline stages (check, test, build, release, deploy)"
-  default: "check,test,build,release,deploy"

{plesty_sdk-0.1.0/plesty_sdk → plesty_sdk-0.1.0.dev2/plesty/sdk}/assets/templates/extras/device/base_device.py

@@ -12,40 +12,40 @@ class BaseDevice(BaseDeviceSyncModel):
         ## Device-specific meta info initialization can be added here
 
     # *---- Mandatory methods to implement ----*#
-    def init(self, main=None):
+    def init(self, main=None) -> None:
         """Initialize the device hardware and internal state."""
         ## Device-specific initialization can be added here
         pass
 
-    def connect(self):
+    def connect(self) -> bool:
         """Establish a connection to the device."""
         ## Device-specific connection logic can be added here
         return True
 
-    def disconnect(self):
+    def disconnect(self) -> None:
         """Disconnect from the device and release resources."""
         ## Device-specific disconnection logic can be added here
         pass
 
-    def _write_(self, key: str, value):
+    def _write_(self, key: str, value: object) -> None:
         ## Device-specific write logic can be added here
         pass
 
-    def _query_(self, key):
+    def _query_(self, key: str) -> object:
         ## Device-specific query logic can be added here
-        pass
+        return None
 
     def identity(self) -> str:
         """Return a string identifying the device model and serial number."""
         ## Device-specific identity query logic can be added here
         return "Base Device, Model 1.0, SN00000"
 
-    def check_errors(self):
+    def check_errors(self) -> None:
         """Check the device for errors and raise if any are found."""
         ## Device-specific error checking logic can be added here
         pass
 
-    def check_operatability(self):
+    def check_operatability(self) -> bool:
         """Return True if the device is ready to operate."""
         ## Device-specific operatability check logic can be added here
         return True
@@ -56,12 +56,12 @@ class BaseDevice(BaseDeviceSyncModel):
         ## Device-specific query range logic can be added here
         return [None, None]
 
-    def reset(self):
+    def reset(self) -> None:
         """Reset the device to its default state."""
         ## Device-specific reset logic can be added here
         pass
 
-    def clear(self):
+    def clear(self) -> None:
         """Clear any buffered data or pending state on the device."""
         ## Device-specific clear logic can be added here
         pass

{plesty_sdk-0.1.0/plesty_sdk → plesty_sdk-0.1.0.dev2/plesty/sdk}/assets/templates/extras/device/device.py

@@ -6,16 +6,16 @@ from .base_device import BaseDevice
 class Device(BaseDevice):
     """Concrete device class extending BaseDevice with custom functionality."""
 
-    def __init__(self, id: str, param_schema=None, op_schema=None, *args, **kwargs):
+    def __init__(self, id: str, param_schema=None, op_schema=None) -> None:
         """Initialize the device with an id and optional parameter and operation schemas."""
         super().__init__(id, op_schema=op_schema, param_schema=param_schema)
         ## Device-specific initialization can be added here
 
-    def custom_method(self, *args, **kwargs):
+    def custom_method(self) -> None:
         """Implement a custom device-specific operation."""
-        ## Example of a custom method specific to this device
+        ## Example of a custom method specific to this device.
         ## These are not required by the base model but can be added
-        ## for enhanced functionality in addtion to the funcionalities
+        ## for enhanced functionality in addition to the functionalities
         ## provided by the base model and the registered configuration
-        ## parameters and operations
+        ## parameters and operations.
         pass

plesty_sdk-0.1.0.dev2/plesty/sdk/assets/templates/template/CHANGELOG.md.jinja

@@ -0,0 +1,8 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com).
+
+## [Unreleased]
+
+### Added
+- Initial {{ project_type }} scaffold for `plesty.{{ module_name }}`.