https://github.com/peterjclaw/srcomp
Reliable software for running robotics competitions
https://github.com/peterjclaw/srcomp
srcomp
Last synced: about 1 year ago
JSON representation
Reliable software for running robotics competitions
- Host: GitHub
- URL: https://github.com/peterjclaw/srcomp
- Owner: PeterJCLaw
- License: gpl-3.0
- Created: 2014-03-14T19:55:49.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T11:32:42.000Z (about 1 year ago)
- Last Synced: 2025-04-10T12:05:54.502Z (about 1 year ago)
- Topics: srcomp
- Language: Python
- Homepage: https://github.com/PeterJCLaw/srcomp/wiki
- Size: 693 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
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:
.. 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 `__
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``
.. |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/