squoredata 0.1.0__tar.gz

squoredata-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+__pycache__/
+*.py[cod]
+.coverage
+*.egg-info/
+.venv/
+.envrc

squoredata-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.

squoredata-0.1.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.5
+Name: squoredata
+Version: 0.1.0
+Summary: Self-contained Pydantic data structures used by Squore tablets
+Author-email: "martin f. krafft" <squoredata@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: pydantic
+Provides-Extra: dev
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: mypy; 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'
+Description-Content-Type: text/markdown
+
+# squoredata
+
+Self-contained [Pydantic](https://docs.pydantic.dev) v2 data structures used by
+[Squore](https://github.com/obbimi/Squore) scoreboard tablets.
+
+The package was extracted from [`tcboard`](https://github.com/madduck/tcboard).
+It contains only the data models, not the surrounding server logic. TypeScript
+bindings are generated from the models so that a JavaScript or TypeScript
+project can consume the same shape.
+
+## Models
+
+- `SquoreMatch` — a match as used by Squore, without any live information.
+- `SquoreMatchLiveData` — a `SquoreMatch` together with the live data a tablet
+  reports. It adds the `court` and `timestamp` fields.
+
+Supporting models: `Players`, `Colors`, `Countries`, `Clubs`, `Event`, `Format`,
+`Wifi`, `Metadata`, `SquoreDeviceInfo`, `TimerInfo`, `Timing`, `When`, `Point`,
+`Game`, and the `LiveStatus` enum.
+
+## Install
+
+```sh
+pip install squoredata
+```
+
+## TypeScript bindings
+
+`scripts/generate_ts.py` renders the JSON Schema of each model and converts it
+to TypeScript with
+[`json-schema-to-typescript`](https://www.npmjs.com/package/json-schema-to-typescript).
+The output lives in `typescript/` and is committed:
+
+- `SquoreMatch.d.ts`, `SquoreMatchLiveData.d.ts` — the interfaces
+- `SquoreMatch.schema.json`, `SquoreMatchLiveData.schema.json` — the schemata
+- `index.d.ts` — re-exports
+
+The Hatch build hook (`hatch_build.py`) runs the generator before a wheel is
+built, so a release can never carry stale bindings.
+
+Install the generated bindings into another project from the `typescript/`
+directory, or from a published `squoredata-types` package:
+
+```sh
+npm install /path/to/squoredata/typescript
+```
+
+## Golden tests
+
+The files in `golden/` are the shared contract between the two sides:
+
+- `tests/test_golden.py` serialises and re-validates the models against the
+  golden JSON.
+- `typescript/tests/golden.ts` assigns the same JSON to the generated
+  interfaces, so `tsc --noEmit` fails when the two sides diverge.
+
+Regenerate the golden files with `python scripts/make_golden.py` after a model
+change.
+
+## Development
+
+```sh
+pip install -e .[dev]
+ruff check .
+pytest
+mypy --strict .
+
+npm install
+node_modules/.bin/tsc --noEmit -p tsconfig.json
+```

squoredata-0.1.0/README.md

@@ -0,0 +1,70 @@
+# squoredata
+
+Self-contained [Pydantic](https://docs.pydantic.dev) v2 data structures used by
+[Squore](https://github.com/obbimi/Squore) scoreboard tablets.
+
+The package was extracted from [`tcboard`](https://github.com/madduck/tcboard).
+It contains only the data models, not the surrounding server logic. TypeScript
+bindings are generated from the models so that a JavaScript or TypeScript
+project can consume the same shape.
+
+## Models
+
+- `SquoreMatch` — a match as used by Squore, without any live information.
+- `SquoreMatchLiveData` — a `SquoreMatch` together with the live data a tablet
+  reports. It adds the `court` and `timestamp` fields.
+
+Supporting models: `Players`, `Colors`, `Countries`, `Clubs`, `Event`, `Format`,
+`Wifi`, `Metadata`, `SquoreDeviceInfo`, `TimerInfo`, `Timing`, `When`, `Point`,
+`Game`, and the `LiveStatus` enum.
+
+## Install
+
+```sh
+pip install squoredata
+```
+
+## TypeScript bindings
+
+`scripts/generate_ts.py` renders the JSON Schema of each model and converts it
+to TypeScript with
+[`json-schema-to-typescript`](https://www.npmjs.com/package/json-schema-to-typescript).
+The output lives in `typescript/` and is committed:
+
+- `SquoreMatch.d.ts`, `SquoreMatchLiveData.d.ts` — the interfaces
+- `SquoreMatch.schema.json`, `SquoreMatchLiveData.schema.json` — the schemata
+- `index.d.ts` — re-exports
+
+The Hatch build hook (`hatch_build.py`) runs the generator before a wheel is
+built, so a release can never carry stale bindings.
+
+Install the generated bindings into another project from the `typescript/`
+directory, or from a published `squoredata-types` package:
+
+```sh
+npm install /path/to/squoredata/typescript
+```
+
+## Golden tests
+
+The files in `golden/` are the shared contract between the two sides:
+
+- `tests/test_golden.py` serialises and re-validates the models against the
+  golden JSON.
+- `typescript/tests/golden.ts` assigns the same JSON to the generated
+  interfaces, so `tsc --noEmit` fails when the two sides diverge.
+
+Regenerate the golden files with `python scripts/make_golden.py` after a model
+change.
+
+## Development
+
+```sh
+pip install -e .[dev]
+ruff check .
+pytest
+mypy --strict .
+
+npm install
+node_modules/.bin/tsc --noEmit -p tsconfig.json
+```