Schrolli91/BOSWatch
1
0
Fork 0
mirror of https://github.com/Schrolli91/BOSWatch.git synced 2025-12-06 07:42:03 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Lars Krönner 2020-04-17 19:35:08 +02:00 committed by GitHub
parent cdd0d95e4d
commit 4b87e21a6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
plugins/README.md
View file

@ -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