Merge pull request #10 from pimoroni/patch-install

Fixes to the install.sh endpoint

Author: Gadgetoid

.github/workflows/qa.yml

@@ -10,6 +10,10 @@ jobs:
   test:
     name: linting & spelling
     runs-on: ubuntu-latest
+
+    env:
+      TERM: xterm-256color
+
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2

README.md

@@ -28,5 +28,5 @@ Latest/development library from GitHub:
 
 * `git clone https://github.com/pimoroni/PROJECT_NAME-python`
 * `cd PROJECT_NAME-python`
-* `sudo ./install.sh`
+* `./install.sh --unstable`
 

install.sh

@@ -1,13 +1,12 @@
 #!/bin/bash
 LIBRARY_NAME=`grep -m 1 name pyproject.toml | awk -F" = " '{print substr($2,2,length($2)-2)}'`
-LIBRARY_VERSION=`grep __version__ $LIBRARY_NAME/__init__.py | awk -F" = " '{print substr($2,2,length($2)-2)}'`
 CONFIG=/boot/config.txt
 DATESTAMP=`date "+%Y-%m-%d-%H-%M-%S"`
 CONFIG_BACKUP=false
 APT_HAS_UPDATED=false
 RESOURCES_TOP_DIR=$HOME/Pimoroni
 WD=`pwd`
-USAGE="sudo ./install.sh (--unstable)"
+USAGE="./install.sh (--unstable)"
 POSITIONAL_ARGS=()
 FORCE=false
 UNSTABLE=false
@@ -60,7 +59,7 @@ function do_config_backup {
 		CONFIG_BACKUP=true
 		FILENAME="config.preinstall-$LIBRARY_NAME-$DATESTAMP.txt"
 		inform "Backing up $CONFIG to /boot/$FILENAME\n"
-		cp $CONFIG /boot/$FILENAME
+		sudo cp $CONFIG /boot/$FILENAME
 		mkdir -p $RESOURCES_TOP_DIR/config-backups/
 		cp $CONFIG $RESOURCES_TOP_DIR/config-backups/$FILENAME
 		if [ -f "$UNINSTALLER" ]; then
@@ -90,11 +89,15 @@ function apt_pkg_install {
 		fi
 		sudo apt install -y $PACKAGES
 		if [ -f "$UNINSTALLER" ]; then
-			echo "apt uninstall -y $PACKAGES"
+			echo "apt uninstall -y $PACKAGES" >> $UNINSTALLER
 		fi
 	fi
 }
 
+function pip_pkg_install {
+	PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring $PYTHON -m pip install --upgrade "$@"
+}
+
 while [[ $# -gt 0 ]]; do
 	K="$1"
 	case $K in
@@ -131,11 +134,11 @@ fi
 
 PYTHON_VER=`$PYTHON --version`
 
-printf "$LIBRARY_NAME ($LIBRARY_VERSION) Python Library: Installer\n\n"
+printf "$LIBRARY_NAME Python Library: Installer\n\n"
 
 inform "Checking Dependencies. Please wait..."
 
-$PYTHON -m pip install --upgrade toml
+pip_pkg_install toml
 
 CONFIG_VARS=`$PYTHON - <<EOF
 import toml
@@ -162,6 +165,13 @@ eval $CONFIG_VARS
 RESOURCES_DIR=$RESOURCES_TOP_DIR/$LIBRARY_NAME
 UNINSTALLER=$RESOURCES_DIR/uninstall.sh
 
+RES_DIR_OWNER=`stat -c "%U" $RESOURCES_TOP_DIR`
+
+if [[ "$RES_DIR_OWNER" == "root" ]]; then
+	warning "\n\nFixing $RESOURCES_TOP_DIR permissions!\n\n"
+	sudo chown -R $USER:$USER $RESOURCES_TOP_DIR
+fi
+
 mkdir -p $RESOURCES_DIR
 
 cat << EOF > $UNINSTALLER
@@ -180,9 +190,9 @@ fi
 inform "Installing for $PYTHON_VER...\n"
 apt_pkg_install "${APT_PACKAGES[@]}"
 if $UNSTABLE; then
-	$PYTHON -m pip install .
+	pip_pkg_install .
 else
-	$PYTHON -m pip install --upgrade $LIBRARY_NAME
+	pip_pkg_install $LIBRARY_NAME
 fi
 if [ $? -eq 0 ]; then
 	success "Done!\n"
@@ -205,9 +215,9 @@ for ((i = 0; i < ${#CONFIG_TXT[@]}; i++)); do
 	if ! [ "$CONFIG_LINE" == "" ]; then
 		do_config_backup
 		inform "Adding $CONFIG_LINE to $CONFIG\n"
-		sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG
+		sudo sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG
 		if ! grep -q "^$CONFIG_LINE" $CONFIG; then
-			printf "$CONFIG_LINE\n" >> $CONFIG
+			printf "$CONFIG_LINE\n" | sudo tee --append $CONFIG
 		fi
 	fi
 done
@@ -223,13 +233,12 @@ fi
 
 printf "\n"
 
-if [ -f "/usr/bin/pydoc" ]; then
+if confirm "Would you like to generate documentation?"; then
+	pip_pkg_install pdoc
 	printf "Generating documentation.\n"
-	pydoc -w $LIBRARY_NAME > /dev/null
-	if [ -f "$LIBRARY_NAME.html" ]; then
-		cp $LIBRARY_NAME.html $RESOURCES_DIR/docs.html
-		rm -f $LIBRARY_NAME.html
-		inform "Documentation saved to $RESOURCES_DIR/docs.html"
+	$PYTHON -m pdoc $LIBRARY_NAME -o $RESOURCES_DIR/docs > /dev/null
+	if [ $? -eq 0 ]; then
+		inform "Documentation saved to $RESOURCES_DIR/docs"
 		success "Done!"
 	else
 		warning "Error: Failed to generate documentation."

requirements-dev.txt

@@ -6,3 +6,4 @@ twine
 hatch
 hatch-fancy-pypi-readme
 tox
+pdoc

uninstall.sh

@@ -2,7 +2,6 @@
 
 FORCE=false
 LIBRARY_NAME=`grep -m 1 name pyproject.toml | awk -F" = " '{print substr($2,2,length($2)-2)}'`
-LIBRARY_VERSION=`grep __version__ $LIBRARY_NAME/__init__.py | awk -F" = " '{print substr($2,2,length($2)-2)}'`
 RESOURCES_DIR=$HOME/Pimoroni/$LIBRARY_NAME
 PYTHON="/usr/bin/python3"
 
@@ -47,7 +46,7 @@ warning() {
 	echo -e "$(tput setaf 1)$1$(tput sgr0)"
 }
 
-printf "$LIBRARY_NAME $LIBRARY_VERSION Python Library: Uninstaller\n\n"
+printf "$LIBRARY_NAME Python Library: Uninstaller\n\n"
 
 user_check