跳转到主要内容

学生机器人竞赛软件的HTTP API

项目描述

Build Status Docs Status

这是一个围绕SRComp的HTTP接口,SRComp是学生机器人竞赛软件的第五轮。

此存储库提供了一个JSON API来访问有关竞赛状态的信息。它是一个轻量级的Flask应用,它包装了SRComp Python API到竞赛状态。

用法

安装:

pip install sr.comp.http

配置

在部署时,您应该通过将应用的config中的COMPSTATE键设置为服务器打算提供的服务器的绝对路径来配置应用。

from sr.comp.http import app
app.config['COMPSTATE'] = '/path/to/compstate'

开发

克隆:

为了测试能够正常工作,您还需要克隆tests/dummy子模块

git submodule update --init

安装:

pip install -e .

运行: ./run $COMPSTATE.

测试: ./run-tests

开发者可能希望使用SRComp Dev存储库来设置开发实例。

状态缓存

由于加载指定的状态仓库需要相当多的时间,因此在Flask应用程序中进行了缓存。状态仓库的更新不会直接跟踪,必须通过运行提供的./update脚本来进行信号通知。

项目详情


下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。

源分发

sr.comp.http-1.9.0.tar.gz (24.9 kB 查看哈希值)

上传时间

构建分发

sr.comp.http-1.9.0-py3-none-any.whl (26.8 kB 查看哈希值)

上传时间 Python 3

由以下机构支持