Skip to main content

An async GeoJSON client library for NSW Rural Fire Service Incidents.

Project description

python-aio-geojson-nsw-rfs-incidents

Build Status codecov PyPi Version

This library provides convenient async access to the NSW Rural Fire Service incidents feed.

Installation

pip install aio-geojson-nsw-rfs-incidents

Usage

See below for examples of how this library can be used. After instantiating a particular class - feed or feed manager - and supply 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 feed entries specific to the selected feed.

Status Codes

  • OK: Update went fine and data was retrieved. The library may still return empty data, for example because no entries fulfilled the filter criteria.
  • 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.
  • ERROR: Something went wrong during the update

Parameters

Parameter Description
home_coordinates Coordinates (tuple of latitude/longitude)

Supported Filters

Filter Description
Radius filter_radius Radius in kilometers around the home coordinates in which events from feed are included.
Categories filter_categories Array of category names. Only events with a category matching any of these is included.

Example

import asyncio
from aiohttp import ClientSession
from aio_geojson_nsw_rfs_incidents import NswRuralFireServiceIncidentsFeed
async def main() -> None:
    async with ClientSession() as websession:    
        # Home Coordinates: Latitude: -33.0, Longitude: 150.0
        # Filter radius: 50 km
        # Filter categories: 'Advice'
        feed = NswRuralFireServiceIncidentsFeed(websession, 
                                                (-33.0, 150.0), 
                                                filter_radius=50, 
                                                filter_categories=['Advice'])
        status, entries = await feed.update()
        print(status)
        print(entries)
asyncio.get_event_loop().run_until_complete(main())

Feed entry properties

Each feed entry is populated with the following properties:

Name Description Feed attribute
geometry All geometry details of this entry. geometry
coordinates Best coordinates (latitude, longitude) of this entry. geometry
external_id The unique public identifier for this incident. guid
title Title of this entry. title
attribution Attribution of the feed. n/a
distance_to_home Distance in km of this entry to the home coordinates. n/a
category The alert level of the incident ('Emergency Warning', 'Watch and Act', 'Advice','Not Applicable'). category
publication_date The publication date of the incidents. pubDate
description The description of the incident. description
location Location description of the incident. description -> LOCATION
council_area Council are this incident falls into. description -> COUNCIL AREA
status Status of the incident. description -> STATUS
type Type of the incident (e.g. Bush Fire, Grass Fire, Hazard Reduction). description -> TYPE
fire Indicated if this incident is a fire or not (True/False). description -> FIRE
size Size in ha. description -> SIZE
responsible_agency Agency responsible for this incident. description -> RESPONSIBLE AGENCY

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 provides two different dates:

  • last_update will be the timestamp of the last update from the feed irrespective of whether it was successful or not.
  • last_update_successful 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 (optional, depends on the feed data) 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

aio_geojson_nsw_rfs_incidents-2026.6.0.tar.gz (12.8 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 aio_geojson_nsw_rfs_incidents-2026.6.0.tar.gz.

File metadata

File hashes

Hashes for aio_geojson_nsw_rfs_incidents-2026.6.0.tar.gz
Algorithm Hash digest
SHA256 f44ba8e2f548e8df29a5ffd9c1690fcc294736392bc27156ed03fdf2cadf5b25
MD5 957aa85155ec188a936cf9894e1154b1
BLAKE2b-256 267c94ed3d9191f5d266d06d4b037706c316305edef6f43c73e00a7f4fc7a6b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aio_geojson_nsw_rfs_incidents-2026.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c1807b722b19dfec55bd71187dfcfd4b43a8a178631e7ea8e476b7a2815d3534
MD5 5ae53b052054a643c36c9d379c84c44d
BLAKE2b-256 13a3f32c1284ecf97694139c68e42b304baa686bfdf6aa1647ac1a4a51df833f

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