Open Path View Status API

An HTTP rest API which allow opv-status to work. This API manage Spark and OPV-importData

Requirements

This API is made to work with OPV-Ansible which create, configure and install a dev env for OPV

This API work with python3 http.server. You should install dependencies with pip :

pip install -r requirements.txt

How to use ?

You must first install the API with

python3 setup.py develop

#And you can now use launch the api
opv-status-api

#Use --debug to get more INFO
opv-status-api --debug

#You can change API port using --port
opv-status-api --port=5002

#You are lost ?
opv-status-api --help

Endpoint

api
├── import
│   ├── launch          POST --> {"path": str, "id_malette": int, "camera_number": int, "description": str, "campaign_name": str, "id_rederbro": str}
│   ├── log             POST --> {"logFile": str}
│   └── status          GET
└── spark
    ├── launch          POST --> {"campaignName": str, "customLaunchScript": str}
    └── port            GET

License

Copyright (C) 2017 Open Path View, Maison Du Libre
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program. If not, see http://www.gnu.org/licenses/.