Library for convenient access to the Queensland Bushfire Alert GeoRSS feed.
This library provides convenient access to the Queensland Bushfire Alert Feed.
pip install georss-qld-bushfire-alert-client
See below for an example of how this library can be used. After instantiating
the feed class and supplying the required parameters, you can call update
to
retrieve the feed data. The return value will be a tuple of a status code and
the actual data in the form of a list of specific feed entries.
Status Codes
Supported Filters
Filter | Description | |
---|---|---|
Radius | filter_radius |
Radius in kilometers around the home coordinates in which events from the feed are included. |
Categories | filter_categories |
Array of category names. Only events with a category matching any of these are included. |
Example
from georss_qld_bushfire_alert_client import QldBushfireAlertFeed
# Home Coordinates: Latitude: -27.5, Longitude: 153.0
# Filter radius: 50 km
# Filter categories: 'Advice'
feed = QldBushfireAlertFeed((-27.5, 153.0),
filter_radius=50,
filter_categories=['Advice'])
status, entries = feed.update()
Each feed entry is populated with the following properties - subject to
availability in GeoRSS feed:
Name | Description |
---|---|
geometry | All geometry details of this entry. |
coordinates | Best coordinates (latitude, longitude) of this entry. |
external_id | External id of this entry. |
title | Title of this entry with textual description of location. |
category | Category of this entry. |
attribution | Attribution from feed. |
distance_to_home | Distance in km of this entry to the home coordinates. |
description | Full content of this entry. |
published | Published date of this entry. |
updated | Updated date of this entry. |
status | Status of alert, e.g. “Patrolled”, “Going”, “Contained” |
The Feed Manager helps managing feed updates over time, by notifying the
consumer of the feed about new feed entries, updates and removed entries
compared to the last feed update.
After a successful update from the feed, the feed manager will provide two
different dates:
last_update
will be the timestamp of the last successful update from thelast_timestamp
will be the latest timestamp extracted from the feed data.