tcboard 0.1.0__tar.gz

tcboard-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+/.pytest_cache
+__pycache__
+/.stfolder
+.*.sw?
+*.py[oc]
+/.stignore
+/.envrc
+.coverage
+*.sqlite
+/.direnv

tcboard-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v2.4.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pydantic
+          - click
+          - click_extra (>= 9.4.1)
+          - fastapi
+          - starlette
+          - pytest
+          - pytest-asyncio
+          - tptools
+          - click-async-plugins (>= 0.7.4)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.10
+    hooks:
+      - id: ruff-check
+        args: [--show-fixes]
+      - id: ruff-format
+        args: [--diff]
+
+fail_fast: true

tcboard-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 martin f. krafft
+
+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.

tcboard-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.5
+Name: tcboard
+Version: 0.1.0
+Summary: Server to collect and provide tournament data
+Author-email: "martin f. krafft" <tcboard@pobox.madduck.net>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13
+Requires-Dist: aiomqtt
+Requires-Dist: aiosqlite
+Requires-Dist: aiostream
+Requires-Dist: click
+Requires-Dist: click-async-plugins>=0.7.4
+Requires-Dist: click-extra>=9.4.1
+Requires-Dist: fastapi
+Requires-Dist: pydantic
+Requires-Dist: tabulate
+Requires-Dist: tptools
+Requires-Dist: uvicorn
+Requires-Dist: uvloop; sys_platform == 'linux'
+Provides-Extra: dev
+Requires-Dist: click-extra[pytest]; extra == 'dev'
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: fastapi[standard]; extra == 'dev'
+Requires-Dist: ipdb; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Requires-Dist: pytest-ruff; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-python-dateutil; extra == 'dev'
+Requires-Dist: types-tabulate; extra == 'dev'
+Description-Content-Type: text/markdown
+
+[![Style and unit tests badge](https://github.com/madduck/tcboard/actions/workflows/0-testing.yml/badge.svg)](https://github.com/madduck/tcboard/actions/workflows/0-testing.yml)
+
+# TCBoard — Server to collect and provide tournament data
+
+TODO
+
+## Contributing
+
+To contribute, please ensure you have the appropriate dependencies installed:
+
+```
+pip install -e .[dev]
+```
+
+and then install the Git pre-commit hooks that ensure that any commits conform
+with the coding-style used by this project.
+
+```
+pre-commit install
+```
+
+All code (except for the CLI) is 100% test-covered, and all
+contributions are expected to keep this up. Use `pytest` to run the test suite.
+
+Note that all code is typed, and typing is part of test-coverage.
+
+## Known Problems
+
+None at this point (but there will be some).
+
+## TODO
+
+In addition to various comments including the word "TODO" in the code, there are
+a few things left to do:
+
+* Test the CLI
+* Test the HTTP APIs
+
+## Legalese
+
+`tcboard` is © 2024–6 martin f. krafft <tcboard@pobox.madduck.net>.
+
+It is released under the terms of the MIT Licence.

tcboard-0.1.0/README.md

@@ -0,0 +1,43 @@
+[![Style and unit tests badge](https://github.com/madduck/tcboard/actions/workflows/0-testing.yml/badge.svg)](https://github.com/madduck/tcboard/actions/workflows/0-testing.yml)
+
+# TCBoard — Server to collect and provide tournament data
+
+TODO
+
+## Contributing
+
+To contribute, please ensure you have the appropriate dependencies installed:
+
+```
+pip install -e .[dev]
+```
+
+and then install the Git pre-commit hooks that ensure that any commits conform
+with the coding-style used by this project.
+
+```
+pre-commit install
+```
+
+All code (except for the CLI) is 100% test-covered, and all
+contributions are expected to keep this up. Use `pytest` to run the test suite.
+
+Note that all code is typed, and typing is part of test-coverage.
+
+## Known Problems
+
+None at this point (but there will be some).
+
+## TODO
+
+In addition to various comments including the word "TODO" in the code, there are
+a few things left to do:
+
+* Test the CLI
+* Test the HTTP APIs
+
+## Legalese
+
+`tcboard` is © 2024–6 martin f. krafft <tcboard@pobox.madduck.net>.
+
+It is released under the terms of the MIT Licence.

tcboard-0.1.0/app.py

@@ -0,0 +1,170 @@
+import asyncio
+import logging
+import os
+import pathlib
+import sys
+import warnings
+from collections.abc import AsyncGenerator
+from contextlib import AsyncExitStack, asynccontextmanager
+from functools import partial
+from typing import Literal
+
+from click_async_plugins import (
+    ITC,
+    PluginFactory,
+    create_plugin_task,
+    setup_plugins,
+)
+from fastapi import FastAPI
+from httpx2 import URL
+from tptools.util import is_truish, silence_logger
+
+from tcboard.board import TCBoard
+from tcboard.cli.api import configure_api
+from tcboard.cli.db import database_backend
+from tcboard.cli.debug import debug_key_press_handler
+from tcboard.cli.main import (
+    make_app,
+    on_board_update,
+    process_squore_livedata,
+    receive_tournament,
+)
+from tcboard.cli.remotectrl import remote_control_publisher
+from tcboard.cli.squoremqtt import listen_for_mqtt_messages
+from tcboard.cli.tptools import setup_for_tptools
+from tcboard.cli.util import CliContext
+from tcboard.cli.ws import configure_for_websockets
+
+logging.getLogger().setLevel(logging.DEBUG)
+
+if not sys.warnoptions:
+    warnings.simplefilter("default")
+    logging.captureWarnings(True)
+
+
+THIRD_PARTY_LOG_LEVELS = [
+    ("asyncio", logging.INFO),
+    ("aiosqlite", logging.INFO),
+    ("watchfiles", logging.WARNING),
+    ("uvicorn", logging.INFO),
+    ("uvicorn.error", logging.WARNING),
+    ("click_async_plugins", logging.DEBUG),
+    ("httpcore2", logging.INFO),
+    ("httpx2", logging.INFO),
+]
+
+if is_truish(os.getenv("LESS_DEBUG", os.getenv("LESSDEBUG"))):
+    LOG_LEVELS = [
+        (__name__, logging.INFO),
+        ("tptools", logging.INFO),
+        ("tcboard.cli", logging.INFO),
+        ("tcboard.dbmanager", logging.INFO),
+        ("tcboard.board", logging.INFO),
+    ]
+else:
+    LOG_LEVELS = []
+
+for name, level in LOG_LEVELS + THIRD_PARTY_LOG_LEVELS:
+    silence_logger(name, level=level)
+
+logger = logging.getLogger(__name__)
+
+
+MQTT_BROKER = os.getenv("MQTT_BROKER", "127.0.0.1:1883")
+
+DB_FILE: pathlib.Path | Literal[":memory:"] | None
+if (envfile := os.getenv("DB", os.getenv("DB_FILE"))) is None:
+    DB_FILE = pathlib.Path(__file__).parent / "db.sqlite"
+
+elif envfile == ":memory:":
+    DB_FILE = None
+
+else:
+    DB_FILE = pathlib.Path(envfile)
+
+database_backend = partial(database_backend, file=DB_FILE)
+
+debug_match_ids: list[str] = []
+if dmis := os.getenv("DEBUG_MATCH_IDS", ""):
+    debug_match_ids = dmis.split(",")
+
+
+@asynccontextmanager
+async def app_lifespan(api: FastAPI) -> AsyncGenerator[None]:
+    board = TCBoard(debug_match_ids=debug_match_ids)
+    itc = ITC()
+    itc.set("board", board)
+
+    clictx = CliContext(api=api, itc=itc)
+
+    board.register_update_function(partial(on_board_update, itc=itc))
+
+    broker = MQTT_BROKER.split(":")
+    port: int | str
+    if len(broker) == 3:
+        proto, host, port = broker
+        assert proto == "mqtt"
+        host = host[2:]
+
+    elif len(broker) == 2:
+        host, port = broker
+
+    else:
+        port = 1883
+        host = broker[0]
+
+    squoremqtt_client = partial(
+        listen_for_mqtt_messages, server=host, port=int(port), ignore_retained=True
+    )
+    remote_control = partial(remote_control_publisher)
+
+    BOOTSTRAP_URL = os.getenv("BOOTSTRAP_URL")
+    tptools = partial(
+        setup_for_tptools,
+        load_from_url=None if BOOTSTRAP_URL is None else URL(BOOTSTRAP_URL),
+    )
+
+    factories: list[PluginFactory] = [
+        debug_key_press_handler,
+        database_backend,
+        tptools,
+        receive_tournament,
+        process_squore_livedata,
+        squoremqtt_client,
+        remote_control,
+        configure_for_websockets,
+        configure_api,
+    ]
+
+    try:
+        async with AsyncExitStack() as stack:
+            tasks = await setup_plugins(factories, stack=stack, clictx=clictx)
+
+            try:
+                async with asyncio.TaskGroup() as tg:
+                    plugin_task = partial(
+                        create_plugin_task, create_task_fn=tg.create_task
+                    )
+                    for task in tasks:
+                        plugin_task(task)
+                    logger.debug("Tasks:")
+                    for t in tg._tasks:
+                        logger.debug(f"  {t}")
+                    yield
+                    raise asyncio.CancelledError
+
+            except asyncio.CancelledError:
+                logger.info("Exiting…")
+
+    except* RuntimeError:
+        logger.exception("A runtime error occurred")
+
+    except* Exception as exc:
+        import ipdb
+
+        logger.exception("")
+        ipdb.set_trace()  # noqa: E402 E702 I001 # fmt: skip
+        _ = exc
+
+
+app = make_app(lifespan=app_lifespan)

tcboard-0.1.0/conftest.py

@@ -0,0 +1,3 @@
+import logging
+
+logging.getLogger("asyncio").setLevel(logging.WARN)

tcboard-0.1.0/pyproject.toml

@@ -0,0 +1,98 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "tcboard/_version.py"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.sdist]
+exclude = [".direnv", ".gitignore", ".github"]
+
+[project]
+name = "tcboard"
+dynamic = ["version"]
+authors = [{ name = "martin f. krafft", email = "tcboard@pobox.madduck.net" }]
+description = "Server to collect and provide tournament data"
+readme = "README.md"
+requires-python = ">=3.13"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+dependencies = [
+  "tptools",
+  "pydantic",
+  "uvloop; sys_platform == 'linux'",
+  "click",
+  "click-extra (>= 9.4.1)",
+  "click-async-plugins (>= 0.7.4)",
+  "fastapi",
+  "uvicorn",
+  "aiomqtt",
+  "aiosqlite",
+  "aiostream",
+  "tabulate",
+]
+
+[project.optional-dependencies]
+dev = [
+  "fastapi[standard]",
+  "pytest",
+  "pytest-mock",
+  "pytest-asyncio",
+  "pytest-ruff",
+  "click-extra[pytest]",
+  "ipdb",
+  "mypy",
+  "ruff",
+  "pre-commit",
+  "coverage",
+  "pytest-cov",
+  "types-tabulate",
+  "types-python-dateutil",
+]
+
+[project.scripts]
+tcboard = "tcboard.cli.main:tcboard"
+
+[tool.pytest.ini_options]
+testpaths = ["tests", "integration"]
+addopts = """
+  -ra
+  --pdbcls=IPython.terminal.debugger:TerminalPdb
+  --cov=tcboard --cov-report term-missing:skip-covered --no-cov-on-fail
+  --ruff --ruff-format --ruff-config 'lint.ignore = ["I001", "F401", "F841"]'
+"""
+asyncio_default_fixture_loop_scope = "function"
+log_level = "WARNING"
+log_format = "%(name)s %(levelname)s %(message)s"
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = ["B", "C", "E", "F", "I", "W", "B9"]
+
+[tool.mypy]
+strict = true
+warn_unreachable = true
+
+[[tool.mypy.overrides]]
+module = "ipdb"
+ignore_missing_imports = true
+
+[tool.coverage.report]
+exclude_also = [
+  'def __repr__',
+  'if TYPE_CHECKING:',
+  'class .*\bProtocol\):',
+  '@overload',
+  '@(abc\.)?abstractmethod',
+  'raise NotImplementedError',
+  'raise AssertionError',
+]

tcboard-0.1.0/tcboard/__init__.py

@@ -0,0 +1,19 @@
+from .board import TCBoard
+from .exceptions import TCBoardException
+from .match import TCMatch
+from .tournament import TCTournament
+
+VERSION: str | None
+try:
+    from ._version import version as VERSION
+
+except ImportError:  # pragma: nocover
+    Version = None
+
+__all__ = [
+    "TCBoard",
+    "TCBoardException",
+    "TCMatch",
+    "TCTournament",
+    "VERSION",
+]

tcboard-0.1.0/tcboard/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None

tcboard-0.1.0/tcboard/alert.py

@@ -0,0 +1,71 @@
+# needed < 3.14 so that annotations aren't evaluated
+from __future__ import annotations
+
+import traceback
+import uuid
+from datetime import datetime
+from types import TracebackType
+from typing import Any, Self, cast
+
+from pydantic import (
+    UUID4,
+    BaseModel,
+    Field,
+)
+
+
+class Alert(BaseModel):
+    text: str
+    id: UUID4 = Field(default_factory=uuid.uuid4)
+    detail: str | None = None
+    matchid: str | None = None
+    deviceid: str | None = None
+    timestamp: datetime | None = None
+    traceback: str | None = Field(default=None, repr=False)
+    cleared: datetime | None = None
+
+    def model_post_init(self, _: Any) -> None:
+        if self.timestamp is None:
+            self.timestamp = datetime.now()
+
+    @classmethod
+    def from_exception(cls, exc: Exception, **kwargs: Any) -> Self:
+        text = kwargs.pop("text", None) or str(exc)
+        return cls(text=text, traceback=cls.format_tb(exc.__traceback__), **kwargs)
+
+    @staticmethod
+    def format_tb(tback: TracebackType | None) -> str | None:
+        if tback is None:
+            return None
+        return "\n".join(traceback.format_tb(tback))
+
+    def clear(self, timestamp: datetime | None = None) -> None:
+        self.cleared = timestamp if timestamp is not None else datetime.now()
+
+    def __hash__(self) -> int:
+        return hash((self.text, self.matchid, self.cleared))
+
+    def __eq__(self, other: object) -> bool:
+        try:
+            other = cast(Alert, other)
+            return (self.text, self.matchid, self.cleared) == (
+                other.text,
+                other.matchid,
+                other.cleared,
+            )
+        except AttributeError:
+            return False
+
+    def __str__(self) -> str:
+        text = self.text
+        if self.detail:
+            text = f"{text}: {self.detail}"
+
+        ret = [text]
+        if self.matchid is not None:
+            ret.append(f"matchid={self.matchid}")
+
+        if self.deviceid is not None:
+            ret.append(f"deviceid={self.deviceid}")
+
+        return ", ".join(ret)