API Client

Client for the Pyronear API

Getting started

Prerequisites

• Python 3.6 (or more recent)
• pip

Installation

You can clone and install the project dependencies as follows:

$git clone https://github.com/pyronear/pyro-api.git
$pip install -e pyro-api/client/.

Usage

Import the client

from pyroclient import client

Create a client object by handling him the API keys

API_URL = "http://pyronear-api.herokuapp.com"
CREDENTIALS_LOGIN = "George Abitbol"
CREDENTIALS_PASSWORD = "AStrong Password"
api_client = client.Client(API_URL, CREDENTIALS_LOGIN, CREDENTIALS_PASSWORD)

Use it to query alerts:

#AS A DEVICE:
## Create a device
event_id = api_client.create_event(lat=10, lon=10).json()["id"]
## Create a media
media_id = api_client.create_media_from_device().json()["id"]
## Create an alert linked to the media and the event
api_client.send_alert_from_device(lat=10, lon=10, event_id=event_id, media_id=media_id)

## Upload an image on the media
dummy_image = "https://ec.europa.eu/jrc/sites/jrcsh/files/styles/normal-responsive/" \
                + "public/growing-risk-future-wildfires_adobestock_199370851.jpeg"
image_data = requests.get(dummy_image)
api_client.upload_media(media_id=media_id, image_data=image_data.content)

## Update your position:
api_client.update_my_location(lat=1, lon=2, pitch=3)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Documentation

The full project documentation is available here for detailed specifications. The documentation was built with Sphinx using a theme provided by Pradyun Gedam.