update install process

remove symlinks rename include/exclude Add package check to install script Add requirements add required debian packages for installer add devel modules add systemd files make executable fix path of PIpfile add functions script to build working development environment add python packages rough documentation of changes remove add to do file typo Add missing module Add executable explicitly set the current directory update to do add install/uninstall/purge update to do install script completed update todo add help fix paths renamed for better clarity of purpose renamed update to use path of script more reilably pass command line args to paperpi update to point proper location make executable skip layouts update documentation update documentation update paths move venv check, update paths for plugins.md creation increase readability improve reliability clean up cruft fix error in regex fix Clear() functions Update install.sh Added a command (and relevant echoes) to attempt to install the missing python packages once before failing the script. Successfully tested on PiZeroW and Pi4, both running the latest 32-bit Bullseye Raspbian. Working through other issues with the 64-bit test device at the moment, but I will confirm this change on that one as well. Feel free to change the echo statement. I tried to keep the style close to what is there. Also fixed typo in output message of missing package
txoof · Feb 26, 2022 · bff2731 · bff2731
1 parent 5c8f785
commit bff2731
Show file tree

Hide file tree

Showing 58 changed files with 1,665 additions and 16,520 deletions.
diff --git a/Pipfile b/Pipfile
@@ -6,13 +6,29 @@ name = "pypi"
 [packages]
 ipykernel = "*"
 epdlib = "*"
-argconfigparse = "*"
-dictor = "*"
-
-[dev-packages]
+pipreqs = "*"
+ArgConfigParse = "*"
 
 [requires]
 python_version = "3"
 
 [packages.it8951]
 git = "https://github.com/GregDMeyer/IT8951.git"
+
+[dev-packages]
+dictor = "*"
+requests = "*"
+epdlib = "*"
+pytz = "*"
+feedparser = "*"
+python-dateutil = "*"
+currency-symbols = "*"
+pycoingecko = "*"
+pygal = "*"
+qrcode = "*"
+cairocffi = "*"
+pycairo = "*"
+cffi = "*"
+QueryLMS = "*"
+Pillow = "*"
+CairoSVG = "*"
diff --git a/documentation/Plugins.md b/documentation/Plugins.md
@@ -3,35 +3,47 @@ All plugins are configured through the `paperpi.ini` files. For a single-user co
 
 
 ## Plugins Currently Avialable
-### [reddit_quote](../../paperpi/plugins/reddit_quote/README.md)
-![reddit_quote sample Image](../../paperpi/plugins/reddit_quote/reddit_quote.layout-sample.png)
+### [reddit_quote](../paperpi/plugins/reddit_quote/README.md)
+![reddit_quote sample Image](../paperpi/plugins/reddit_quote/reddit_quote.layout-sample.png)
 
-### [librespot_client](../../paperpi/plugins/librespot_client/README.md)
-![librespot_client sample Image](../../paperpi/plugins/librespot_client/librespot_client.layout-sample.png)
+### [librespot_client](../paperpi/plugins/librespot_client/README.md)
+![librespot_client sample Image](../paperpi/plugins/librespot_client/librespot_client.layout-sample.png)
 
-### [splash_screen](../../paperpi/plugins/splash_screen/README.md)
-![splash_screen sample Image](../../paperpi/plugins/splash_screen/splash_screen.layout-sample.png)
+### [moon_phase](../paperpi/plugins/moon_phase/README.md)
+![moon_phase sample Image](../paperpi/plugins/moon_phase/moon_phase.layout-sample.png)
 
-### [basic_clock](../../paperpi/plugins/basic_clock/README.md)
-![basic_clock sample Image](../../paperpi/plugins/basic_clock/basic_clock.layout-sample.png)
+### [lms_client](../paperpi/plugins/lms_client/README.md)
+![lms_client sample Image](../paperpi/plugins/lms_client/lms_client.layout-sample.png)
 
-### [xkcd_comic](../../paperpi/plugins/xkcd_comic/README.md)
-![xkcd_comic sample Image](../../paperpi/plugins/xkcd_comic/xkcd_comic.layout-sample.png)
+### [splash_screen](../paperpi/plugins/splash_screen/README.md)
+![splash_screen sample Image](../paperpi/plugins/splash_screen/splash_screen.layout-sample.png)
 
-### [word_clock](../../paperpi/plugins/word_clock/README.md)
-![word_clock sample Image](../../paperpi/plugins/word_clock/word_clock.layout-sample.png)
+### [basic_clock](../paperpi/plugins/basic_clock/README.md)
+![basic_clock sample Image](../paperpi/plugins/basic_clock/basic_clock.layout-sample.png)
 
-### [demo_plugin](../../paperpi/plugins/demo_plugin/README.md)
-![demo_plugin sample Image](../../paperpi/plugins/demo_plugin/demo_plugin.layout-sample.png)
+### [xkcd_comic](../paperpi/plugins/xkcd_comic/README.md)
+![xkcd_comic sample Image](../paperpi/plugins/xkcd_comic/xkcd_comic.layout-sample.png)
 
-### [default](../../paperpi/plugins/default/README.md)
-![default sample Image](../../paperpi/plugins/default/default.layout-sample.png)
+### [word_clock](../paperpi/plugins/word_clock/README.md)
+![word_clock sample Image](../paperpi/plugins/word_clock/word_clock.layout-sample.png)
 
-### [met_no](../../paperpi/plugins/met_no/README.md)
-![met_no sample Image](../../paperpi/plugins/met_no/met_no.layout-sample.png)
+### [demo_plugin](../paperpi/plugins/demo_plugin/README.md)
+![demo_plugin sample Image](../paperpi/plugins/demo_plugin/demo_plugin.layout-sample.png)
 
-### [dec_binary_clock](../../paperpi/plugins/dec_binary_clock/README.md)
-![dec_binary_clock sample Image](../../paperpi/plugins/dec_binary_clock/dec_binary_clock.layout-sample.png)
+### [newyorker](../paperpi/plugins/newyorker/README.md)
+![newyorker sample Image](../paperpi/plugins/newyorker/newyorker.layout-sample.png)
+
+### [default](../paperpi/plugins/default/README.md)
+![default sample Image](../paperpi/plugins/default/default.layout-sample.png)
+
+### [met_no](../paperpi/plugins/met_no/README.md)
+![met_no sample Image](../paperpi/plugins/met_no/met_no.layout-sample.png)
+
+### [crypto](../paperpi/plugins/crypto/README.md)
+![crypto sample Image](../paperpi/plugins/crypto/crypto.layout-sample.png)
+
+### [dec_binary_clock](../paperpi/plugins/dec_binary_clock/README.md)
+![dec_binary_clock sample Image](../paperpi/plugins/dec_binary_clock/dec_binary_clock.layout-sample.png)
 
 ## Configuration
 Each plugin is configured through a [Plugin: Name] section in the configuration files. 

diff --git a/documentation/source/Plugins_post.ipynb b/documentation/source/Plugins_post.ipynb
@@ -1,5 +1,34 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# PLUGIN NOTES\n",
+    "* a `requirements-plugin.txt` file will be generated by the `utilities/find_imports.sh` script\n",
+    "* any hidden import dependencies should be added to `requirements-plugin_hidden.txt` manually \n",
+    "    * one requriement perline, only the PyPi name, no version numbers unless absolutely necessary\n",
+    "    * version numbers (only if necessary) should follow the pip format: `modulename==0.2.2`\n",
+    "* On installation, when the virtual pipenv is created, the requirements files are used to install necessary modules in addition to the core modules in the main Pipfile -- do not add to the core Pipfile!\n",
+    "* any debian packages needed should be added to debian_packages-pluginname.txt\n",
+    "    * use the following format: `DEBPKG=( \"debPackAge0\" \"debpackage1\" \"debPackage2\" )\n",
+    "             \n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# INSTALLER NOTES\n",
+    "* Need a separate install Pipfile user install and development install\n",
+    "    - Clean Pipfile that contains only what's absolutely necessary for paperpi; all other modules are installed from requirements-foo.txt files \n",
+    "    - Development Pipfile contains everything that every plugin under development requires; maybe split out everything under \"\\[development\\]\" header in Pipfile\n",
+    "* Need script for building development environment\n",
+    "* need script for launching paperpi from install path\n",
+    "    * need to update daemon unit file to use launcher\n",
+    "    "
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -278,7 +307,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.9.2"
   }
  },
  "nbformat": 4,