update README.md

This commit is contained in:
Daniel Langbein 2022-03-01 16:32:45 +01:00
parent 28c322d6fb
commit cb6152e422

View File

@ -3,7 +3,31 @@
* Send email notification if command fails with [de-p1st-execNotify](src/de/p1st/exec_notify/execNotify.py). * Send email notification if command fails with [de-p1st-execNotify](src/de/p1st/exec_notify/execNotify.py).
* Send unconditional notifications with [de-p1st-notify](src/de/p1st/exec_notify/notify.py). * Send unconditional notifications with [de-p1st-notify](src/de/p1st/exec_notify/notify.py).
## Installation - venv ## Installation
### Installation - global
Requires `pip` (e.g. `pacman -S --needed python-pip`).
Note: Make sure that pip is up-to-date and matches your python version:
```shell
python --version
#=> Python 3.10.1
pip --version
#=> pip 20.3.4 from /usr/lib/python3.10/site-packages/pip (python 3.10)
```
Then install with one of the following options:
```shell
sudo python3 -m pip install --upgrade git+https://codeberg.org/privacy1st/execNotify
sudo python3 -m pip install --upgrade .
sudo python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps de.p1st.exec-notify
```
### Installation - venv
More detailed instructions about _venv_ can be found at [https://docs.python.org/3/library/venv.html](https://docs.python.org/3/library/venv.html) More detailed instructions about _venv_ can be found at [https://docs.python.org/3/library/venv.html](https://docs.python.org/3/library/venv.html)
@ -46,28 +70,6 @@ Note about usage of TestPyPI and `--no-deps`:
pip list pip list
``` ```
## Installation - global
Requires `pip` (e.g. `pacman -S --needed python-pip`).
Note: Make sure that pip is up-to-date and matches your python version:
```shell
python --version
#=> Python 3.10.1
pip --version
#=> pip 20.3.4 from /usr/lib/python3.10/site-packages/pip (python 3.10)
```
Then install with one of the following options:
```shell
sudo python3 -m pip install --upgrade git+https://codeberg.org/privacy1st/execNotify
sudo python3 -m pip install --upgrade .
sudo python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps de.p1st.exec-notify
```
## Configuration ## Configuration
Create configuration file `/etc/execNotify/cfg.ini`: Create configuration file `/etc/execNotify/cfg.ini`: