SRComp
======
|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.
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 <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*.
Development
-----------
**Install**:
``pip install -e . -r dev-requirements.txt``
**Test**:
``./run-tests``
.. |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/
Raw data
{
"_id": null,
"home_page": "https://github.com/PeterJCLaw/srcomp/wiki",
"name": "sr.comp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Student Robotics Competition Software SIG",
"author_email": "srobo-devel@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/8e/46/fd4179fc4fd0f6bf0798eaac104e8e0f0e156159b37da13f2002e67fd795/sr.comp-1.8.3.tar.gz",
"platform": null,
"description": "SRComp\n======\n\n|Build Status| |Docs Status|\n\nReliable software for running robotics competitions, primarily used by\n`Student Robotics <https://studentrobotics.org>`__.\n\nThe `SRComp wiki <https://github.com/PeterJCLaw/srcomp/wiki>`__ provides\nan overview of the suite as a whole.\n\nThis repository provides a python API to accessing information about the\nstate of the competition. That *compstate* is stored as a collection of\nYAML files in a git repository. This allows the state of the competition\nto be managed in isolation from the software while still providing\nconsistent representations of that state.\n\nUsage\n-----\n\nPython clients should install the library using:\n\n.. code:: shell\n\n pip install sr.comp\n\nOnly the ``SRComp`` is class directly exposed, and it should be constructed\naround the path to a local working copy of a *compstate repo*.\n\n.. code:: python\n\n from srcomp import SRComp\n comp = SRComp('/path/to/compstate')\n\n**Web clients** should look at using the HTTP API provided by\n`srcomp-http <https://github.com/PeterJCLaw/srcomp-http>`__\nrather than implementing their own intermediary.\n\nThere is also a **command line** interface which provides utilities for\nmanaging a *compstate repo*:\n`srcomp-cli <https://github.com/PeterJCLaw/srcomp-cli>`__.\n\nSee the\n`dummy-comp <https://github.com/PeterJCLaw/dummy-comp>`__\nfor an example of the structure and values expected in a *compstate\nrepo*.\n\nDevelopment\n-----------\n\n**Install**:\n``pip install -e . -r dev-requirements.txt``\n\n**Test**:\n``./run-tests``\n\n.. |Build Status| image:: https://circleci.com/gh/PeterJCLaw/srcomp/tree/main.svg?style=svg\n :target: https://circleci.com/gh/PeterJCLaw/srcomp/tree/main\n\n.. |Docs Status| image:: https://readthedocs.org/projects/srcomp/badge/?version=latest\n :target: https://srcomp.readthedocs.org/\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Reliable software for running robotics competitions",
"version": "1.8.3",
"project_urls": {
"Code": "https://github.com/PeterJCLaw/srcomp",
"Documentation": "https://srcomp.readthedocs.org/",
"Homepage": "https://github.com/PeterJCLaw/srcomp/wiki",
"Issue tracker": "https://github.com/PeterJCLaw/srcomp/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d284ae3e295e4a14b1a5ede7435cffff2dc683de6ccaca5ede655e2814382d30",
"md5": "419824ae3cad946d49b6fd69ae968903",
"sha256": "76c6e26c9fd810b30bbc448d225d3f8193a9bed929f5a79b34e2db26f97a585d"
},
"downloads": -1,
"filename": "sr.comp-1.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "419824ae3cad946d49b6fd69ae968903",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 53480,
"upload_time": "2023-09-02T18:40:42",
"upload_time_iso_8601": "2023-09-02T18:40:42.240632Z",
"url": "https://files.pythonhosted.org/packages/d2/84/ae3e295e4a14b1a5ede7435cffff2dc683de6ccaca5ede655e2814382d30/sr.comp-1.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e46fd4179fc4fd0f6bf0798eaac104e8e0f0e156159b37da13f2002e67fd795",
"md5": "cbfc44e29e73c479be31a6d646006ab3",
"sha256": "644d115f6f1c58cb4e23846e176fcf929835ce6a653485e976bf24e93e7afe4f"
},
"downloads": -1,
"filename": "sr.comp-1.8.3.tar.gz",
"has_sig": false,
"md5_digest": "cbfc44e29e73c479be31a6d646006ab3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 33000,
"upload_time": "2023-09-02T18:40:43",
"upload_time_iso_8601": "2023-09-02T18:40:43.789136Z",
"url": "https://files.pythonhosted.org/packages/8e/46/fd4179fc4fd0f6bf0798eaac104e8e0f0e156159b37da13f2002e67fd795/sr.comp-1.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-02 18:40:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PeterJCLaw",
"github_project": "srcomp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "sr.comp"
}
JSON
