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.compOnly 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
1 maintainer
Release files for sr.comp 1.15.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sr_comp-1.15.0.tar.gz | 84.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sr_comp-1.15.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 151.0 kB
Release files / sr_comp-1.15.0.tar.gz
| Download URL | sr_comp-1.15.0.tar.gz |
|---|---|
| Size | 84.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
275f924a0e38497f10be7aeb5cf69f792b368ed08d77107182dc5350b10b736d
|
|
BLAKE2b-256 checksum How to use checksums |
60b5833bf027fdc446069c4033f14e50f5e6307d55c1a37ca58846b15339e947
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / sr_comp-1.15.0-py3-none-any.whl
| Download URL | sr_comp-1.15.0-py3-none-any.whl |
|---|---|
| Size | 66.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
37c765edae575d3ca5f7c0d14179cf0008941550d8763247f1a433f4c1665445
|
|
BLAKE2b-256 checksum How to use checksums |
ce1f3ac971d378d6c338e3cd6310eefca6d4be7404f8751dacdf7baf1f9f548e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
