A GeoRSS client library.
Project description
python-georss-client
This library provides convenient access to GeoRSS Feeds.
Installation
pip install georss-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 GeoRSS Feeds
Generic Feed
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
from georss_client.generic_feed import GenericFeed
# Home Coordinates: Latitude: -27.5, Longitude: 153.0
# Filter radius: 1000 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()
Queensland Fire and Emergency Services (QFES) Bushfire Alert Feed
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
from georss_client.qfes_bushfire_alert_feed import QfesBushfireAlertFeed
# Home Coordinates: Latitude: -27.5, Longitude: 153.0
# Filter radius: 50 km
# Filter categories: 'Advice'
feed = QfesBushfireAlertFeed((-27.5, 153.0), filter_radius=50,
filter_categories=['Advice'])
status, entries = feed.update()
Tasmania Fire Service Incidents Feed
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
from georss_client.tasmania_fire_service_incidents_feed import TfsIncidentsFeed
# Home Coordinates: Latitude: -41.5, Longitude: 148.0
# Filter radius: 50 km
feed = TfsIncidentsFeed((-41.5, 148.0), filter_radius=50)
status, entries = feed.update()
Western Australia Department of Fire and Emergency Services Feed
Supported Feeds
Category | Feed |
---|---|
Warnings | warnings |
Incidents | all_incidents |
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
from georss_client.wa_dfes_feed import WaDfesFeed
# Home Coordinates: Latitude: -31.0, Longitude: 121.0
# Feed: Warnings
# Filter radius: 50 km
feed = WaDfesFeed((-31.0, 121.0), 'warnings', filter_radius=50)
status, entries = feed.update()
Natural Resources Canada Earthquakes Feed
Supported Languages
Language | Feed |
---|---|
English | en |
Français | fr |
Supported Filters
Filter | Description | |
---|---|---|
Radius | filter_radius |
Radius in kilometers around the home coordinates in which events from feed are included. |
Minimum Magnitude | filter_minimum_magnitude |
Minimum magnitude as float value. Only events with a magnitude equal or above this value are included. |
Example
from georss_client.natural_resources_canada_earthquakes_feed import \
NaturalResourcesCanadaEarthquakesFeed
# Home Coordinates: Latitude: 49.25, Longitude: -123.1
# Language: English
# Filter radius: 200 km
# Filter minimum magnitude: 4.0
feed = NaturalResourcesCanadaEarthquakesFeed((49.25, -123.1), 'en',
filter_radius=200,
filter_minimum_magnitude=4.0)
status, entries = feed.update()
INGV Centro Nazionale Terremoti (Earthquakes) Feed
Supported Filters
Filter | Description | |
---|---|---|
Radius | filter_radius |
Radius in kilometers around the home coordinates in which events from feed are included. |
Minimum Magnitude | filter_minimum_magnitude |
Minimum magnitude as float value. Only events with a magnitude equal or above this value are included. |
Example
from georss_client.ingv_centro_nazionale_terremoti_feed import \
IngvCentroNazionaleTerremotiFeed
# Home Coordinates: Latitude: 40.84, Longitude: 14.25
# Filter radius: 200 km
# Filter minimum magnitude: 4.0
feed = IngvCentroNazionaleTerremotiFeed((40.84, 14.25), filter_radius=200,
filter_minimum_magnitude=4.0)
status, entries = feed.update()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for georss_client-0.5a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d08dbd1d2032c54ba31a97dbf9198bd5bab7c2a74576d01060d7377aa728629 |
|
MD5 | 7f59d5ecde1d3c9f1b91c469e2fde2e5 |
|
BLAKE2b-256 | 4f35a1dbc362cf9e8587ba94142e007d45ae89750f91bf8602fbccdda0bba56f |