Metadata-Version: 2.1
Name: sr.comp.http
Version: 1.3.0
Summary: UNKNOWN
Home-page: UNKNOWN
Author: Student Robotics Competition Software SIG
Author-email: srobo-devel@googlegroups.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Requires-Python: >=3.7
Requires-Dist: sr.comp (<2,>=1.2)
Requires-Dist: Flask (<2,>=1.0)
Requires-Dist: simplejson (<4,>=3.6)
Requires-Dist: python-dateutil (<3,>=2.2)
Requires-Dist: typing-extensions (<4,>=3.7.4.2)

SR Comp HTTP
============

|Build Status| |Docs Status|

A HTTP interface around `SRComp <https://github.com/PeterJCLaw/srcomp/wiki/SRComp>`__,
the fifth round of `Student Robotics <http://srobo.org>`__ competition
software.

This repository provides a JSON API to accessing information about the
state of the competition. It is a lightweight
`Flask <http://flask.pocoo.org/>`__ application wrapping the
`SRComp <https://github.com/PeterJCLaw/srcomp>`__ python
APIs to the competition state.

Usage
-----

Run with ``./run $COMPSTATE``.

Test with ``./run-tests``.

Developers may wish to use the `SRComp
Dev <https://github.com/PeterJCLaw/srcomp-dev>`__ repo
to setup a dev instance.

State Caching
~~~~~~~~~~~~~

Since loading a given state repo takes a non-trivial amount of time,
this is cached within the Flask application. Updates to the state repo
are not tracked directly, and must be signalled by running the
``./update`` script provided.

Requirements
------------

-  `SRComp <https://github.com/PeterJCLaw/srcomp>`__
-  Flask
-  python-dateutil
-  simplejson

Don't forget to also check the requirements for SRComp!

.. |Build Status| image:: https://travis-ci.org/PeterJCLaw/srcomp-http.png?branch=master
   :target: https://travis-ci.org/PeterJCLaw/srcomp-http

.. |Docs Status| image:: https://readthedocs.org/projects/srcomp-http/badge/?version=latest
   :target: https://srcomp-http.readthedocs.org/


