readerboard 0.1.1__tar.gz

readerboard-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matthew Jackson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readerboard-0.1.1/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: readerboard
+Version: 0.1.1
+Summary: An HTTP service for BetaBrite and Alpha protocol LED signs: several sources share one sign, with alerts, scheduling and clock sync
+Author: mjaksn
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mjaksn/readerboard
+Project-URL: Source, https://github.com/mjaksn/readerboard
+Project-URL: Issues, https://github.com/mjaksn/readerboard/issues
+Project-URL: Changelog, https://github.com/mjaksn/readerboard/blob/main/CHANGELOG.md
+Keywords: betabrite,alpha,led sign,readerboard,home assistant,rs-232,signage
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Topic :: System :: Hardware
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi<0.142,>=0.141.1
+Requires-Dist: uvicorn[standard]<0.53,>=0.52.1
+Requires-Dist: pydantic<3,>=2.13.4
+Requires-Dist: pydantic-settings<3,>=2.15.0
+Requires-Dist: pyserial<4,>=3.5
+Requires-Dist: tzdata>=2026.3; sys_platform == "win32"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=9.1.1; extra == "dev"
+Requires-Dist: pytest-asyncio<2,>=1.4.0; extra == "dev"
+Requires-Dist: httpx2<3,>=2.10.0; extra == "dev"
+Requires-Dist: ruff<0.17,>=0.16.2; extra == "dev"
+Requires-Dist: mypy<3,>=2.3.0; extra == "dev"
+Dynamic: license-file
+
+# readerboard
+
+[![CI](https://github.com/mjaksn/readerboard/actions/workflows/ci.yml/badge.svg)](https://github.com/mjaksn/readerboard/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/readerboard)](https://pypi.org/project/readerboard/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mjaksn/readerboard/blob/main/LICENSE)
+
+An HTTP service that drives a BetaBrite Classic sign, either through a serial cable or
+through an Ethernet to RS-232 adapter.
+
+Several sources can share the sign at once. Each registers a named **slot**, and the sign
+rotates through the registered slots by itself. An **alert** takes the whole display over
+until it is released, after which the rotation resumes.
+
+## What it does
+
+- **Many messages, one sign.** Home Assistant can own `temperature` while a doorbell
+  automation owns `doorbell`, without either knowing about the other.
+- **The sign does the rotating.** Each message lives in its own sign file and the sign
+  cycles them on its own, so rotation costs no serial traffic at all.
+- **Alerts.** Take the display over, optionally with a deadline, then hand it back.
+- **It keeps the sign's clock right**, at startup, hourly, and whenever the link comes
+  back. That last trigger is the one that matters: a sign returning from a power cut
+  does so at no particular minute.
+- **It does not redraw the sign for nothing.** A write of bytes the sign already holds is
+  suppressed, so a source re-sending an unchanged temperature does not make the display
+  flicker.
+- **It survives restarts and outages.** The registered messages are persisted, and a
+  write that arrives while the sign is unreachable is accepted and delivered when the
+  link returns.
+- **Errors are errors.** A dead serial link is a 503, not an HTTP 200 with the word
+  ERROR in the body.
+
+## Requirements
+
+- Python 3.11 or newer.
+- A BetaBrite Classic, reachable either at a serial device such as `/dev/ttyUSB0` or over
+  the network through an Ethernet to RS-232 adapter at `socket://host:port`.
+- For the installer, a machine running systemd. The service itself runs anywhere Python
+  does; only `scripts/install.sh` is Linux specific.
+
+## Try it without a sign
+
+`loop://` is pyserial's loopback, so the service will start and serve its API with
+nothing attached.
+
+```
+pip install -e ".[dev]"
+READERBOARD_SERIAL_URL=loop:// READERBOARD_API_KEY=dev-key \
+    READERBOARD_STATE_PATH=./state.json \
+    python -m readerboard
+```
+
+Then open <http://127.0.0.1:5001/docs>.
+
+## Installing it properly
+
+```
+sudo scripts/install.sh --serial-url socket://192.168.2.51:4001
+```
+
+This creates a `readerboard` system user, builds a virtual environment in
+`/opt/readerboard`, writes `/etc/readerboard/config.toml` with a freshly generated API key,
+and enables the `readerboard` service. It prints the key once, and it is safe to run
+again after pulling a new version: your config file and key are left alone.
+
+`sudo scripts/uninstall.sh` removes the service and the program but keeps your config and
+your registered messages, so reinstalling puts the sign back as it was. Add `--purge` to
+remove those too.
+
+## Using it
+
+Every write needs an `X-API-Key` header. `GET /health` does not.
+
+Register a message:
+
+```
+curl -X PUT http://localhost:5001/v2/messages/temperature \
+     -H 'X-API-Key: YOUR-KEY' -H 'Content-Type: application/json' \
+     -d '{"message": "<green>18.4<degree> <red><time>", "display_mode": "HOLD"}'
+```
+
+Register a second one and the sign rotates between them:
+
+```
+curl -X PUT http://localhost:5001/v2/messages/doorbell \
+     -H 'X-API-Key: YOUR-KEY' -H 'Content-Type: application/json' \
+     -d '{"message": "<amber>Someone at the door", "ttl_seconds": 300}'
+```
+
+Take the sign over for thirty seconds:
+
+```
+curl -X POST http://localhost:5001/v2/alerts \
+     -H 'X-API-Key: YOUR-KEY' -H 'Content-Type: application/json' \
+     -d '{"message": "<red><flash_on>SMOKE ALARM", "ttl_seconds": 30}'
+```
+
+The full API, including every markup token and display mode, is at `/docs`.
+
+### Writing messages
+
+A message is plain text plus tokens written as `<name>`: `<green>18.4<degree>` is a
+colour change, a number, and a degree symbol. `GET /v2/enumerations/markup-tokens` lists
+them all.
+
+Text is encoded against the sign's own character table rather than as UTF-8, so `café`
+displays correctly. A character the sign cannot render is rejected with a 400 on `/v2`,
+and replaced with `?` on the simpler endpoints described below.
+
+## A simpler set of endpoints
+
+Alongside `/v2` there is a smaller surface: `POST /Write/Message`,
+`POST /Write/ControlCommand`, and the `/Enumerations` reads.
+
+These follow one convention that `/v2` does not. **Every response is HTTP 200**, with the
+outcome in the body:
+
+```json
+{"result": "OK", "result_message": "Message displayed on sign"}
+```
+
+That suits a client which finds branching on status codes awkward, such as a Home
+Assistant `rest_command` or a shell one-liner in a cron job. The single exception is a
+missing or wrong API key, which is a 401: a caller the service will not talk to is not the
+same as a request that failed.
+
+`POST /Write/Message` writes to one reserved slot, named `default`. It deliberately does
+not touch the sign's **priority** file, which by protocol suppresses every other message on
+the sign. Written to an ordinary slot it looks identical while it is the only message
+registered, and it shares the sign the moment anything else registers.
+
+## Configuration
+
+Settings come from `/etc/readerboard/config.toml`, overridden by environment variables
+prefixed `READERBOARD_`. `packaging/config.example.toml` documents every one of them.
+
+The sign's address is a full pyserial URL in `serial_url`: `socket://192.168.2.51:4001`
+for an Ethernet to RS-232 adapter, `/dev/ttyUSB0` for a cable plugged straight in, or
+`loop://` to run the service with no sign attached.
+
+Two settings reallocate the sign's memory when changed, and **that erases every message
+on it**: `slot_count` and `slot_capacity`. The service will do it, and say so loudly in
+the log, but they are not settings to fiddle with.
+
+## Security
+
+An API key is required on every write, compared in constant time, and never logged.
+
+**Message content reaches the sign as protocol bytes**, so it is worth knowing what a
+client holding the key can do. The markup renderer emits bytes only for tokens it
+recognises and for characters in the sign's own table, so arbitrary control sequences
+cannot be injected through a message. What the holder of a key can do is display
+anything they like on your wall and set the sign's clock. There is nothing beyond the
+sign to reach: the service opens one serial link and touches nothing else.
+
+Sensible precautions remain sensible:
+
+- Do not expose the service to the internet.
+- Keep `/etc/readerboard/config.toml` mode 0640. Anyone who can read it can write to the
+  sign.
+- Give the key only to clients you trust, and prefer a firewall allow-list on top.
+- The service runs as a dedicated system user under a hardened systemd unit, which is
+  worth keeping rather than running it as root for convenience.
+
+## Development
+
+```
+pip install -e ".[dev]"
+pytest
+ruff check .
+mypy readerboard
+```
+
+No sign is needed. The tests run against a capturing fake transport and against
+pyserial's `loop://` URL, so the real serial code path is exercised without hardware.
+
+`docs/protocol-notes.md` records what the Alpha protocol actually says about the memory
+configuration, the run sequence and the priority file, with the quotations that back each
+claim. Read it before changing anything in `readerboard/protocol/`.
+
+`scripts/protocol_spike.py` settles the few questions the document cannot answer about
+this particular sign. It is destructive and refuses to run without `--confirm-erase`.
+
+## Licence
+
+MIT. See [LICENSE.md](LICENSE.md).
+
+One caveat, recorded because it is easy to miss.
+`readerboard/protocol/constants.py` is vendored from
+[jonathankoren/readerboard](https://github.com/jonathankoren/readerboard), and that
+repository carries no license file. No license is not the same as a permissive one: it
+means no copying permission has been granted at all. That module is therefore the one
+part of this project whose provenance is not cleanly MIT.
+
+In practice it is a table of byte values dictated by the protocol rather than authored
+expression, and `docs/protocol-notes.md` now cites the protocol document directly, so the
+table can be regenerated from the primary source if that ever needs settling properly.
+
+## Credits
+
+`readerboard/protocol/constants.py` came, with thanks, from
+[jonathankoren/readerboard](https://github.com/jonathankoren/readerboard), with some
+corrections noted in the file.
+
+The protocol itself is documented in the Alpha Sign Communications Protocol, form
+9708-8061, published by Adaptive Micro Systems.

readerboard-0.1.1/README.md

@@ -0,0 +1,206 @@
+# readerboard
+
+[![CI](https://github.com/mjaksn/readerboard/actions/workflows/ci.yml/badge.svg)](https://github.com/mjaksn/readerboard/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/readerboard)](https://pypi.org/project/readerboard/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mjaksn/readerboard/blob/main/LICENSE)
+
+An HTTP service that drives a BetaBrite Classic sign, either through a serial cable or
+through an Ethernet to RS-232 adapter.
+
+Several sources can share the sign at once. Each registers a named **slot**, and the sign
+rotates through the registered slots by itself. An **alert** takes the whole display over
+until it is released, after which the rotation resumes.
+
+## What it does
+
+- **Many messages, one sign.** Home Assistant can own `temperature` while a doorbell
+  automation owns `doorbell`, without either knowing about the other.
+- **The sign does the rotating.** Each message lives in its own sign file and the sign
+  cycles them on its own, so rotation costs no serial traffic at all.
+- **Alerts.** Take the display over, optionally with a deadline, then hand it back.
+- **It keeps the sign's clock right**, at startup, hourly, and whenever the link comes
+  back. That last trigger is the one that matters: a sign returning from a power cut
+  does so at no particular minute.
+- **It does not redraw the sign for nothing.** A write of bytes the sign already holds is
+  suppressed, so a source re-sending an unchanged temperature does not make the display
+  flicker.
+- **It survives restarts and outages.** The registered messages are persisted, and a
+  write that arrives while the sign is unreachable is accepted and delivered when the
+  link returns.
+- **Errors are errors.** A dead serial link is a 503, not an HTTP 200 with the word
+  ERROR in the body.
+
+## Requirements
+
+- Python 3.11 or newer.
+- A BetaBrite Classic, reachable either at a serial device such as `/dev/ttyUSB0` or over
+  the network through an Ethernet to RS-232 adapter at `socket://host:port`.
+- For the installer, a machine running systemd. The service itself runs anywhere Python
+  does; only `scripts/install.sh` is Linux specific.
+
+## Try it without a sign
+
+`loop://` is pyserial's loopback, so the service will start and serve its API with
+nothing attached.
+
+```
+pip install -e ".[dev]"
+READERBOARD_SERIAL_URL=loop:// READERBOARD_API_KEY=dev-key \
+    READERBOARD_STATE_PATH=./state.json \
+    python -m readerboard
+```
+
+Then open <http://127.0.0.1:5001/docs>.
+
+## Installing it properly
+
+```
+sudo scripts/install.sh --serial-url socket://192.168.2.51:4001
+```
+
+This creates a `readerboard` system user, builds a virtual environment in
+`/opt/readerboard`, writes `/etc/readerboard/config.toml` with a freshly generated API key,
+and enables the `readerboard` service. It prints the key once, and it is safe to run
+again after pulling a new version: your config file and key are left alone.
+
+`sudo scripts/uninstall.sh` removes the service and the program but keeps your config and
+your registered messages, so reinstalling puts the sign back as it was. Add `--purge` to
+remove those too.
+
+## Using it
+
+Every write needs an `X-API-Key` header. `GET /health` does not.
+
+Register a message:
+
+```
+curl -X PUT http://localhost:5001/v2/messages/temperature \
+     -H 'X-API-Key: YOUR-KEY' -H 'Content-Type: application/json' \
+     -d '{"message": "<green>18.4<degree> <red><time>", "display_mode": "HOLD"}'
+```
+
+Register a second one and the sign rotates between them:
+
+```
+curl -X PUT http://localhost:5001/v2/messages/doorbell \
+     -H 'X-API-Key: YOUR-KEY' -H 'Content-Type: application/json' \
+     -d '{"message": "<amber>Someone at the door", "ttl_seconds": 300}'
+```
+
+Take the sign over for thirty seconds:
+
+```
+curl -X POST http://localhost:5001/v2/alerts \
+     -H 'X-API-Key: YOUR-KEY' -H 'Content-Type: application/json' \
+     -d '{"message": "<red><flash_on>SMOKE ALARM", "ttl_seconds": 30}'
+```
+
+The full API, including every markup token and display mode, is at `/docs`.
+
+### Writing messages
+
+A message is plain text plus tokens written as `<name>`: `<green>18.4<degree>` is a
+colour change, a number, and a degree symbol. `GET /v2/enumerations/markup-tokens` lists
+them all.
+
+Text is encoded against the sign's own character table rather than as UTF-8, so `café`
+displays correctly. A character the sign cannot render is rejected with a 400 on `/v2`,
+and replaced with `?` on the simpler endpoints described below.
+
+## A simpler set of endpoints
+
+Alongside `/v2` there is a smaller surface: `POST /Write/Message`,
+`POST /Write/ControlCommand`, and the `/Enumerations` reads.
+
+These follow one convention that `/v2` does not. **Every response is HTTP 200**, with the
+outcome in the body:
+
+```json
+{"result": "OK", "result_message": "Message displayed on sign"}
+```
+
+That suits a client which finds branching on status codes awkward, such as a Home
+Assistant `rest_command` or a shell one-liner in a cron job. The single exception is a
+missing or wrong API key, which is a 401: a caller the service will not talk to is not the
+same as a request that failed.
+
+`POST /Write/Message` writes to one reserved slot, named `default`. It deliberately does
+not touch the sign's **priority** file, which by protocol suppresses every other message on
+the sign. Written to an ordinary slot it looks identical while it is the only message
+registered, and it shares the sign the moment anything else registers.
+
+## Configuration
+
+Settings come from `/etc/readerboard/config.toml`, overridden by environment variables
+prefixed `READERBOARD_`. `packaging/config.example.toml` documents every one of them.
+
+The sign's address is a full pyserial URL in `serial_url`: `socket://192.168.2.51:4001`
+for an Ethernet to RS-232 adapter, `/dev/ttyUSB0` for a cable plugged straight in, or
+`loop://` to run the service with no sign attached.
+
+Two settings reallocate the sign's memory when changed, and **that erases every message
+on it**: `slot_count` and `slot_capacity`. The service will do it, and say so loudly in
+the log, but they are not settings to fiddle with.
+
+## Security
+
+An API key is required on every write, compared in constant time, and never logged.
+
+**Message content reaches the sign as protocol bytes**, so it is worth knowing what a
+client holding the key can do. The markup renderer emits bytes only for tokens it
+recognises and for characters in the sign's own table, so arbitrary control sequences
+cannot be injected through a message. What the holder of a key can do is display
+anything they like on your wall and set the sign's clock. There is nothing beyond the
+sign to reach: the service opens one serial link and touches nothing else.
+
+Sensible precautions remain sensible:
+
+- Do not expose the service to the internet.
+- Keep `/etc/readerboard/config.toml` mode 0640. Anyone who can read it can write to the
+  sign.
+- Give the key only to clients you trust, and prefer a firewall allow-list on top.
+- The service runs as a dedicated system user under a hardened systemd unit, which is
+  worth keeping rather than running it as root for convenience.
+
+## Development
+
+```
+pip install -e ".[dev]"
+pytest
+ruff check .
+mypy readerboard
+```
+
+No sign is needed. The tests run against a capturing fake transport and against
+pyserial's `loop://` URL, so the real serial code path is exercised without hardware.
+
+`docs/protocol-notes.md` records what the Alpha protocol actually says about the memory
+configuration, the run sequence and the priority file, with the quotations that back each
+claim. Read it before changing anything in `readerboard/protocol/`.
+
+`scripts/protocol_spike.py` settles the few questions the document cannot answer about
+this particular sign. It is destructive and refuses to run without `--confirm-erase`.
+
+## Licence
+
+MIT. See [LICENSE.md](LICENSE.md).
+
+One caveat, recorded because it is easy to miss.
+`readerboard/protocol/constants.py` is vendored from
+[jonathankoren/readerboard](https://github.com/jonathankoren/readerboard), and that
+repository carries no license file. No license is not the same as a permissive one: it
+means no copying permission has been granted at all. That module is therefore the one
+part of this project whose provenance is not cleanly MIT.
+
+In practice it is a table of byte values dictated by the protocol rather than authored
+expression, and `docs/protocol-notes.md` now cites the protocol document directly, so the
+table can be regenerated from the primary source if that ever needs settling properly.
+
+## Credits
+
+`readerboard/protocol/constants.py` came, with thanks, from
+[jonathankoren/readerboard](https://github.com/jonathankoren/readerboard), with some
+corrections noted in the file.
+
+The protocol itself is documented in the Alpha Sign Communications Protocol, form
+9708-8061, published by Adaptive Micro Systems.

readerboard-0.1.1/pyproject.toml

@@ -0,0 +1,152 @@
+[build-system]
+requires = ["setuptools>=77"]        # PEP 639 licence expressions
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "readerboard"
+version = "0.1.1"
+description = "An HTTP service for BetaBrite and Alpha protocol LED signs: several sources share one sign, with alerts, scheduling and clock sync"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "mjaksn" }]
+keywords = ["betabrite", "alpha", "led sign", "readerboard", "home assistant", "rs-232", "signage"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Home Automation",
+    "Topic :: System :: Hardware",
+    "Typing :: Typed",
+]
+
+# Floors and ceilings rather than exact pins. This is something people install
+# beside other things, and `==` would make it a package that has to be
+# uninstalled before anything else can move. requirements.lock carries the exact
+# versions, and that is what the installer feeds the machine driving the sign.
+#
+# The ceilings sit at the next major for the settled packages, and at the next
+# minor for the two still on 0.x, where a minor bump is where a breaking change
+# is allowed to live.
+dependencies = [
+    "fastapi>=0.141.1,<0.142",
+    "uvicorn[standard]>=0.52.1,<0.53",
+    "pydantic>=2.13.4,<3",
+    "pydantic-settings>=2.15.0,<3",
+    "pyserial>=3.5,<4",
+    # Linux ships a system time zone database and zoneinfo reads it directly.
+    # Windows ships none, so the `timezone` setting would fail there without it.
+    "tzdata>=2026.3; sys_platform == 'win32'",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.1.1,<10",
+    "pytest-asyncio>=1.4.0,<2",
+    # starlette's TestClient moved to httpx2; plain httpx now raises a
+    # deprecation warning, which this suite is configured to treat as an error.
+    "httpx2>=2.10.0,<3",
+    "ruff>=0.16.2,<0.17",
+    "mypy>=2.3.0,<3",
+]
+
+[project.scripts]
+# The whole command line. `python -m readerboard` runs the same thing out of a
+# checkout, which is what the systemd unit and the editor launch config use.
+readerboard = "readerboard.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/mjaksn/readerboard"
+Source = "https://github.com/mjaksn/readerboard"
+Issues = "https://github.com/mjaksn/readerboard/issues"
+Changelog = "https://github.com/mjaksn/readerboard/blob/main/CHANGELOG.md"
+
+[tool.setuptools]
+# Named explicitly rather than auto-discovered: the flat layout puts `tests`
+# beside the package and it has an __init__.py, so discovery would ship it.
+packages = [
+    "readerboard",
+    "readerboard.api",
+    "readerboard.protocol",
+    "readerboard.services",
+    "readerboard.sign",
+    "readerboard.transport",
+]
+
+[tool.setuptools.package-data]
+# Without this the marker is left out of the wheel and the annotations are
+# invisible to anyone type checking against the installed package.
+readerboard = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q --strict-markers --strict-config"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+filterwarnings = ["error"]
+
+[tool.ruff]
+line-length = 110
+target-version = "py311"
+
+[tool.ruff.lint]
+# Stricter than the other projects here, and deliberately so. This one is a
+# service rather than a command: it runs unattended for months, and the prose it
+# emits is part of what it delivers, so the docstring rules are carrying weight
+# rather than decorating.
+select = [
+    "E",    # pycodestyle
+    "W",    # pycodestyle warnings
+    "F",    # pyflakes
+    "I",    # import sorting
+    "B",    # bugbear
+    "UP",   # pyupgrade
+    "SIM",  # simplify
+    "RUF",  # ruff's own rules
+    "D",    # docstrings
+]
+ignore = [
+    "D203",  # incompatible with D211, which is the one we want
+    "D213",  # incompatible with D212, which is the one we want
+    # This project formats with %, matching the lazy % that logging takes, so
+    # that one idiom covers both a log line and the exception text next to it.
+    "UP031",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# The vendored constants table is a wall of assignments with trailing comments,
+# and rewriting it into docstring-bearing prose would only obscure its origin.
+"readerboard/protocol/constants.py" = ["E501", "RUF001", "RUF003"]
+# A test's name is its documentation, and a docstring repeating it would be
+# worse than none. Tests that need explaining have one anyway.
+"tests/*" = ["D100", "D101", "D102", "D103", "D105", "D107"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.mypy]
+python_version = "3.11"
+files = ["readerboard"]
+strict = true
+warn_unreachable = true
+enable_error_code = ["redundant-expr", "truthy-bool", "ignore-without-code"]
+
+[[tool.mypy.overrides]]
+# pyserial ships no type information.
+module = ["serial", "serial.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+# The vendored constants module is a flat table of byte literals; annotating
+# every one of them would add nothing a reader does not already see.
+module = "readerboard.protocol.constants"
+disallow_untyped_defs = false

readerboard-0.1.1/readerboard/__init__.py

@@ -0,0 +1,10 @@
+"""An HTTP service that drives a BetaBrite Classic sign over the Alpha protocol.
+
+The version here and the one in pyproject.toml are checked against each other,
+and against the release tag, before anything is published. See
+.github/workflows/release.yml.
+"""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.1"