Mirror/exec-notify
1
0
Fork 0
mirror of https://codeberg.org/privacy1st/exec-notify synced 2024-12-22 23:16:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

update Readme

Browse Source
This commit is contained in:
Daniel Langbein 2022-02-28 13:44:53 +01:00
parent f261db3bf3
commit 8bd499c91f
2 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -20,25 +20,26 @@ source ~/execNotify/venv/bin/activate
# echo "VIRTUAL_ENV=${VIRTUAL_ENV}" # echo "VIRTUAL_ENV=${VIRTUAL_ENV}"
``` ```
Option A: Install the module from TestPyPI: And choose one source of installation:
```shell ```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 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 > 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 > 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 > doesn’t have any dependencies, it’s a good practice to avoid installing dependencies when
> using TestPyPI. > using TestPyPI.
Option B: Install from local directory
```shell
python3 -m pip install ~/Downloads/git/execNotify/
```
(Optionally) list installed modules: (Optionally) list installed modules:
```shell ```shell
@ -47,11 +48,7 @@ pip list
## Installation - global ## Installation - global
Requires `pip` (e.g. `pacman -S --needed python-pip`): 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
```
Note: Make sure that pip is up-to-date and matches your python version: 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) #=> 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 ## Configuration
Create configuration file `/etc/execNotify/cfg.ini`: Create configuration file `/etc/execNotify/cfg.ini`:

2
etc/execNotify/cfg.ini.example
View File

@ -1,5 +1,3 @@
[DEFAULT]
[mail] [mail]
host = smtp.example.com host = smtp.example.com
port = 465 port = 465