diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-pyfireservicerota.spec | 558 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 560 insertions, 0 deletions
@@ -0,0 +1 @@ +/pyfireservicerota-0.0.43.tar.gz diff --git a/python-pyfireservicerota.spec b/python-pyfireservicerota.spec new file mode 100644 index 0000000..3bed58d --- /dev/null +++ b/python-pyfireservicerota.spec @@ -0,0 +1,558 @@ +%global _empty_manifest_terminate_build 0 +Name: python-pyfireservicerota +Version: 0.0.43 +Release: 1 +Summary: Python 3 API wrapper for FireServiceRota/BrandweerRooster +License: MIT license +URL: https://github.com/cyberjunky/python-fireservicerota +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/19/89/db586f5099ba116b2f40bd0bff4a48a94cd39493e222573a7af2741c28e8/pyfireservicerota-0.0.43.tar.gz +BuildArch: noarch + + +%description +# Python: FireServiceRota / BrandweerRooster + +Basic Python 3 API wrapper for FireServiceRota and BrandweerRooster for use with Home Assistant + +## About + +This package allows you to get notified about emergency incidents from https://www.FireServiceRota.co.uk and https://www.BrandweerRooster.nl. +Those are services used by firefighters. + +It currently provides the following limited functionality: + +- Connect to the websocket to get incident details in near-realtime +- Get user availability (duty) +- Set user incident response status + +See https://fireservicerota.co.uk and https://brandweerrooster.nl for more details. + +NOTE: You need a subscription and login account to be able to use it. + +## Installation + +```bash +pip3 install pyfireservicerota +``` + +## Usage + +### Initialise module using user credentials to get token_info +```python +#!/usr/bin/env python3 + +from pyfireservicerota import FireServiceRota, FireServiceRotaIncidents, ExpiredTokenError, InvalidTokenError, InvalidAuthError +import logging +import sys +import json +import time +import threading + +_LOGGER = logging.getLogger(__name__) +logging.basicConfig(level=logging.DEBUG) + +token_info = {} + +api = FireServiceRota( + base_url="www.brandweerrooster.nl", + username="your@email.address", + password="yourpassword", +) + +try: + token_info = api.request_tokens() +except InvalidAuthError: + token_info = None + +if not token_info: + _LOGGER.error("Failed to get access tokens") +``` + +NOTE: You don't need to store user credentials, at first authentication just the token_info dictionary is enough use api.refresh_tokens to refresh it. + +### Initialise module with stored token_info +```python +#!/usr/bin/env python3 + +from pyfireservicerota import FireServiceRota, FireServiceRotaIncidents, ExpiredTokenError, InvalidTokenError, InvalidAuthError +import logging +import sys +import json +import time + + +_LOGGER = logging.getLogger(__name__) +logging.basicConfig(level=logging.DEBUG) + +token_info = {} + +api = FireServiceRota( + base_url = "www.brandweerrooster.nl", + token_info = token_info + ) + +# Get user availability (duty) +try: + print(api.get_availability('Europe/Amsterdam')) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + +# Get incident response status for incident with id 123456 + +incident_id = 123456 + +try: + print(api.get_incident_response(incident_id)) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + + +# Set incident response to acknowlegded (False = 'rejected') +try: + api.set_incident_response(id, True) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + + +# Connect to websocket channel for incidents +wsurl = f"wss://www.brandweerrooster.nl/cable?access_token={token_info['access_token']}" + +class FireService(): + + def __init__(self, url): + + self._data = None + self.listener = None + self.url = url + self.incidents_listener() + + def on_incident(self, data): + _LOGGER.debug("INCIDENT: %s", data) + self._data = data + + def incidents_listener(self): + """Spawn a new Listener and links it to self.on_incident.""" + + self.listener = FireServiceRotaIncidents(on_incident=self.on_incident) + _LOGGER.debug("Starting incidents listener") + self.listener.start(url=self.url) + + +ws = FireService(wsurl) + +while True: + time.sleep(1) +``` + +%package -n python3-pyfireservicerota +Summary: Python 3 API wrapper for FireServiceRota/BrandweerRooster +Provides: python-pyfireservicerota +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-pyfireservicerota +# Python: FireServiceRota / BrandweerRooster + +Basic Python 3 API wrapper for FireServiceRota and BrandweerRooster for use with Home Assistant + +## About + +This package allows you to get notified about emergency incidents from https://www.FireServiceRota.co.uk and https://www.BrandweerRooster.nl. +Those are services used by firefighters. + +It currently provides the following limited functionality: + +- Connect to the websocket to get incident details in near-realtime +- Get user availability (duty) +- Set user incident response status + +See https://fireservicerota.co.uk and https://brandweerrooster.nl for more details. + +NOTE: You need a subscription and login account to be able to use it. + +## Installation + +```bash +pip3 install pyfireservicerota +``` + +## Usage + +### Initialise module using user credentials to get token_info +```python +#!/usr/bin/env python3 + +from pyfireservicerota import FireServiceRota, FireServiceRotaIncidents, ExpiredTokenError, InvalidTokenError, InvalidAuthError +import logging +import sys +import json +import time +import threading + +_LOGGER = logging.getLogger(__name__) +logging.basicConfig(level=logging.DEBUG) + +token_info = {} + +api = FireServiceRota( + base_url="www.brandweerrooster.nl", + username="your@email.address", + password="yourpassword", +) + +try: + token_info = api.request_tokens() +except InvalidAuthError: + token_info = None + +if not token_info: + _LOGGER.error("Failed to get access tokens") +``` + +NOTE: You don't need to store user credentials, at first authentication just the token_info dictionary is enough use api.refresh_tokens to refresh it. + +### Initialise module with stored token_info +```python +#!/usr/bin/env python3 + +from pyfireservicerota import FireServiceRota, FireServiceRotaIncidents, ExpiredTokenError, InvalidTokenError, InvalidAuthError +import logging +import sys +import json +import time + + +_LOGGER = logging.getLogger(__name__) +logging.basicConfig(level=logging.DEBUG) + +token_info = {} + +api = FireServiceRota( + base_url = "www.brandweerrooster.nl", + token_info = token_info + ) + +# Get user availability (duty) +try: + print(api.get_availability('Europe/Amsterdam')) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + +# Get incident response status for incident with id 123456 + +incident_id = 123456 + +try: + print(api.get_incident_response(incident_id)) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + + +# Set incident response to acknowlegded (False = 'rejected') +try: + api.set_incident_response(id, True) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + + +# Connect to websocket channel for incidents +wsurl = f"wss://www.brandweerrooster.nl/cable?access_token={token_info['access_token']}" + +class FireService(): + + def __init__(self, url): + + self._data = None + self.listener = None + self.url = url + self.incidents_listener() + + def on_incident(self, data): + _LOGGER.debug("INCIDENT: %s", data) + self._data = data + + def incidents_listener(self): + """Spawn a new Listener and links it to self.on_incident.""" + + self.listener = FireServiceRotaIncidents(on_incident=self.on_incident) + _LOGGER.debug("Starting incidents listener") + self.listener.start(url=self.url) + + +ws = FireService(wsurl) + +while True: + time.sleep(1) +``` + +%package help +Summary: Development documents and examples for pyfireservicerota +Provides: python3-pyfireservicerota-doc +%description help +# Python: FireServiceRota / BrandweerRooster + +Basic Python 3 API wrapper for FireServiceRota and BrandweerRooster for use with Home Assistant + +## About + +This package allows you to get notified about emergency incidents from https://www.FireServiceRota.co.uk and https://www.BrandweerRooster.nl. +Those are services used by firefighters. + +It currently provides the following limited functionality: + +- Connect to the websocket to get incident details in near-realtime +- Get user availability (duty) +- Set user incident response status + +See https://fireservicerota.co.uk and https://brandweerrooster.nl for more details. + +NOTE: You need a subscription and login account to be able to use it. + +## Installation + +```bash +pip3 install pyfireservicerota +``` + +## Usage + +### Initialise module using user credentials to get token_info +```python +#!/usr/bin/env python3 + +from pyfireservicerota import FireServiceRota, FireServiceRotaIncidents, ExpiredTokenError, InvalidTokenError, InvalidAuthError +import logging +import sys +import json +import time +import threading + +_LOGGER = logging.getLogger(__name__) +logging.basicConfig(level=logging.DEBUG) + +token_info = {} + +api = FireServiceRota( + base_url="www.brandweerrooster.nl", + username="your@email.address", + password="yourpassword", +) + +try: + token_info = api.request_tokens() +except InvalidAuthError: + token_info = None + +if not token_info: + _LOGGER.error("Failed to get access tokens") +``` + +NOTE: You don't need to store user credentials, at first authentication just the token_info dictionary is enough use api.refresh_tokens to refresh it. + +### Initialise module with stored token_info +```python +#!/usr/bin/env python3 + +from pyfireservicerota import FireServiceRota, FireServiceRotaIncidents, ExpiredTokenError, InvalidTokenError, InvalidAuthError +import logging +import sys +import json +import time + + +_LOGGER = logging.getLogger(__name__) +logging.basicConfig(level=logging.DEBUG) + +token_info = {} + +api = FireServiceRota( + base_url = "www.brandweerrooster.nl", + token_info = token_info + ) + +# Get user availability (duty) +try: + print(api.get_availability('Europe/Amsterdam')) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + +# Get incident response status for incident with id 123456 + +incident_id = 123456 + +try: + print(api.get_incident_response(incident_id)) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + + +# Set incident response to acknowlegded (False = 'rejected') +try: + api.set_incident_response(id, True) +except ExpiredTokenError: + _LOGGER.debug("Tokens are expired, refreshing") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") +except InvalidTokenError: + _LOGGER.debug("Tokens are invalid") + try: + token_info = api.refresh_tokens() + except InvalidAuthError: + _LOGGER.debug("Invalid refresh token, you need to re-login") + + +# Connect to websocket channel for incidents +wsurl = f"wss://www.brandweerrooster.nl/cable?access_token={token_info['access_token']}" + +class FireService(): + + def __init__(self, url): + + self._data = None + self.listener = None + self.url = url + self.incidents_listener() + + def on_incident(self, data): + _LOGGER.debug("INCIDENT: %s", data) + self._data = data + + def incidents_listener(self): + """Spawn a new Listener and links it to self.on_incident.""" + + self.listener = FireServiceRotaIncidents(on_incident=self.on_incident) + _LOGGER.debug("Starting incidents listener") + self.listener.start(url=self.url) + + +ws = FireService(wsurl) + +while True: + time.sleep(1) +``` + +%prep +%autosetup -n pyfireservicerota-0.0.43 + +%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-pyfireservicerota -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.43-1 +- Package Spec generated @@ -0,0 +1 @@ +5f7e65fe35ede4f280b1238f3a63fc70 pyfireservicerota-0.0.43.tar.gz |