Skip to content

sourcebots/srcomp

This branch is 3 commits behind PeterJCLaw/srcomp:main.

Folders and files

NameName
Last commit message
Last commit date
Aug 4, 2024
Jan 29, 2023
Aug 4, 2024
Aug 4, 2024
Aug 4, 2024
Aug 4, 2024
Apr 21, 2018
Oct 12, 2019
Feb 10, 2015
Mar 12, 2024
Mar 11, 2015
Mar 15, 2020
Aug 4, 2024
Jan 21, 2023
Apr 13, 2024
Aug 4, 2024
Jan 21, 2015

Repository files navigation

SRComp

Build Status Docs Status

Reliable software for running robotics competitions, primarily used by 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 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.

Development

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

Checks: ./script/check

About

Reliable software for running robotics competitions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.6%
  • Shell 0.4%