From fd50ab7debd5421e80c5d0cc78aad042bd0c1833 Mon Sep 17 00:00:00 2001 From: Roland Beck <7224371+Data-Monkey@users.noreply.github.com> Date: Thu, 25 May 2023 13:53:08 +1000 Subject: [PATCH] Create README.md --- pialert/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 pialert/README.md diff --git a/pialert/README.md b/pialert/README.md new file mode 100644 index 00000000..6ef008b2 --- /dev/null +++ b/pialert/README.md @@ -0,0 +1,14 @@ +# Pi.Alert all split into modules + +I am trying to split this big original file into modules and gives me some nice challanges to solve. +Since the original code is all in one file, the original author has taken quite some shortcuts by defining lots of variables as global !! +These need to be changed now. + +Here is the main structure + +| Module | Description | +|--------|-----------| +|pialert.py | The MAIN program of Pi.Alert| +|const.py | A place to define the constants for Pi.Alert like log path or config path.| +|const.py| const.py holds the configuration variables and makes them availabe for all modules. It is also the workaround for the global variables until I can work them out| +|api.py| |