Skip to content
Reliable software for running robotics competitions
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
docs
sr
tests
.gitignore
.gitmodules
.mailmap
.pylintrc
.travis.yml
AUTHORS.rst
README.rst
lint
run-tests
setup.cfg
setup.py
validate

README.rst

SRComp

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.

Usage

Python clients should submodule this repo and then import it. 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.

Requirements

  • python-dateutil
  • PyYAML
  • nose (for testing)
  • mock (for testing)

Test with

./run-tests

You can’t perform that action at this time.