diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-10 06:53:51 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-10 06:53:51 +0000 |
| commit | aac82850cfe50382a054793cdab8ea903b78364b (patch) | |
| tree | 7c3c73eeec03739be15b6e2112c7e042f894cbde /python-georss-qld-bushfire-alert-client.spec | |
| parent | e8e0626b67bfe92e78348bb0ee4d4405e6b9343b (diff) | |
automatic import of python-georss-qld-bushfire-alert-client
Diffstat (limited to 'python-georss-qld-bushfire-alert-client.spec')
| -rw-r--r-- | python-georss-qld-bushfire-alert-client.spec | 349 |
1 files changed, 349 insertions, 0 deletions
diff --git a/python-georss-qld-bushfire-alert-client.spec b/python-georss-qld-bushfire-alert-client.spec new file mode 100644 index 0000000..c9a4c4d --- /dev/null +++ b/python-georss-qld-bushfire-alert-client.spec @@ -0,0 +1,349 @@ +%global _empty_manifest_terminate_build 0 +Name: python-georss-qld-bushfire-alert-client +Version: 0.6 +Release: 1 +Summary: A GeoRSS client library for the Queensland Bushfire Alert feed. +License: Apache-2.0 +URL: https://github.com/exxamalte/python-georss-qld-bushfire-alert-client +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/43/ab/7b5bea71926471fdb8491b2d5c8c1c763b4aca89cf04bf67c3f2b9995c0b/georss_qld_bushfire_alert_client-0.6.tar.gz +BuildArch: noarch + +Requires: python3-georss-client + +%description +# python-georss-qld-bushfire-alert-client + +[](https://github.com/exxamalte/python-georss-qld-bushfire-alert-client/actions?workflow=CI) +[](https://codecov.io/gh/exxamalte/python-georss-qld-bushfire-alert-client) +[](https://pypi.python.org/pypi/georss-qld-bushfire-alert-client) +[](https://pypi.python.org/pypi/georss-qld-bushfire-alert-client) + +This library provides convenient access to the [Queensland Bushfire Alert Feed](https://www.ruralfire.qld.gov.au/map/Pages/default.aspx). + +## Installation +`pip install georss-qld-bushfire-alert-client` + +## Usage +See below for an example of how this library can be used. After instantiating +the feed class and supplying 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 specific feed entries. + +**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** +```python +from georss_qld_bushfire_alert_client import QldBushfireAlertFeed +# Home Coordinates: Latitude: -27.5, Longitude: 153.0 +# Filter radius: 50 km +# Filter categories: 'Advice' +feed = QldBushfireAlertFeed((-27.5, 153.0), + filter_radius=50, + filter_categories=['Advice']) +status, entries = feed.update() +``` + +## Feed entry properties +Each feed entry is populated with the following properties - subject to +availability in GeoRSS feed: + +| Name | Description | +|------------------|-----------------------------------------------------------| +| geometry | All geometry details of this entry. | +| coordinates | Best coordinates (latitude, longitude) of this entry. | +| external_id | External id of this entry. | +| title | Title of this entry with textual description of location. | +| category | Category of this entry. | +| attribution | Attribution from feed. | +| distance_to_home | Distance in km of this entry to the home coordinates. | +| description | Full content of this entry. | +| published | Published date of this entry. | +| updated | Updated date of this entry. | +| status | Status of alert, e.g. "Patrolled", "Going", "Contained" | + +## 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. + + + + +%package -n python3-georss-qld-bushfire-alert-client +Summary: A GeoRSS client library for the Queensland Bushfire Alert feed. +Provides: python-georss-qld-bushfire-alert-client +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-georss-qld-bushfire-alert-client +# python-georss-qld-bushfire-alert-client + +[](https://github.com/exxamalte/python-georss-qld-bushfire-alert-client/actions?workflow=CI) +[](https://codecov.io/gh/exxamalte/python-georss-qld-bushfire-alert-client) +[](https://pypi.python.org/pypi/georss-qld-bushfire-alert-client) +[](https://pypi.python.org/pypi/georss-qld-bushfire-alert-client) + +This library provides convenient access to the [Queensland Bushfire Alert Feed](https://www.ruralfire.qld.gov.au/map/Pages/default.aspx). + +## Installation +`pip install georss-qld-bushfire-alert-client` + +## Usage +See below for an example of how this library can be used. After instantiating +the feed class and supplying 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 specific feed entries. + +**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** +```python +from georss_qld_bushfire_alert_client import QldBushfireAlertFeed +# Home Coordinates: Latitude: -27.5, Longitude: 153.0 +# Filter radius: 50 km +# Filter categories: 'Advice' +feed = QldBushfireAlertFeed((-27.5, 153.0), + filter_radius=50, + filter_categories=['Advice']) +status, entries = feed.update() +``` + +## Feed entry properties +Each feed entry is populated with the following properties - subject to +availability in GeoRSS feed: + +| Name | Description | +|------------------|-----------------------------------------------------------| +| geometry | All geometry details of this entry. | +| coordinates | Best coordinates (latitude, longitude) of this entry. | +| external_id | External id of this entry. | +| title | Title of this entry with textual description of location. | +| category | Category of this entry. | +| attribution | Attribution from feed. | +| distance_to_home | Distance in km of this entry to the home coordinates. | +| description | Full content of this entry. | +| published | Published date of this entry. | +| updated | Updated date of this entry. | +| status | Status of alert, e.g. "Patrolled", "Going", "Contained" | + +## 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. + + + + +%package help +Summary: Development documents and examples for georss-qld-bushfire-alert-client +Provides: python3-georss-qld-bushfire-alert-client-doc +%description help +# python-georss-qld-bushfire-alert-client + +[](https://github.com/exxamalte/python-georss-qld-bushfire-alert-client/actions?workflow=CI) +[](https://codecov.io/gh/exxamalte/python-georss-qld-bushfire-alert-client) +[](https://pypi.python.org/pypi/georss-qld-bushfire-alert-client) +[](https://pypi.python.org/pypi/georss-qld-bushfire-alert-client) + +This library provides convenient access to the [Queensland Bushfire Alert Feed](https://www.ruralfire.qld.gov.au/map/Pages/default.aspx). + +## Installation +`pip install georss-qld-bushfire-alert-client` + +## Usage +See below for an example of how this library can be used. After instantiating +the feed class and supplying 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 specific feed entries. + +**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** +```python +from georss_qld_bushfire_alert_client import QldBushfireAlertFeed +# Home Coordinates: Latitude: -27.5, Longitude: 153.0 +# Filter radius: 50 km +# Filter categories: 'Advice' +feed = QldBushfireAlertFeed((-27.5, 153.0), + filter_radius=50, + filter_categories=['Advice']) +status, entries = feed.update() +``` + +## Feed entry properties +Each feed entry is populated with the following properties - subject to +availability in GeoRSS feed: + +| Name | Description | +|------------------|-----------------------------------------------------------| +| geometry | All geometry details of this entry. | +| coordinates | Best coordinates (latitude, longitude) of this entry. | +| external_id | External id of this entry. | +| title | Title of this entry with textual description of location. | +| category | Category of this entry. | +| attribution | Attribution from feed. | +| distance_to_home | Distance in km of this entry to the home coordinates. | +| description | Full content of this entry. | +| published | Published date of this entry. | +| updated | Updated date of this entry. | +| status | Status of alert, e.g. "Patrolled", "Going", "Contained" | + +## 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. + + + + +%prep +%autosetup -n georss-qld-bushfire-alert-client-0.6 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-georss-qld-bushfire-alert-client -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6-1 +- Package Spec generated |