Skip to main content

An async GeoRSS client library.

Project description

python-aio-georss-client

Build Status codecov PyPi Version Maintainability

This library provides convenient async access to GeoRSS Feeds.

Installation

pip install aio-georss-client

Known Implementations

Library Source Topic
aio_georss_gdacs Global Disaster Alert and Coordination System (GDACS) Natural Disasters

Usage

Each implementation extracts relevant information from the GeoJSON 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

  • 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

Geometry Features

This library supports 3 different types of geometries:

  • Point
  • Polygon
  • Bounding Box

By default each feed entry is using all available geometries from the external feed. If required however, you can exclude geometries by overriding FeedEntry#features and only return the geometries you want to support in your specific implementation.

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

Uploaded Source

Built Distribution

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

aio_georss_client-2026.6.0-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aio_georss_client-2026.6.0.tar.gz
Algorithm Hash digest
SHA256 5eaf1ce99a4e157238b80c7ade7ff889b54d3e8a4cdfe39384a3676324d80aaa
MD5 94bc21b4615cf97fdadcd9c9a5418817
BLAKE2b-256 2627b042a95b1a1058067332bf550813729034cd4dd89540e282fe9a5e8ce408

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aio_georss_client-2026.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00469b1f4c615f0303cf612302366c9feff61fdb79e0decd4f6d4edcedafa18f
MD5 e6cb5ea13531ff0ac85102b5e5fbca78
BLAKE2b-256 363688ddb91ec4c32914fff5762c0e88b55215f6b4cf2bc07a33a1c1b9f9db9e

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