Skip to main content

Reliable software for running robotics competitions

Project description

Build Status Docs Status

Yet Another attempt at some Competition Software for Student Robotics.

The SRComp wiki provides an overview of the suite as a whole.

This repository provides a python API to accessing information about the state of the competition. That compstate is stored as a collection of YAML files in a git repository. This allows the state of the competition to be managed in isolation from the software while still providing consistent representations of that state.


Python clients should install the library using:

pip install sr.comp

Only the SRComp is class directly exposed, and it should be constructed around the path to a local working copy of a compstate repo.

from srcomp import SRComp
comp = SRComp('/path/to/compstate')

Web clients should look at using the HTTP API provided by srcomp-http rather than implementing their own intermediary.

There is also a command line interface which provides utilities for managing a compstate repo: srcomp-cli.

See the dummy-comp for an example of the structure and values expected in a compstate repo.


Install: pip install -e . -r dev-requirements.txt

Test: ./run-tests

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-1.6.0.tar.gz (34.7 kB view hashes)

Uploaded source

Built Distribution

sr.comp-1.6.0-py2.py3-none-any.whl (60.1 kB view hashes)

Uploaded py2 py3

Supported by

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