Skip to main content

HTTP API for Student Robotics Competition Software

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sr.comp.http-1.7.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

sr.comp.http-1.7.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file sr.comp.http-1.7.0.tar.gz.

File metadata

  • Download URL: sr.comp.http-1.7.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for sr.comp.http-1.7.0.tar.gz
Algorithm Hash digest
SHA256 b9b50be992a74d7b3422dc6557dc495d70c72788ae1ce4256d994aefd49ef82d
MD5 29aeea21f956d406d57f86be47a42ebe
BLAKE2b-256 6248817983c94ae26db77014d69e364c0b5eba27f20c59b9894c6b351b81521a

See more details on using hashes here.

Provenance

File details

Details for the file sr.comp.http-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: sr.comp.http-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for sr.comp.http-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b02c77c3f84f6a795c059ca87c942f479890acd11a17ab39be723969a7fba9a
MD5 f84fca746cd93ab84b063354183c16f7
BLAKE2b-256 8bcd4682d2b8e631c838d9df919fa29a08629d9ed14256c84c606b2d80d8d8db

See more details on using hashes here.

Provenance

Supported by

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