From 8bd499c91f2e8f2d89e7a791e8ca296ee3714be7 Mon Sep 17 00:00:00 2001 From: Daniel Langbein Date: Mon, 28 Feb 2022 13:44:53 +0100 Subject: [PATCH] update Readme --- README.md | 31 ++++++++++++++++++------------- etc/execNotify/cfg.ini.example | 2 -- 2 files changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ed3f0ba..362334a 100644 --- a/README.md +++ b/README.md @@ -20,25 +20,26 @@ source ~/execNotify/venv/bin/activate # echo "VIRTUAL_ENV=${VIRTUAL_ENV}" ``` -Option A: Install the module from TestPyPI: +And choose one source of installation: ```shell +# Install from git URL +python3 -m pip install git+https://codeberg.org/privacy1st/execNotify + +# Install from local directory +python3 -m pip install ~/Downloads/git/execNotify/ + +# Install the module from TestPyPI python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps --upgrade de.p1st.exec-notify ``` -The above command uses the parameter `--no-deps`: +Note about usage of TestPyPI and `--no-deps`: > Since TestPyPI doesn’t have the same packages as the live PyPI, it’s possible that attempting > to install dependencies may fail or install something unexpected. While this package > doesn’t have any dependencies, it’s a good practice to avoid installing dependencies when > using TestPyPI. -Option B: Install from local directory - -```shell -python3 -m pip install ~/Downloads/git/execNotify/ -``` - (Optionally) list installed modules: ```shell @@ -47,11 +48,7 @@ pip list ## Installation - global -Requires `pip` (e.g. `pacman -S --needed python-pip`): - -```shell -sudo python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps de.p1st.exec-notify -``` +Requires `pip` (e.g. `pacman -S --needed python-pip`). Note: Make sure that pip is up-to-date and matches your python version: @@ -63,6 +60,14 @@ 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 ~/Downloads/git/execNotify/ +sudo python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps de.p1st.exec-notify +``` + ## Configuration Create configuration file `/etc/execNotify/cfg.ini`: diff --git a/etc/execNotify/cfg.ini.example b/etc/execNotify/cfg.ini.example index 107cff8..0d35b94 100644 --- a/etc/execNotify/cfg.ini.example +++ b/etc/execNotify/cfg.ini.example @@ -1,5 +1,3 @@ -[DEFAULT] - [mail] host = smtp.example.com port = 465