diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-internet-monitor-webthing.spec | 268 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 270 insertions, 0 deletions
@@ -0,0 +1 @@ +/internet_monitor_webthing-1.0.1.tar.gz diff --git a/python-internet-monitor-webthing.spec b/python-internet-monitor-webthing.spec new file mode 100644 index 0000000..2d5454b --- /dev/null +++ b/python-internet-monitor-webthing.spec @@ -0,0 +1,268 @@ +%global _empty_manifest_terminate_build 0 +Name: python-internet-monitor-webthing +Version: 1.0.1 +Release: 1 +Summary: A web connected local internet speed and connectivity monitor +License: MIT +URL: https://github.com/grro/internet_monitor_webthing +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/2e/e4/6ac9154f73a729117d75b636ed3080e4e4748cfae0f868ba5c8ff4eb5cbb/internet_monitor_webthing-1.0.1.tar.gz +BuildArch: noarch + +Requires: python3-webthing +Requires: python3-speedtest-cli +Requires: python3-ipwhois +Requires: python3-requests + +%description +# internet_monitor_webthing +A web connected local internet speed and connectivity monitor + +This project implements an internet monitor agent providing a speed monitor [webthing API](https://iot.mozilla.org/wot/) as well as a connectivity monitor [webthing API](https://iot.mozilla.org/wot/). + +The internet_monitor_webthing package exposes an http webthing endpoint which supports reading the internet speed results +as well as an endpoint to read the internet connectivity results via http +E.g. +``` +# webthing has been started on host 192.168.0.23 + +# internet speed +curl http://192.168.0.23:8433/0/properties +{ + "test_period": 900, + "downloadspeed": 215.2, + "uploadspeed": 11, + "ping": 17.763, + "testdate": "2020-10-11T13:44:51.346706", + "speedtest_server": "Mobile Breitbandnetze GmbH/Freisbach", + "speedtest_report_uri": "http://www.speedtest.net/result/10231336474.png" +} + +# connectivity +curl http://192.168.0.23:8433/1/properties +{ + "test_url": "http://google.com", + "test_period": 5, + "connected": true, + "ip_address": "95.88.57.72" +} +``` + +To run this software you may use Docker or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below + +**Docker approach** +``` +sudo docker run -p 8433:8433 grro/internet-monitor +``` + +**PIP approach** +``` +sudo pip install internet_monitor_webthing +``` + +After this installation you may start the webthing http endpoint inside your python code or via command line using +``` +sudo netmonitor --command listen --port 8433 --speedtest_period 900 --connecttest_period 10 +``` +Here, the webthing API will be bind to on port 8433. The internet speed monitor as well as the connectivity monitor will be started by performing the *listen* command above. +The speed test will be executed each 15 min (900 sec), the connectivity test will be executed each 10 sec. THe WebThing server provides [mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) to enable clients discovering the WebThing interfaces. + +By running a *systemd-based Linux distribution* you may use the *register* command to register and start the webthing service as systemd unit. +By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary. +``` +sudo netmonitor --command register --port 8433 --speedtest_period 900 --connecttest_period 10 +``` + +To start the speedtest monitor only just omit the --connecttest_period parameter +``` +sudo netmonitor --command listen --port 8433 --speedtest_period 900 +``` + + + + +%package -n python3-internet-monitor-webthing +Summary: A web connected local internet speed and connectivity monitor +Provides: python-internet-monitor-webthing +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-internet-monitor-webthing +# internet_monitor_webthing +A web connected local internet speed and connectivity monitor + +This project implements an internet monitor agent providing a speed monitor [webthing API](https://iot.mozilla.org/wot/) as well as a connectivity monitor [webthing API](https://iot.mozilla.org/wot/). + +The internet_monitor_webthing package exposes an http webthing endpoint which supports reading the internet speed results +as well as an endpoint to read the internet connectivity results via http +E.g. +``` +# webthing has been started on host 192.168.0.23 + +# internet speed +curl http://192.168.0.23:8433/0/properties +{ + "test_period": 900, + "downloadspeed": 215.2, + "uploadspeed": 11, + "ping": 17.763, + "testdate": "2020-10-11T13:44:51.346706", + "speedtest_server": "Mobile Breitbandnetze GmbH/Freisbach", + "speedtest_report_uri": "http://www.speedtest.net/result/10231336474.png" +} + +# connectivity +curl http://192.168.0.23:8433/1/properties +{ + "test_url": "http://google.com", + "test_period": 5, + "connected": true, + "ip_address": "95.88.57.72" +} +``` + +To run this software you may use Docker or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below + +**Docker approach** +``` +sudo docker run -p 8433:8433 grro/internet-monitor +``` + +**PIP approach** +``` +sudo pip install internet_monitor_webthing +``` + +After this installation you may start the webthing http endpoint inside your python code or via command line using +``` +sudo netmonitor --command listen --port 8433 --speedtest_period 900 --connecttest_period 10 +``` +Here, the webthing API will be bind to on port 8433. The internet speed monitor as well as the connectivity monitor will be started by performing the *listen* command above. +The speed test will be executed each 15 min (900 sec), the connectivity test will be executed each 10 sec. THe WebThing server provides [mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) to enable clients discovering the WebThing interfaces. + +By running a *systemd-based Linux distribution* you may use the *register* command to register and start the webthing service as systemd unit. +By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary. +``` +sudo netmonitor --command register --port 8433 --speedtest_period 900 --connecttest_period 10 +``` + +To start the speedtest monitor only just omit the --connecttest_period parameter +``` +sudo netmonitor --command listen --port 8433 --speedtest_period 900 +``` + + + + +%package help +Summary: Development documents and examples for internet-monitor-webthing +Provides: python3-internet-monitor-webthing-doc +%description help +# internet_monitor_webthing +A web connected local internet speed and connectivity monitor + +This project implements an internet monitor agent providing a speed monitor [webthing API](https://iot.mozilla.org/wot/) as well as a connectivity monitor [webthing API](https://iot.mozilla.org/wot/). + +The internet_monitor_webthing package exposes an http webthing endpoint which supports reading the internet speed results +as well as an endpoint to read the internet connectivity results via http +E.g. +``` +# webthing has been started on host 192.168.0.23 + +# internet speed +curl http://192.168.0.23:8433/0/properties +{ + "test_period": 900, + "downloadspeed": 215.2, + "uploadspeed": 11, + "ping": 17.763, + "testdate": "2020-10-11T13:44:51.346706", + "speedtest_server": "Mobile Breitbandnetze GmbH/Freisbach", + "speedtest_report_uri": "http://www.speedtest.net/result/10231336474.png" +} + +# connectivity +curl http://192.168.0.23:8433/1/properties +{ + "test_url": "http://google.com", + "test_period": 5, + "connected": true, + "ip_address": "95.88.57.72" +} +``` + +To run this software you may use Docker or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below + +**Docker approach** +``` +sudo docker run -p 8433:8433 grro/internet-monitor +``` + +**PIP approach** +``` +sudo pip install internet_monitor_webthing +``` + +After this installation you may start the webthing http endpoint inside your python code or via command line using +``` +sudo netmonitor --command listen --port 8433 --speedtest_period 900 --connecttest_period 10 +``` +Here, the webthing API will be bind to on port 8433. The internet speed monitor as well as the connectivity monitor will be started by performing the *listen* command above. +The speed test will be executed each 15 min (900 sec), the connectivity test will be executed each 10 sec. THe WebThing server provides [mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) to enable clients discovering the WebThing interfaces. + +By running a *systemd-based Linux distribution* you may use the *register* command to register and start the webthing service as systemd unit. +By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary. +``` +sudo netmonitor --command register --port 8433 --speedtest_period 900 --connecttest_period 10 +``` + +To start the speedtest monitor only just omit the --connecttest_period parameter +``` +sudo netmonitor --command listen --port 8433 --speedtest_period 900 +``` + + + + +%prep +%autosetup -n internet-monitor-webthing-1.0.1 + +%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-internet-monitor-webthing -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 17 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.1-1 +- Package Spec generated @@ -0,0 +1 @@ +1099ba413886d3d080630d412badba4b internet_monitor_webthing-1.0.1.tar.gz |