Skip to main content

Student Robotics Competition Software

Project description

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 install the library using:

pip install git+https://github.com/PeterJCLaw/srcomp

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 .

Test: ./run-tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sr.comp-1.4.0.tar.gz (34.2 kB view details)

Uploaded Source

Built Distribution

sr.comp-1.4.0-py2.py3-none-any.whl (59.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sr.comp-1.4.0.tar.gz.

File metadata

  • Download URL: sr.comp-1.4.0.tar.gz
  • Upload date:
  • Size: 34.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for sr.comp-1.4.0.tar.gz
Algorithm Hash digest
SHA256 6b5904575cd437613f65b63bdacfcc4eba6d1bc4d1d66603110adf013a84d61a
MD5 19b53d8feb265274db8c3b94169e345c
BLAKE2b-256 674b0c56d25f47385c0bb8e990ad3cb4e88ee88a43ef4578b678262c0a8752c4

See more details on using hashes here.

Provenance

File details

Details for the file sr.comp-1.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: sr.comp-1.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 59.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for sr.comp-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e8fcdce1daa731bbb33da4fe4f2bf4b4bc0364af333b68a39225c94de5e88d39
MD5 494c7a01f7e791a681fdfd2a89a9bd9d
BLAKE2b-256 0900a6e9eade86090b56febf26f72577556adb856e59dc254524fdaa1f2794e4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page