No project description provided

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for PeterJCLaw from gravatar.com PeterJCLaw

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

Build Status Docs Status

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

Configuration

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

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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page