devicectl-core 0.1.0__tar.gz

devicectl_core-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  # A pull request from a branch of this repository was already checked by
+  # the push above; listening to both would run every one of them twice.
+  # A fork's branch produces no push event here, so the `if` on each job
+  # below lets those -- and only those -- through.
+  pull_request:
+  # release.yml calls this workflow before it builds, so a tag cannot
+  # publish what the checks have not passed.
+  workflow_call:
+
+permissions:
+  contents: read
+
+# A newer commit on the same branch makes the older run's answer moot.
+concurrency:
+  group: ci-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    if: >-
+      github.event_name != 'pull_request' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      # --locked: a uv.lock that no longer matches pyproject.toml is a
+      # mistake to report, not one to paper over with a fresh resolution.
+      # The browser group brings the V8 the template check parses in;
+      # without it those tests skip themselves and check nothing.
+      - run: uv sync --locked --group browser
+      - run: uv run ruff format --check .
+      - run: uv run ruff check .
+      - run: uv run ty check
+      - run: uv run pytest
+
+  # Biome is one native binary and needs no Node; it lints the browser half
+  # once, not once per Python version.  There is only the vendored bundle
+  # here today, which biome.json excludes -- this job is what keeps that
+  # true once core.css and the shared widgets arrive.
+  frontend:
+    if: >-
+      github.event_name != 'pull_request' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: biomejs/setup-biome@v2
+        with:
+          version: 2.5.12
+      - run: biome ci

devicectl_core-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,69 @@
+# Publishing, on a version tag.  `git tag v0.1.0 && git push --tags` is the
+# whole procedure; the tag has to match the version in
+# src/devicectl/__init__.py, which is the one place it is written down.
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  # The tag push does not itself trigger CI (its trigger is branches), so the
+  # checks run here.  Nothing below starts until they are green.
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    needs: ci
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: The tag and the package must agree
+        run: |
+          version=$(uv run --no-project python -c \
+            "import re,pathlib;print(re.search(r'\"(.+)\"',[l for l in pathlib.Path('src/devicectl/__init__.py').read_text().splitlines() if l.startswith('__version__')][0]).group(1))")
+          if [ "v$version" != "${GITHUB_REF_NAME}" ]; then
+            echo "tag ${GITHUB_REF_NAME} but __version__ is $version" >&2
+            exit 1
+          fi
+      - run: uv build
+      # A wheel that does not start is not worth publishing.
+      # A wheel that does not import is not worth publishing.  There is no
+      # console script here: this is a library.
+      - run: uv run --no-project --with dist/*.whl python -c "import devicectl"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # PyPI trusted publishing: no API token to keep anywhere
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - run: gh release create "$GITHUB_REF_NAME" dist/* --generate-notes
+        env:
+          GH_TOKEN: ${{ github.token }}

devicectl_core-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python
+__pycache__/
+*.py[cod]
+
+# Virtual environments
+.venv/
+
+# Build artifacts
+build/
+dist/
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+
+# Editors
+.idea/
+.vscode/
+*.swp

devicectl_core-0.1.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+Notable changes, newest first. The version is set in
+`src/devicectl/__init__.py`.
+
+## 0.1.0 — 2026-09-26
+
+The first release. `alfenctl` and `jkctl` were one program written twice;
+this is the half they share, extracted into one package with **no required
+runtime dependencies** -- everything here is standard library.
+
+What that half turned out to be:
+
+- **Errors and reports.** `DeviceError`, the root of every expected failure;
+  `Reporter`, `Wait` and `SILENT`, the protocol that drives a terminal and a
+  browser from one long operation; and `Finding`, `Report` and `finding_json`,
+  the shape of a health check.
+- **A CLI framework.** The command table (`Command`, `Need`, `Handler`), the
+  `argv` rewrites that fill in a default command or action, the fan-out that
+  runs one read across several devices, the shared exit codes, and the funnel
+  every expected failure lands in.
+- **The web transport.** `serve()` and its four guards (Host, token, the UI
+  header, `--read-only`), the SSE event stream, the `Worker` that owns the one
+  connection a device allows, the upload spool, and `parse_listen`.
+- **A build-free browser UI.** The design system (`core.css`) and the shared
+  widget library -- header, device tiles, tables, charts, draggable setpoint
+  bands, the health card and the page-wide draft store -- drawn over a vendored
+  Preact + htm, with no build step.
+- **Dev-time checks.** `frontlint`, `htmcheck` and `rendercheck`, the
+  cross-file and in-browser checks that keep a build-free frontend honest.
+- **Small shared helpers.** `FieldSpec`, one description of a setting for all
+  its audiences; `config_dir`, the per-user config directory by platform; the
+  duration and HTTP-status constants; and the clock-drift phrasing.
+
+See [README.md](README.md) for the module-by-module map.

devicectl_core-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing
+
+## What belongs here
+
+Something belongs in `devicectl-core` when **two** programs already need it
+and neither's version is the right one to keep. One program's speculative
+need is not enough: an abstraction with a single consumer is a guess, and
+this package exists because a pair of guesses drifted apart in two repos
+rather than being reconciled in one.
+
+Three rules follow from that:
+
+* **No runtime dependencies.** Everything here is standard library. A
+  transport belongs in the program that speaks the protocol.
+* **Nothing here knows what a device is.** No retry policy, no register
+  catalog, no connection. The seam is always a callable or a dataclass the
+  program fills in.
+* **Where the two programs disagree, reconcile before extracting.** Picking
+  one side and leaving the other to adapt is how the divergence started.
+
+## Conventions
+
+Both consumer programs share these, and code moved from either keeps them.
+
+* Docstrings on everything, enforced (`D`, pep257). They say *why*: what a
+  reader could work out from the code does not need repeating, and what
+  they could not -- a protocol quirk, a decision that looks arbitrary --
+  does.
+* `PLR2004` is on, so a number with meaning gets a name.
+* Line length 88, `E501` not enforced on prose. The formatter never breaks
+  a string, and some of them have to stay verbatim.
+* Tests are named as sentences about behaviour, not after the function
+  under test.
+
+## Checks
+
+```bash
+uv sync --group browser
+uv run ruff check . && uv run ruff format --check . && uv run ty check && uv run pytest
+```
+
+The `browser` group carries the V8 that `devtools/htmcheck.py` parses
+templates in. Without it those tests skip themselves, saying so -- which
+is fine locally and is why CI installs it.
+
+## Releasing
+
+The version lives in `src/devicectl/__init__.py` and nowhere else.
+`git tag v0.1.0 && git push --tags` runs the checks, builds, and publishes
+to PyPI; the tag has to match.

devicectl_core-0.1.0/LICENSE

@@ -0,0 +1,287 @@
+                      EUROPEAN UNION PUBLIC LICENCE v. 1.2
+                      EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
+below) which is provided under the terms of this Licence. Any use of the Work,
+other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work:
+
+        Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+
+- ‘The Licence’: this Licence.
+
+- ‘The Original Work’: the work or software distributed or communicated by the
+  Licensor under this Licence, available as Source Code and also as Executable
+  Code as the case may be.
+
+- ‘Derivative Works’: the works or software that could be created by the
+  Licensee, based upon the Original Work or modifications thereof. This Licence
+  does not define the extent of modification or dependence on the Original Work
+  required in order to classify a work as a Derivative Work; this extent is
+  determined by copyright law applicable in the country mentioned in Article 15.
+
+- ‘The Work’: the Original Work or its Derivative Works.
+
+- ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+- ‘The Executable Code’: any code which has generally been compiled and which is
+  meant to be interpreted by a computer as a program.
+
+- ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+
+- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
+  Licence, or otherwise contributes to the creation of a Derivative Work.
+
+- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+
+- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright vested
+in the Original Work:
+
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case may
+  be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make effective
+the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
+any patents held by the Licensor, to the extent necessary to make use of the
+rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates, in
+a notice following the copyright notice attached to the Work, a repository where
+the Source Code is easily and freely accessible for as long as the Licensor
+continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits from
+any exception or limitation to the exclusive rights of the rights owners in the
+Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and a
+copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of the
+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions on
+the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed under
+a Compatible Licence, this Distribution or Communication can be done under the
+terms of this Compatible Licence. For the sake of this clause, ‘Compatible
+Licence’ refers to the licences listed in the appendix attached to this Licence.
+Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible
+Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work,
+the Licensee will provide a machine-readable copy of the Source Code or indicate
+a repository where this Source will be easily and freely available for as long
+as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade names,
+trademarks, service marks, or names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings
+to the Work are owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis
+and without warranties of any kind concerning the Work, including without
+limitation merchantability, fitness for a particular purpose, absence of defects
+or errors, accuracy, non-infringement of intellectual property rights other than
+copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition
+for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the use
+of the Work, including without limitation, damages for loss of goodwill, work
+stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such damage.
+However, the Licensor will be liable under statutory product liability laws as
+far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional agreement,
+defining obligations or services consistent with this Licence. However, if
+accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor harmless
+for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
+placed under the bottom of a window displaying the text of this Licence or by
+affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this Licence,
+such as the use of the Work, the creation by You of a Derivative Work or the
+Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of electronic
+communication by You (for example, by offering to download the Work from a
+remote location) the distribution channel or media (for example, a website) must
+at least provide to the public the information requested by the applicable law
+regarding the Licensor, the Licence and the way it may be accessible, concluded,
+stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has
+received the Work from the Licensee under the Licence, provided such persons
+remain in full compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of
+this Licence or updated versions of the Appendix, so far this is required and
+reasonable, without reducing the scope of the rights granted by the Licence. New
+versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+
+- any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty on
+  the Functioning of the European Union,
+
+- any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive jurisdiction
+  of the competent court where the Licensor resides or conducts its primary
+  business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+
+- this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+
+- this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
+- Open Software License (OSL) v. 2.1, v. 3.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
+  Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above
+licences without producing a new version of the EUPL, as long as they provide
+the rights granted in Article 2 of this Licence and protect the covered Source
+Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new
+EUPL version.

devicectl_core-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+NOTICE
+======
+
+This project is licensed under the European Union Public Licence v1.2
+(EUPL-1.2) -- see LICENSE. One file shipped in this distribution is not
+covered by that license and remains under its own terms:
+
+* ``src/devicectl/web/static/vendor/preact-htm.module.js`` -- Preact and
+  htm, bundled as one ES module. Copyright Jason Miller and contributors,
+  MIT License; the full notice is embedded as a comment at the top of the
+  file. Upstream: https://preactjs.com/ and https://github.com/developit/htm
+
+Everything else in this distribution is licensed under the EUPL-1.2.

devicectl_core-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.5
+Name: devicectl-core
+Version: 0.1.0
+Summary: Shared building blocks for single-device control programs: a subcommand table, a serialising worker, an SSE broadcaster, and a build-free browser UI.
+Project-URL: Homepage, https://github.com/pbasista/devicectl-core
+Project-URL: Repository, https://github.com/pbasista/devicectl-core
+Project-URL: Issues, https://github.com/pbasista/devicectl-core/issues
+Project-URL: Releases, https://github.com/pbasista/devicectl-core/releases
+Project-URL: License, https://github.com/pbasista/devicectl-core/blob/main/LICENSE
+Author-email: Peter Bašista <pbasista@gmail.com>
+License-Expression: EUPL-1.2
+License-File: LICENSE
+License-File: NOTICE
+Keywords: cli,device,embedded,framework,preact,server-sent-events,web-ui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# devicectl-core
+
+Shared building blocks for programs that drive one device at a time: a
+subcommand table, a progress protocol, a serialising worker that owns the
+one connection a device allows, and a build-free browser UI -- its HTTP
+server, its event stream and the design system it is drawn with.
+
+It exists because two such programs -- [`alfenctl`][alfenctl] for an Alfen
+wallbox on the network and [`jkctl`][jkctl] for a JK BMS on an RS485 bus --
+turned out to be the same program with different protocols underneath, and
+the second one was produced by copying the first. Line for line, after
+normalising the two names, their frontend linters agreed on 528 lines out
+of 529 and their event broadcasters on 161 out of 167. The drift had begun
+anyway: fixes were being made on one side only. This package is the part
+that was the same, with one name each.
+
+## What is here
+
+| Module | What it holds |
+|---|---|
+| `devicectl.errors` | `DeviceError`, the root of every expected failure |
+| `devicectl.report` | `Reporter`, `Wait`, `SILENT` |
+| `devicectl.progress` | the stderr progress bar and the live line |
+| `devicectl.doctor` | `Finding`, `Report`, `finding_json`, and the three weights |
+| `devicectl.fields` | `FieldSpec`, one description of a setting for all its audiences |
+| `devicectl.paths` | `config_dir`, the per-user config directory by platform |
+| `devicectl.cli.command` | `Command`, `Need`, `Handler` |
+| `devicectl.cli.exits` | the exit codes that mean the same thing everywhere |
+| `devicectl.cli.target` | `first_set`, the one-line precedence rule |
+| `devicectl.web.worker` | `Worker`, the one thread that owns the one connection |
+| `devicectl.web.events` | `Broadcaster`, `Subscription`, `Event` |
+| `devicectl.web.http` | `Request`, `Response`, `ApiError`, `Route`, the upload spool |
+| `devicectl.web.server` | `serve`, `Branding`, `parse_listen`, and the four guards |
+| `devicectl.devtools` | `frontlint`, `htmcheck` and `rendercheck`, run as `python -m` |
+| `web/static/` | the design system (`core.css`) and the shared widget library, over the vendored Preact + htm |
+
+## What is deliberately not here
+
+**Any runtime dependency.** Everything is standard library, so a program
+that depends on this pays for its own protocol layer and nothing else --
+and the package stays installable on a Raspberry Pi, where a dependency
+with no armv7 wheel is a compiler run rather than a download.
+
+**Anything that knows what a device is.** No transport, no retry policy, no
+register catalog. Retry in particular does not generalise: one program
+retries at the authentication layer (a 401 means log in again), the other
+at the protocol layer (a framing fault is not a Modbus exception), and a
+shared abstraction over the two would describe neither.
+
+## Using it
+
+```python
+from devicectl.cli.command import Command, Need
+from devicectl.errors import DeviceError
+from devicectl.web import http
+
+
+class WidgetError(DeviceError):
+    """Anything this program refuses to do, in one line."""
+
+
+def get_state(ctx: "Context", req: http.Request) -> http.Response:
+    return http.ok({"ready": ctx.worker.ready})
+
+
+ROUTES: dict[tuple[str, str], http.Route["Context"]] = {
+    ("GET", "/api/state"): http.Route(get_state),
+}
+```
+
+The frontend checks take the static root to check:
+
+```bash
+python -m devicectl.devtools.frontlint src/widgetctl/web/static
+python -m devicectl.devtools.htmcheck  src/widgetctl/web/static
+```
+
+`htmcheck` runs each `html` template through the real vendored parser
+inside V8, so it needs an engine. That engine is ~80 MB and publishes no
+armv7 wheel, so it lives in a dependency group of its own and the check
+skips itself, saying so, without it:
+
+```bash
+uv sync --group browser
+```
+
+## Development
+
+```bash
+uv sync
+uv run ruff check . && uv run ruff format --check . && uv run ty check && uv run pytest
+```
+
+## Licence
+
+EUPL-1.2, except the vendored Preact + htm bundle, which is MIT -- see
+`NOTICE`.
+
+[alfenctl]: https://github.com/pbasista/alfenctl
+[jkctl]: https://github.com/pbasista/jkctl