Skip to main content

A GeoRSS client library.

Project description

python-georss-client

Build Status codecov PyPi Version Maintainability

This library is a framework to build concrete libraries for convenient access to GeoRSS Feeds.

Installation

pip install georss-client

Known Implementations

Library Source Topic
python-georss-generic-client Generic GeoRSS Feeds misc
python-georss-ign-sismologia-client Instituto Geográfico Nacional Sismología Earthquakes
python-georss-ingv-centro-nazionale-terremoti-client INGV Centro Nazionale Terremoti Earthquakes
python-georss-nrcan-earthquakes-client Natural Resources Canada Earthquakes
python-georss-qld-bushfire-alert-client Queensland Bushfire Alert Fires
python-georss-wa-dfes-client Western Australia Department of Fire and Emergency Services Fires

Usage

Each implementation extracts relevant information from the GeoRSS feed. Not all feeds contain the same level of information, or present their information in different ways.

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

Feed Managers

The Feed Managers help 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_client-2026.6.1.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

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

georss_client-2026.6.1-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

Details for the file georss_client-2026.6.1.tar.gz.

File metadata

  • Download URL: georss_client-2026.6.1.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for georss_client-2026.6.1.tar.gz
Algorithm Hash digest
SHA256 92d9d0ea80ea513ebbc4e7b9de80ca205f98449c9ffa8a2c0683b517666a0ab1
MD5 1bfe4ecbf797c47243e06e61b48f6c8e
BLAKE2b-256 f2b2b3d44b3163b9f8fdb03db9b80391064f3504a4bcacef31da49349785c887

See more details on using hashes here.

File details

Details for the file georss_client-2026.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for georss_client-2026.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 880cadb6fdf44855e7449f4daeb55b79e9ae6b4f958e783e6269d20d237ceabb
MD5 7c106622c674a512a0aa540d9ea39465
BLAKE2b-256 e9b35390147ab1a765816cc41e5ff4f46294d783a4bdaac2a57564124fbb0dc5

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