Skip to main content

A GeoRSS client library for the Queensland Bushfire Alert feed.

Project description

python-georss-qld-bushfire-alert-client

Build Status codecov PyPi Version

This library provides convenient access to the Queensland Bushfire Alert Feed.

Installation

pip install georss-qld-bushfire-alert-client

Usage

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

  • UPDATE_OK: Update went fine and data was retrieved. The library may still return empty data, for example because no entries fulfilled the filter criteria.
  • UPDATE_OK_NO_DATA: Update went fine but no data was retrieved, for example because the server indicated that there was not update since the last request.
  • UPDATE_ERROR: Something went wrong during the update

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()

Feed entry properties

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"

Feed Manager

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.

  • If the current feed update is the first one, then all feed entries will be reported as new. The feed manager will keep track of all feed entries' external IDs that it has successfully processed.
  • If the current feed update is not the first one, then the feed manager will produce three sets:
    • Feed entries that were not in the previous feed update but are in the current feed update will be reported as new.
    • Feed entries that were in the previous feed update and are still in the current feed update will be reported as to be updated.
    • Feed entries that were in the previous feed update but are not in the current feed update will be reported to be removed.
  • If the current update fails, then all feed entries processed in the previous feed update will be reported to be removed.

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 the feed. This date may be useful if the consumer of this library wants to treat intermittent errors from feed updates differently.
  • last_timestamp will be the latest timestamp extracted from the feed data. This requires that the underlying feed data actually contains a suitable date. This date may be useful if the consumer of this library wants to process feed entries differently if they haven't actually been updated.

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

georss_qld_bushfire_alert_client-2026.6.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file georss_qld_bushfire_alert_client-2026.6.0.tar.gz.

File metadata

File hashes

Hashes for georss_qld_bushfire_alert_client-2026.6.0.tar.gz
Algorithm Hash digest
SHA256 f887341ecbd5ebc38762ca6bf4949d6ed7013081cf66be2c628863725faddcf7
MD5 de966a7ad4ae4426ebb95d75f252a3bb
BLAKE2b-256 8357c5027100a1d34695878331b68628e4202bcc8af04c5cbd6d5525bc740d23

See more details on using hashes here.

File details

Details for the file georss_qld_bushfire_alert_client-2026.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for georss_qld_bushfire_alert_client-2026.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f7f6679d9e4c4afd01712c3a53add336aa053ba68049ee5b6681d3be8de80fd
MD5 3ba3e785660a0f6afa3a464c8d4dfb69
BLAKE2b-256 a86c79adb15fdf0c5c5c0a39cca5b6b44cee5d406d2af46bb5d79cd9902e0cba

See more details on using hashes here.

Supported by

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