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

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com).
 
+## [2026-06-26]
+
+### Added
+- Gate d1 — Device API Pipeline: optional gate (runs under `quantum`) that verifies
+  all eight standard `DevicePipeline` mock-gate test functions are present and pass.
+  Gate activation is controlled by `module_type = "device"` in `[tool.plesty]` of
+  `pyproject.toml`; modules without this entry skip the gate automatically. Gates are
+  numbered with a `d` prefix (d1, d2, …) to distinguish them from the core SDK gates.
+- Gate 1 now validates `module_type` in `[tool.plesty]`: if present, must be one of
+  `"device"`, `"experiment"`, `"analyzer"`, `"core"`. Absent is accepted (non-hub modules).
+- `plesty init device/experiment/analyzer` scaffolds `module_type` automatically in
+  the generated `pyproject.toml`.
+- `plesty-sdk` itself declares `module_type = "core"` in its own `pyproject.toml`.
+
+## [2026-06-24b]
+
+### Fixed
+- `plesty init` generated `.gitlab-ci.yml` now passes `access_token: $CI_BOT_TOKEN` to
+  `hub-module` so docs deployment can push to the `docs-build` branch.
+- Dev dependencies moved from `[project.optional-dependencies.dev]` to
+  `[dependency-groups.dev]` so `uv run` includes them by default without `--extra dev`.
+- Gate 2 mypy run now passes `--exclude tests` to avoid namespace-package
+  double-discovery errors in generated projects.
+
 ## [2026-06-24]
 
 ### Added

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plesty-sdk
-Version: 0.1.0.dev2
+Version: 0.2.1
 Summary: Command-line application for developing Python modules compliant with the Plesty standard.
 Author: Plesty Development Team
 License-Expression: LGPL-3.0-or-later

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

@@ -37,11 +37,8 @@ name, so `plesty-foo-bar` → `foo_bar` without needing `--name`.
 | `--name` | inferred | Python module name — lowercase letters, digits, and `_` only (e.g. `foo_bar`). Inferred from the directory name by stripping the `plesty-` prefix and converting hyphens to underscores. |
 | `--author` | `John Doe` | Author name written into `pyproject.toml` and `spdx.tmpl` |
 | `--email` | `john.doe@example.com` | Author email written into `pyproject.toml` and `spdx.tmpl` |
-| `--ci-stages` | all stages | Comma-separated pipeline stages to include in `.gitlab-ci.yml`. Pass `""` to omit the CI file. |
-
-### Available CI stages
-
-`check`, `test`, `build`, `release`, `deploy`
+| `--standard` | `quantum` | Compliance standard for the generated CI pipeline: `pixel`, `nebula`, or `quantum`. |
+| `--no-ci` | off | Skip generating `.gitlab-ci.yml` entirely. |
 
 ## Directory rules
 
@@ -57,12 +54,13 @@ After copying the template, `plesty init` automatically:
 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`.
+   `plesty check` automatically before every `git push` (standard read from
+   `[tool.plesty] standard` in `pyproject.toml`, default: `quantum`).
 
 ## Examples
 
 ```bash
-# Minimal: module name inferred from directory, all CI stages, default author
+# Minimal: module name inferred from directory, quantum CI, default author
 mkdir plesty-power-meter && cd plesty-power-meter
 plesty init device
 
@@ -72,15 +70,15 @@ plesty --project-dir ~/projects/plesty-power-meter init device \
   --author "Jane Doe" \
   --email jane@example.com
 
-# Only include check and build stages in CI
+# Use nebula standard in CI (gates 1–6 only)
 plesty --project-dir ~/projects/plesty-scan-exp init experiment \
   --name scan_exp \
-  --ci-stages "check,build"
+  --standard nebula
 
 # Skip CI file entirely
 plesty --project-dir ~/projects/plesty-internal-tool init device \
   --name internal_tool \
-  --ci-stages ""
+  --no-ci
 ```
 
 ## Generated project layout
@@ -90,21 +88,26 @@ plesty-foo-bar/
 ├── plesty/
 │   └── foo_bar/
 │       ├── __init__.py
-│       └── __main__.py
-│       └── base_device.py       # device only
+│       ├── __main__.py
+│       ├── base_device.py       # device only
 │       └── device.py            # device only
 ├── docs/
-│   └── index.md
+│   ├── index.md
+│   └── toc.yaml
 ├── tests/
+│   ├── __init__.py
+│   └── test_foo_bar.py          # smoke tests covering all public methods
 ├── CHANGELOG.md
 ├── .git/
 │   └── hooks/
-│       └── pre-push             # runs plesty check --standard nebula
-├── .gitlab-ci.yml               # omitted when --ci-stages ""
+│       └── pre-push             # runs plesty check (standard from pyproject.toml)
+├── .gitlab-ci.yml               # omitted when --no-ci
 ├── .gitignore
 ├── COPYING
 ├── LICENSE
 ├── LICENSES/
+│   ├── GPL-3.0-or-later.txt
+│   └── LGPL-3.0-or-later.txt
 ├── pyproject.toml
 ├── README.md
 └── spdx.tmpl
@@ -114,8 +117,14 @@ The `pyproject.toml` is pre-configured with:
 - 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`
+- `plesty-lib` as a runtime dependency
+- `pytest`, `pytest-cov`, `mypy`, and `plesty-sdk` under `[dependency-groups] dev`
+  (included automatically by `uv run` — no `--extra dev` needed)
 - Sphinx docs settings under `[tool.plesty.docs]`
 
-Use `plesty update` to change author info, the PyPI name, or CI stages after initialisation.
+The generated `.gitlab-ci.yml` uses the unified `hub-module` CI component from `plesty-ci`
+and passes `access_token: $CI_BOT_TOKEN`. Configure a project access token with
+`read_repository` + `write_repository` scopes and **Maintainer** role, then set it as a
+masked CI/CD variable named `CI_BOT_TOKEN`.
+
+Use `plesty update` to change author info, the PyPI name, or CI standard after initialisation.

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

@@ -17,14 +17,11 @@ working directory).
 | `--author TEXT` | New author name — updates `[project].authors[0].name` in `pyproject.toml` and `Author:` in `spdx.tmpl` |
 | `--email TEXT` | New author email — updates `[project].authors[0].email` in `pyproject.toml` and `Email:` in `spdx.tmpl` |
 | `--name NAME` | New PyPI distribution name — updates `[project].name` in `pyproject.toml` |
-| `--ci-stages STAGES` | Comma-separated pipeline stages — regenerates `.gitlab-ci.yml`. Pass `""` to remove the CI file. |
+| `--standard STANDARD` | Regenerate `.gitlab-ci.yml` using the given compliance standard (`pixel`, `nebula`, or `quantum`). |
+| `--no-ci` | Remove the `.gitlab-ci.yml` file if present. |
 
 At least one option must be provided.
 
-### Available CI stages
-
-`check`, `test`, `build`, `release`, `deploy`
-
 ## Examples
 
 ```bash
@@ -34,14 +31,14 @@ plesty update --author "Jane Doe" --email jane@example.com
 # Rename the PyPI distribution
 plesty update --name plesty-pm100d-device
 
-# Narrow the CI pipeline to check + build only
-plesty update --ci-stages "check,build"
+# Regenerate CI with nebula standard
+plesty update --standard nebula
 
 # Remove the CI file
-plesty update --ci-stages ""
+plesty update --no-ci
 
 # Combine multiple updates in one call
-plesty update --author "Jane Doe" --email jane@example.com --ci-stages "check,build,release"
+plesty update --author "Jane Doe" --email jane@example.com --standard quantum
 
 # Update a project in another directory
 plesty --project-dir ../plesty-power_meter-device update --author "Jane Doe"
@@ -54,5 +51,5 @@ plesty --project-dir ../plesty-power_meter-device update --author "Jane Doe"
   identity into all `.py` file headers.
 - `--name` changes only `[project].name`. The Python package directory name and all import
   paths in source files are left unchanged.
-- `--ci-stages` fully regenerates `.gitlab-ci.yml` from scratch; any manual edits to that
-  file will be lost.
+- `--standard` fully regenerates `.gitlab-ci.yml` from scratch using the `hub-module` CI
+  component; any manual edits to that file will be lost.

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/gl-secret-detection-report.json

@@ -19,19 +19,19 @@
       "version": "8.30.1"
     },
     "type": "secret_detection",
-    "start_time": "2026-06-24T10:28:20",
-    "end_time": "2026-06-24T10:28:21",
+    "start_time": "2026-06-26T14:32:03",
+    "end_time": "2026-06-26T14:32:03",
     "status": "success",
     "observability": {
       "events": [
         {
           "event": "collect_secrets_analyzer_scan_metrics_from_pipeline",
-          "time_s": 0.521656153,
+          "time_s": 0.466512051,
           "exit_code": 0,
           "git_strategy": "FetchShallow",
-          "repo_size_kb": 553,
+          "repo_size_kb": 591,
           "commit_count": 1,
-          "bytes_scanned": 798,
+          "bytes_scanned": 947,
           "pipeline_type": "Tag"
         },
         {

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/plesty/sdk/assets/ruff.toml

@@ -9,3 +9,6 @@ ignore = ["E203", "D401", "D205"]
 
 [lint.pydocstyle]
 convention = "google"
+
+[lint.per-file-ignores]
+"tests/**" = ["D100", "D101", "D102", "D103", "D104"]

plesty_sdk-0.2.1/plesty/sdk/assets/templates/template/docs/toc.yaml

@@ -0,0 +1 @@
+root: index.md

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/plesty/sdk/assets/templates/template/pyproject.toml.jinja

@@ -20,15 +20,11 @@ dependencies = [
 {% endif %}
 ]
 
-[project.optional-dependencies]
-dev = [
-  "pytest>=9.0.0",
-  "pytest-cov>=5.0",
-  "mypy>=1.0",
-]
-
 [tool.plesty]
 standard = "quantum"
+{% if project_type in ('device', 'experiment', 'analyzer') %}
+module_type = "{{ project_type }}"
+{% endif %}
 
 [tool.plesty.docs]
 site-name = "Plesty {{ module_name | replace('_', ' ') | title }} {{ project_type | title }}"
@@ -42,6 +38,14 @@ build-backend = "hatchling.build"
 [tool.hatch.build.targets.wheel]
 packages = ["plesty"]
 
+[dependency-groups]
+dev = [
+  "pytest>=9.0.0",
+  "pytest-cov>=5.0",
+  "mypy>=1.0",
+  "plesty-sdk>=0.2.0",
+]
+
 [tool.uv]
 cache-dir = ".uv-cache"
 

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/plesty/sdk/commands/check.py

@@ -46,6 +46,18 @@ _PLESTY_LIB_PREFIXES = ("plesty.lib", "plesty_lib", "plestylib")
 _REQUIRED_LICENSE_FILES = ("LICENSE", "COPYING")
 _COVERAGE_THRESHOLD = 80
 
+# Device gate constants
+_DEVICE_PIPELINE_GATES = (
+    "test_schema_integrity",
+    "test_param_key_resolution",
+    "test_params_mock",
+    "test_funcs_mock",
+    "test_lifecycle",
+    "test_identity",
+    "test_check_errors",
+    "test_state_coverage",
+)
+
 
 # ── Command ────────────────────────────────────────────────────────────────────
 
@@ -125,6 +137,11 @@ def check_command(
         if standard == "quantum":
             check_docs_build(context)
 
+    if standard in ("quantum", "ci"):
+        # ── Device gates (d1, d2, …) — only active for device modules ──────────
+        # Gate d1 — Device API Pipeline [Device]
+        check_device_api_pipeline(project_dir, pyproject_toml)
+
     click.echo("\nAll checks passed.")
 
 
@@ -179,6 +196,14 @@ def check_metadata(project_dir: Path, pyproject_toml: dict[str, Any]) -> None:
             f"'{expected_pkg}' or a parent namespace (e.g. 'plesty'). Found: {wheel_packages}"
         )
 
+    _KNOWN_MODULE_TYPES = ("device", "experiment", "analyzer", "core")
+    module_type = pyproject_toml.get("tool", {}).get("plesty", {}).get("module_type")
+    if module_type is not None and module_type not in _KNOWN_MODULE_TYPES:
+        raise click.ClickException(
+            f"[Metadata] Unknown module_type '{module_type}' in [tool.plesty]. "
+            f"Valid values: {', '.join(repr(t) for t in _KNOWN_MODULE_TYPES)}."
+        )
+
     click.echo("  ✓ Metadata & Namespace")
 
 
@@ -241,6 +266,7 @@ def run_type_checker(project_directory: Path) -> None:
             "tests",
         ],
         gate="Code Hygiene",
+        cwd=project_directory,
     )
     click.echo("  ✓ Code Hygiene (types)")
 
@@ -261,6 +287,11 @@ def check_api_interfaces(project_dir: Path, pyproject_toml: dict[str, Any]) -> N
         pyproject_toml: Parsed pyproject.toml content.
     """
     module_name = _module_name_from_toml(pyproject_toml)
+
+    if module_name == "lib":
+        click.echo("  ✓ API Interface Matching (N/A — plesty-lib defines the base classes)")
+        return
+
     module_dir = project_dir / "plesty" / module_name
 
     violations: list[str] = []
@@ -640,6 +671,66 @@ def check_docs_build(context: ApplicationContext) -> None:
     click.echo("  ✓ Docs Build")
 
 
+# ── Device gates (d1, d2, …) ──────────────────────────────────────────────────
+
+
+def _is_device_module(pyproject_toml: dict[str, Any]) -> bool:
+    """Return True when ``[tool.plesty] module_type = "device"`` is declared.
+
+    Args:
+        pyproject_toml: Parsed pyproject.toml content.
+    """
+    return pyproject_toml.get("tool", {}).get("plesty", {}).get("module_type") == "device"
+
+
+def check_device_api_pipeline(project_dir: Path, pyproject_toml: dict[str, Any]) -> None:
+    """Gate d1: Verify device modules implement the standard DevicePipeline test suite.
+
+    Modules that do not declare ``module_type = "device"`` in ``[tool.plesty]``
+    are silently skipped.  For device modules, all eight mock pipeline gate
+    test functions must be present in ``tests/`` and pass without hardware.
+
+    Args:
+        project_dir: Root directory of the target project.
+        pyproject_toml: Parsed pyproject.toml content.
+    """
+    if not _is_device_module(pyproject_toml):
+        click.echo("  ✓ Device API Pipeline (N/A — not a device module)")
+        return
+
+    # Collect test node IDs to verify each gate function is present.
+    collect = subprocess.run(
+        ["pytest", "--collect-only", "-q", "tests/"],
+        cwd=str(project_dir),
+        capture_output=True,
+        text=True,
+    )
+    collected = collect.stdout + collect.stderr
+
+    missing = [g for g in _DEVICE_PIPELINE_GATES if g not in collected]
+    if missing:
+        raise click.ClickException(
+            "[Device API] Missing required DevicePipeline gate test(s):\n"
+            + "\n".join(f"  - {g}" for g in missing)
+            + "\nAdd these test functions via plesty.lib.test.device_pipeline.DevicePipeline."
+        )
+
+    # Run only the gate tests.
+    gate_filter = " or ".join(_DEVICE_PIPELINE_GATES)
+    p = subprocess.run(
+        ["pytest", "-k", gate_filter, "--tb=short", "-q", "tests/"],
+        cwd=str(project_dir),
+        capture_output=True,
+        text=True,
+    )
+    print(p.stdout)
+    if p.returncode != 0:
+        print(p.stderr)
+        raise SystemExit(p.returncode)
+
+    click.echo(f"  ✓ Device API Pipeline (d1 — {len(_DEVICE_PIPELINE_GATES)} mock gates pass)")
+
+
 # ── Helpers ────────────────────────────────────────────────────────────────────
 
 

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/plesty/sdk/commands/docs/sphinx_builder.py

@@ -115,7 +115,7 @@ def make_sphinx_config(
     if settings.toc_file is not None:
         config["extensions"].append("sphinx_external_toc")
         config.update(
-            suppress_warnings=["etoc.toctree"],
+            suppress_warnings=["etoc.toctree", "myst.xref_missing"],
             external_toc_path=settings.toc_file,
         )
 

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/plesty/sdk/commands/init.py

@@ -217,6 +217,7 @@ def generate_gitlab_ci(project_dir: Path, standard: str = "quantum") -> None:
         "    inputs:",
         f"      standard: {standard}",
         "      extra_branch: exp",
+        "      access_token: $CI_BOT_TOKEN",
     ]
 
     (project_dir / ".gitlab-ci.yml").write_text("\n".join(lines) + "\n", encoding="utf-8")

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/pyproject.toml

@@ -43,6 +43,7 @@ cache-dir = ".uv-cache"
 
 [tool.plesty]
 standard = "quantum"
+module_type = "core"
 
 [tool.plesty.docs]
 site-name = "SDK"

{plesty_sdk-0.1.0.dev2 → plesty_sdk-0.2.1}/tests/test_init.py

@@ -168,6 +168,12 @@ class TestGenerateGitlabCi:
         content = (tmp_path / ".gitlab-ci.yml").read_text()
         assert "extra_branch: exp" in content
 
+    def test_access_token_ci_bot_token(self, tmp_path):
+        """access_token is set to $CI_BOT_TOKEN for docs deploy."""
+        generate_gitlab_ci(tmp_path)
+        content = (tmp_path / ".gitlab-ci.yml").read_text()
+        assert "access_token: $CI_BOT_TOKEN" in content
+
 
 # ---------------------------------------------------------------------------
 # Full end-to-end init (uses real copier with local assets)