HTTP API for Student Robotics Competition Software
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sr.comp.http-1.8.3.tar.gz.
File metadata
- Download URL: sr.comp.http-1.8.3.tar.gz
- Upload date:
- Size: 12.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c80c20f3f22bfea7a809aa268cbac20babbac324c267734b40772ecf7252b3b5 |
|
| MD5 | 97c95eab03cf244539e0e4e05bcc8c42 |
|
| BLAKE2b-256 | 5a6e926081240ba43743425ffd7f4d72ec1753dad4da2c921dc9dede002fa3ee |
Provenance
File details
Details for the file sr.comp.http-1.8.3-py3-none-any.whl.
File metadata
- Download URL: sr.comp.http-1.8.3-py3-none-any.whl
- Upload date:
- Size: 26.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5938490ad78159a26e69802bb2a8439787e332efcf97df6f5a2870aaeecc8f42 |
|
| MD5 | 42c7dcb9358715b1329c7f214124e954 |
|
| BLAKE2b-256 | 2d299d848c1885ae2bfbf1af981be62d592941a5699b0554c279ff943a548ed0 |
