|Build Status| |Docs Status|
Reliable software for running robotics competitions, primarily used by
Student Robotics <https://studentrobotics.org>
__.
The SRComp wiki <https://github.com/PeterJCLaw/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:
.. code:: shell
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.
.. code:: python
from srcomp import SRComp
comp = SRComp('/path/to/compstate')
Web clients should look at using the HTTP API provided by
srcomp-http <https://github.com/PeterJCLaw/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 <https://github.com/PeterJCLaw/srcomp-cli>
__.
See the
dummy-comp <https://github.com/PeterJCLaw/dummy-comp>
__
for an example of the structure and values expected in a compstate
repo.
Install:
pip install -e . -r dev-requirements.txt
Checks:
./script/check
.. |Build Status| image:: https://circleci.com/gh/PeterJCLaw/srcomp/tree/main.svg?style=svg :target: https://circleci.com/gh/PeterJCLaw/srcomp/tree/main
.. |Docs Status| image:: https://readthedocs.org/projects/srcomp/badge/?version=latest :target: https://srcomp.readthedocs.org/