From bf9ae8d5b3be82841beb492809a1e99884b89a58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Kr=C3=B6nner?= <41260142+LarsVomMars@users.noreply.github.com> Date: Fri, 17 Apr 2020 19:24:03 +0200 Subject: [PATCH 1/4] Create requirements.txt --- plugins/Telegram/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 plugins/Telegram/requirements.txt diff --git a/plugins/Telegram/requirements.txt b/plugins/Telegram/requirements.txt new file mode 100644 index 0000000..63667ac --- /dev/null +++ b/plugins/Telegram/requirements.txt @@ -0,0 +1,2 @@ +python-telegram-bot +requests From cdd0d95e4d662ba801b1f200b99124eb198a0dd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Kr=C3=B6nner?= <41260142+LarsVomMars@users.noreply.github.com> Date: Fri, 17 Apr 2020 19:24:29 +0200 Subject: [PATCH 2/4] Create requirements.txt --- plugins/yowsup/requirements.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 plugins/yowsup/requirements.txt diff --git a/plugins/yowsup/requirements.txt b/plugins/yowsup/requirements.txt new file mode 100644 index 0000000..372676b --- /dev/null +++ b/plugins/yowsup/requirements.txt @@ -0,0 +1 @@ +yowsup2 From 4b87e21a6f4a620425f1d0e5430a344742c34a06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Kr=C3=B6nner?= <41260142+LarsVomMars@users.noreply.github.com> Date: Fri, 17 Apr 2020 19:35:08 +0200 Subject: [PATCH 3/4] Update README.md --- plugins/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/plugins/README.md b/plugins/README.md index 093e510..be512ad 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -16,6 +16,16 @@ This `.run()` routine is called every time an alarm comes in Here are the information from BOSWatch available. See section `5. Process the data from BOSWatch` +#### 1.4 Requirements +Add all required (which need to be installed separately) python packages to a requirements.txt in the plugin directory so that the user can simply install all requirements for this plugin. + +For examples look at [the Telegram plugin](Telegram/requirements.txt) + +##### 1.4.1 Requirement installation +To install the packages from the requirements.txt run +`pip install -r /path/to/plugin/directory/requirements.txt` +Or because for the current version (2.5) Python2 is required +`pip2 install -r /path/to/plungin/directory/requirements.txt` will work for sure ## 2. Use Global Logging #### 2.1 Init and Use From e20f49b7b23555f099b9780f9e3929a08c113b98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Kr=C3=B6nner?= <41260142+LarsVomMars@users.noreply.github.com> Date: Sun, 19 Apr 2020 00:37:04 +0200 Subject: [PATCH 4/4] Update CHANGELOG.md --- CHANGELOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d10eb56..8e0d231 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +### __[v2.5.1]__ - unreleased +##### Added +Plugin requirements: Added requirements.txt for all plugins requiring extra python packages so the install will be easier +##### Changed +##### Deprecated +##### Removed +##### Fixed +##### Security + ### __[v2.5]__ - 16.04.2020 ##### Added - Divera-Plugin: Plugin zum Ansteuern der Divera-Api. [#415](https://github.com/Schrolli91/BOSWatch/pull/415)