Update .gitea/workflows/lint.yaml

Reviewed-on: #4

.gitea/workflows/lint.yaml

@@ -0,0 +1,18 @@
+on: [push, pull_request]
+
+jobs:
+  CI:
+    name: Lint Check Shellscripts
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Linter
+        run: |
+          wget -qO- "https://github.com/koalaman/shellcheck/releases/download/v0.11.0/shellcheck-v0.11.0.linux.$(uname -m).tar.xz" | tar -xJv
+          cp 'shellcheck-v0.11.0/shellcheck' /usr/local/bin
+          rm -rf "shellcheck-v0.11.0"
+          shellcheck --version
+      - name: Run Linter
+        run: |
+          shellcheck --exclude=SC1090,SC2046 penv
+          shellcheck --exclude=SC1090,SC2046 jconf

jconf

@@ -11,6 +11,10 @@
 # deluser: deletes jupyterhub user, deletes user home, deletes user profile from system.
 # start: starts the server, systemd call
 # stop: stops the server, systemd call
+# reference: https://medium.com/@prateekaverma/install-jupyterhub-and-jupyterlab-on-ubuntu-server-d390570b5bb6
+# detect if jconf is already installed, print who the admin is if so.
+
+VERSION=1
 
 title() {
     echo "JConf: JupyterHub Configuration Manager."
@@ -39,16 +43,72 @@ if [ "$#" -lt 1 ]; then
     exit 1
 fi
 
+if [[ "$EUID" -ne 0 ]]; then
+    echo "Run the script as root"
+    exit 2
+fi
+
+
 cmd=$1
 case "$cmd" in
-    adduser)
-        echo
+    adduser|mku)
+        USER=$(echo "$2" | tr "[:upper:]" "[:lower:]")
+        exist=$(awk -F: -v username="$USER" '{if ($1 == username && $3 >= 1000 && $1 != "nobody") {print 1; found=1; exit}} END {if (!found) print 0}' /etc/passwd)
+        if [ "$exist" -eq  1 ]; then
+            echo "$USER user already exists"
+        else
+            read -rp "Do you want to create an user account $USER [y/N]:" yn
+            case $yn in
+                [Yy])
+                    useradd "$USER"
+                    echo "Enter the password for $USER"
+                    passwd "$USER"
+                    echo "$USER user account created successfully"
+                    ;;
+                [Nn])
+                    exit 1
+                    ;;
+                * )
+                    echo "Please answer Y or N."
+                    ;;
+            esac
+        fi
+        exit 1
         ;;
-    deluser)
-        echo
+    deluser|rmu)
+        USER=$(echo "$2" | tr "[:upper:]" "[:lower:]")
+        exist=$(awk -F: -v username="$USER" '{if ($1 == username && $3 >= 1000 && $1 != "nobody") {print 1; found=1; exit}} END {if (!found) print 0}' /etc/passwd)
+        if [ "$exist" -eq  0 ]; then
+            echo "$USER user doesn't exist"
+            exit 1
+        else
+            read -rp "Do you want to delete $USER user account? [y/N]:" yn
+            case $yn in
+                [Yy])
+                    ;;
+                *)
+                    exit 1
+                    ;;
+            esac
+            read -rp "This DELETES $USER's data, are you sure? [y/N]:" yn
+            case $yn in
+                [Yy])
+                    userdel -rRZ "$USER";
+                    echo "$USER user account deleted successfully"
+                    ;;
+                [Nn])
+                    exit 1
+                    ;;
+                * )
+                    echo "Please answer Y or N."
+                    ;;
+            esac
+        fi
+        exit 1
         ;;
-    listusers)
-        echo
+    listusers|ls)
+        husers=$(awk -F: '{ if ($3 >= 1000 && $1 != "nobody" ) {print $1}}' /etc/passwd)
+        echo "$husers"
         ;;
     start)
         echo

penv

@@ -5,21 +5,25 @@
 # MIT Licensed, by The Grammer Society
 
 # Issues:
-# names are fully lower case when installed as jupyterhub spec. convert name to lower case when deleting an env.
 # when uninstalling, remove any jupyter specs. iterate through envs in .env, call jspec remove name.
 
+VERSION=1
+
+
 usage() {
     echo ""
     echo "Usage: penv <command> <args>"
     echo "Commands:"
-    echo " - new <name> <opt:version> - Create a new environment, optional, defaults to system's default python"
+    echo " - new <name> <ver=default> - Create a new environment, optional, defaults to system's default python"
     echo "                              ex: penv new tools 3.13 -> creates new environment by the name tools, using Python 3.13"
     echo "                              ex: penv new main       -> creates new env with the name main, using the default Python version on the system"
     echo " - del <name>               - Delete existing environment"
     # echo " - setdef <name>            - Use an existing environment as the default kernel"
     echo " - activate <name>          - Activates an existing environment (depricated, use pact)"
     echo " - list                     - List available environments"
+    echo " - pylist                   - List available PYTHON versions"
     echo " - install                  - Initialize user's profile"
+    echo " - update                   - Update penv to latest version"
     echo " - uninstall                - Remove ALL the environments installed using PENV"
     echo " - help                     - Print this message"
     echo
@@ -28,7 +32,9 @@ usage() {
     echo " - del      -> rm"
     # echo " - setdef   -> sd"
     echo " - activate -> ac, act"
+    echo " - pylist   -> pyls"
     echo " - list     -> ls"
+    echo " - update   -> up"
 }
 
 title(){
@@ -43,7 +49,7 @@ create(){
         exit 2
     fi
     if [[ -d "$HOME/.envs/$name" ]]; then
-        echo Environment \"$name\" already exists.
+        echo Environment \""$name"\" already exists.
         exit 4
     fi
 
@@ -52,19 +58,20 @@ create(){
             echo "Base python3 not found on your system. Install it using your package manager"
             exit 3
         fi
-        vers=`/usr/bin/python3 -V | cut -d " " -f 2 | cut -d "." -f 1,2`
+        vers=$(/usr/bin/python3 -V | cut -d " " -f 2 | cut -d "." -f 1,2)
         echo "No version mentioned, using Python $vers"
     fi
-    if [ ! -f /usr/bin/python$vers ]; then
+    if [ ! -f /usr/bin/python"$vers" ]; then
         echo "Python $vers not installed on system."
         exit 7
     fi
-    mkdir -p $HOME/.envs
-    /usr/bin/python$vers -m venv $HOME/.envs/$name
-    source $HOME/.envs/$name/bin/activate
-    python -m pip install ipykernel ipywidgets > /dev/stderr
-    python -m ipykernel install --user --name $name > /dev/stderr
+    mkdir -p "$HOME"/.envs
+    /usr/bin/python"$vers" -m venv "$HOME"/.envs/"$name"
+    source "$HOME"/.envs/"$name"/bin/activate
+    python -m pip install ipykernel ipywidgets
+    python -m ipykernel install --user --name "$name"
     echo
+    echo "--------------------------------------------------------------"
     echo "Created \"$name\". It should be available as a Jupyter Kernel."
     echo "Use \"pact $name\" to activate in command line."
     deactivate
@@ -81,15 +88,17 @@ delete(){
         echo "Run \"deactivate\" to deactivate it"
         exit 6
     fi
-    read -n 1 -p "Remove environment $name (y/N)? " choise
+    read -r -n 1 -p "Remove environment $name (y/N)? " choise
     case $choise in
     [yY])
-        source $HOME/.envs/$name/bin/activate
+        size=$(du "$HOME"/.envs/"$name" -sh | cut -f1)
+        source "$HOME"/.envs/"$name"/bin/activate
         echo
-        echo Spec `jupyter-kernelspec remove -f -y $name`
+        echo Spec $(jupyter-kernelspec remove -f -y "$name")
         deactivate
         rm -r "$HOME/.envs/$name"
         echo "Data Removed $HOME/.envs/$name"
+        echo "Reclaimed $size"
         ;;
     [nN])
         echo ""
@@ -114,7 +123,7 @@ delete(){
 # }
 
 activate() {
-    echo Use \"pact $1\"
+    echo Use \"pact "$1"\"
 }
 
 list(){
@@ -122,7 +131,7 @@ list(){
         echo "PENV not initialized. Run \"penv init\""
         exit 8
     fi
-    ls $HOME/.envs
+    ls "$HOME"/.envs
 }
 
 install() {
@@ -130,8 +139,9 @@ install() {
         echo PENV already installed
         exit 10
     fi
-    cp $(realpath "$0") $HOME/.local/bin/
-    mkdir -p $HOME/.envs/
+    mkdir -p "$HOME/.local/bin"
+    cp $(realpath "$0") "$HOME"/.local/bin/
+    mkdir -p "$HOME"/.envs/
     echo "
     pact () {
         if [[ -z \"\$1\" ]]; then
@@ -143,18 +153,36 @@ install() {
             return;
         fi
         . \$HOME/.envs/\$1/bin/activate
+        echo Activated.
+        echo Deactivate using \\\"deactivate\\\" or \\\"pdct\\\"
     }
-    " > $HOME/.envs/.penv.funcs
-    grep -qxF "source \$HOME/.envs/.penv.funcs" $HOME/.bashrc || echo "source \$HOME/.envs/.penv.funcs" >> $HOME/.bashrc
+
+    pdct () {
+    if [[ ! -n \"\$VIRTUAL_ENV\" ]]; then
+        echo \"No environment active\"
+        return;
+    fi
+    deactivate
+    }
+    " > "$HOME"/.envs/.penv.funcs
+    add2RC bashrc
+    add2RC zshrc
+    chmod +x "$HOME/.local/bin/penv"
     echo "Initialized PENV. Restart the shell"
 }
 
+add2RC(){
+    if [[ -f "$HOME/.$1" ]]; then
+        grep -qxF "source \$HOME/.envs/.penv.funcs" "$HOME/.$1" || echo "source \$HOME/.envs/.penv.funcs" >> "$HOME/.$1"
+    fi
+}
+
 uninstall() {
-    if [[ ! -z "$VIRTUAL_ENV" ]]; then
+    if [[ -n "$VIRTUAL_ENV" ]]; then
         echo "Deactivate the existing environment before uninstalling"
         exit 11
     fi
-    read -n 1 -p "REALLY UNINSTALL ALL THE ENVIRONMENTS?(y/N) " ans
+    read -r -n 1 -p "REALLY UNINSTALL ALL THE ENVIRONMENTS?(y/N) " ans
     case $ans in
         [yY])
             echo
@@ -170,12 +198,37 @@ uninstall() {
             return;
             ;;
     esac
-    sed -i "/source \$HOME\/.envs\/.penv.funcs/d" $HOME/.bashrc
-    rm -r $HOME/.envs
-    rm $HOME/.local/bin/penv
+    sed -i "/source \$HOME\/.envs\/.penv.funcs/d" "$HOME"/.bashrc
+    rm -r "$HOME"/.envs
+    rm "$HOME"/.local/bin/penv
     echo "Uninstalled PENV"
 }
 
+pyls(){
+    find /usr/local/bin /usr/bin -name "python3.*" 2> /dev/null | tr " " "\n" | grep "3.*" --color=always
+}
+
+update(){
+    if [[ $(realpath "$0") != "$HOME/.local/bin/penv" ]]; then
+        echo PENV not installed yet. Install it to use the update command.
+        exit 12
+    fi
+
+    if [ -x "$(command -v curl)" ]; then
+        curl "https://git.pvnweb.dedyn.io/phanipavank/jbomb/raw/branch/master/penv" -o "$HOME/.local/bin/penv"
+    elif [ -x "$(command -v wget)" ]; then
+        wget -o "$HOME/.local/bin/penv" "https://git.pvnweb.dedyn.io/phanipavank/jbomb/raw/branch/master/penv"
+    else
+        echo Curl or wget not found. Install either one to update penv.
+    fi
+    chmod +x "$HOME/.local/bin/penv"
+    sleep 0.5
+    newVer=$(grep VERSION "$HOME/.local/bin/penv" | cut -d '=' -f 2)
+    echo "PENV updated from $VERSION to $newVer"
+    exit 0
+}
+
+
 if [ "$#" -lt 1 ]; then
     title
     usage
@@ -186,20 +239,23 @@ cmd=$1
 
 case "$cmd" in
     new|mk)
-        create $2 $3
+        create "$(echo "$2" | tr "[:upper:]" "[:lower:]")" "$3"
         ;;
     del|rm)
-        delete $2
+        delete "$(echo "$2" | tr "[:upper:]" "[:lower:]")"
         ;;
     # setdef|sd)
     #     setdef $2
     #     ;;
     act|ac)
-        activate $2
+        activate "$(echo "$2" | tr "[:upper:]" "[:lower:]")"
         ;;
     list|ls)
         list
         ;;
+    pylist|pyls)
+        pyls
+        ;;
     help)
         title
         usage
@@ -210,9 +266,12 @@ case "$cmd" in
     uninstall)
         uninstall
         ;;
+    update|up)
+        update
+        ;;
     *)
         echo "invalid command: \"$1\"" >&2
-        echo $SCRIPT
+        echo "$SCRIPT"
         usage
         ;;
 esac