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.
