Skip to main content

An async GeoRSS client library.

Project description

python-aio-georss-client

Build Status Coverage Status PyPi Version Maintainability

This library provides convenient async access to to GeoRSS Feeds.

Installation

pip install aio-georss-client

Known Implementations

Library Source Topic

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

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-0.2.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

aio_georss_client-0.2-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aio_georss_client-0.2.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5

File hashes

Hashes for aio_georss_client-0.2.tar.gz
Algorithm Hash digest
SHA256 a17222ce19b0ebe38598b086421dc19d9c4a93d94a1935ff70fa766cc2f9f7b1
MD5 182787227e095b9ea29f4a83a7ed29bf
BLAKE2b-256 2fc48ad662e6ac01e38089e1a41d8cf4da1546a0779674548721277c0b3febd8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aio_georss_client-0.2-py3-none-any.whl
  • Upload date:
  • Size: 21.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5

File hashes

Hashes for aio_georss_client-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 28c4be5c2fa245e5ff6f50922ec822e399680c5b64241bedcf6810c841b80a2d
MD5 ab5a94e7c25b2bd225402b77e8e58510
BLAKE2b-256 3a11211a7e36a470763e0f88b81ed0fd0fcadd2229700f73a481b963793e8b39

See more details on using hashes here.

Supported by

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