From 7d95063123008314065ada070637ce8aa4ee0635 Mon Sep 17 00:00:00 2001 From: Johannes Findeisen Date: Wed, 28 Sep 2022 03:38:56 +0200 Subject: [PATCH] README update. --- README.md | 13 +++++++++++++ requirements.txt | 4 ++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 374edbd..8e8f04d 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,19 @@ to use this library in very early versions of Linspector in 2011. Since the main in Linspector is the execution of jobs in regularly intervals I believe it is the right decision to include the code of APScheduler directly into the Linspector project. +### Other used libraries + +monitors, notifications, services or plugins sometimes need to make the use of +3rd party libraries, but they are not required to run Linspector properly. Not installing +them may only affect parts of Linspector. Currently used libraries are: + +- [CherryPy](https://cherrypy.dev/) - CherryPy is a pythonic, object-oriented HTTP framework. Used by the HTTPServer plugin. +- [requests](https://requests.readthedocs.io/en/latest/) - Requests is an elegant and simple HTTP library for Python, built for human beings. Used by the Speedtest service. + +These libraries are not being delivered with the Linspector source code and maybe have +different and incompatible licenses. You need to install them using pip, your OS package +manager or any other possible way. + ### Version numbering According to: [https://wiki.unixpeople.org/linux_kernel_version_numbering](https://wiki.unixpeople.org/linux_kernel_version_numbering) diff --git a/requirements.txt b/requirements.txt index 48b8acd..31fb96c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ -requests~=2.28.1 # used by speedtest type -CherryPy~=18.8.0 # used by httpserver plugin \ No newline at end of file +CherryPy~=18.8.0 # used by httpserver plugin +requests~=2.28.1 # used by speedtest service \ No newline at end of file