A HTTP interface around SRComp, the fifth round of Student Robotics competition software.
This repository provides a JSON API to accessing information about the state of the competition. It is a lightweight Flask application wrapping the SRComp python APIs to the competition state.
Usage
Install:
pip install sr.comp.httpConfiguration
In deployment you should configure the app by setting the COMPSTATE key of the app’s config to the absolute path of the compstate which the server intends to serve.
from sr.comp.http import app
app.config['COMPSTATE'] = '/path/to/compstate'Development
Clone:
For tests to work, you will need to clone the tests/dummy submodule too:
git submodule update --init
Install:
pip install -e .Run: ./run $COMPSTATE.
Test: ./run-tests
Developers may wish to use the SRComp Dev repo to setup a dev instance.
State Caching
Since loading a given state repo takes a non-trivial amount of time, this is cached within the Flask application. Updates to the state repo are not tracked directly, and must be signalled by running the ./update script provided.
1 maintainer
Release files for sr.comp.http 1.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sr_comp_http-1.11.0.tar.gz | 30.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sr_comp_http-1.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 58.1 kB
Release files / sr_comp_http-1.11.0.tar.gz
| Download URL | sr_comp_http-1.11.0.tar.gz |
|---|---|
| Size | 30.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3834767ebc3e0108cb9c9282d933e7a1b0ed24637022d722d1a3b0b9ee516b3d
|
|
BLAKE2b-256 checksum How to use checksums |
4f35b9589c818b2d1db1f101631f8beb490059718f08f0711c962ea86861e149
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / sr_comp_http-1.11.0-py3-none-any.whl
| Download URL | sr_comp_http-1.11.0-py3-none-any.whl |
|---|---|
| Size | 27.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7fbbcb5b1cb5037b528138f283af189e622cb75957d4c518d85d815c56c423cb
|
|
BLAKE2b-256 checksum How to use checksums |
596e2d613b9e093ec36c75e60ea4c397007e00ecdcc40d68b2733824024a73c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
