Skip to main content

Python Client for Pyronear wildfire alert API

Project description

API Client

CI Status Documentation Status black

PyPi Status pyversions license

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyroclient-0.1.2.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

pyroclient-0.1.2-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file pyroclient-0.1.2.tar.gz.

File metadata

  • Download URL: pyroclient-0.1.2.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for pyroclient-0.1.2.tar.gz
Algorithm Hash digest
SHA256 018843c50463c0fddce711c688729810e86ba7f74c04051bd3e43b641a75e450
MD5 0235692273f6d1368518ab7d783faa9f
BLAKE2b-256 d74191b5aafae718880822639f90285d73765d81ac6d6dcdc18da17ce3ca935b

See more details on using hashes here.

File details

Details for the file pyroclient-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pyroclient-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for pyroclient-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d616f2e2ace2334afa1af2a77325595667172dc48e26cd41eb16c00b7651c60f
MD5 e1511601954982318da3c6af6a32721c
BLAKE2b-256 5409f66dfdae4c9020f9cf0253c155e901f463d581f7d324c1a4c7733f656916

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page