Skip to main content

A GeoRSS generic client library.

Project description

python-georss-generic-client

Build Status codecov PyPi Version

This library provides convenient generic access to GeoRSS feeds.

Installation

pip install georss-generic-client

Usage

See below for examples of how this library can be used for particular GeoRSS feeds. After instantiating a particular class 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

  • 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_generic_client import GenericFeed
# Home Coordinates: Latitude: -27.5, Longitude: 153.0
# Filter radius: 200 km
feed = GenericFeed((-27.5, 153.0), filter_radius=200,
                   url="https://www.qfes.qld.gov.au/data/alerts/bushfireAlert.xml")
status, entries = feed.update()

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_generic_client-2026.6.0.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

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

georss_generic_client-2026.6.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: georss_generic_client-2026.6.0.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for georss_generic_client-2026.6.0.tar.gz
Algorithm Hash digest
SHA256 b08cdaf29a2a6a91bb883103213c33b43d90caad8b79289b9af9e0cc283ad3b4
MD5 32e76a6983b7d1a50401fd3fd20f3141
BLAKE2b-256 e16495c569dff35a32f1a816589026281a30ebc0cf176bbcbb9c829ed36105c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for georss_generic_client-2026.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9640589308901e6bc1bf035e4c772e1848bd6cb371ed112d41961008041e787c
MD5 a782e24d00a4a9592e5ab5f3767036de
BLAKE2b-256 4b72f18204112c2076857521985bcc3a2c4544c226f21237b36f90447a9919b3

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