pyroclient 0.1.0

Client of the Pyronear API to help the fight against wildfires

API Client

Client for the Pyronear API

Table of Contents

• API Client
  • Table of Contents
  • Getting started
    • Prerequisites
    • Installation
  • Usage
  • Documentation

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:

# Send alerts:
api_client.send_alert()

# Send medias:
api_client.send_medias()

# Update your position:
api_client.update_location(lat, lon)

Documentation

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