updates

Author: diepirio

.github/workflows/publish.yml

@@ -1,9 +1,22 @@
+<<<<<<< HEAD
 name: Publish package
+=======
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+>>>>>>> e0aa78494152ccb561414e3c0595297eb7f86980
 
 on:
   release:
     types: [published]
 
+<<<<<<< HEAD
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -34,4 +47,30 @@ jobs:
       # if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
+=======
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+>>>>>>> e0aa78494152ccb561414e3c0595297eb7f86980
         password: ${{ secrets.PYPI_API_TOKEN }}

Makefile

@@ -24,6 +24,7 @@ up: build  ## Run docker compose service
 
 down:  ## Stop docker compose service
 	docker compose down
+	docker compose down --volumes
 
 rebuild: down up  ## Rebuild docker compose service
 

README.md

@@ -1,13 +1,25 @@
-# jupyter-pgadmin-proxy
+# Jupyter pgAdmin proxy
 
-jupyter-pgadmin-proxy provides Jupyter extension to run [pgAdmin 4](https://pypi.org/project/pgadmin4/). See also official pages for ([pgAdmin](https://www.pgadmin.org/).
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/jupyter-pgadmin-proxy.svg)](https://pypi.org/project/jupyter-pgadmin-proxy/)
+
+jupyter-pgadmin-proxy provides Jupyter extension to run [pgAdmin 4](https://pypi.org/project/pgadmin4/). See also official pages for [pgAdmin](https://www.pgadmin.org/).
 
 ## Installation
 
 You can install jupyter-pgadmin-proxy inside your environment with Jupyter / Jupyterlab:
 
 ```
-python3 -m pip install git+https://github.com/huntdatacenter/jupyter-pgadmin-proxy.git@main
+python3 -m pip install jupyter-pgadmin-proxy
+```
+
+## Build
+
+```
+python3 -m pip install hatch
+
+hatch build
+
+ls -la dist/*
 ```
 
 ## Development
@@ -18,6 +30,10 @@ Try `make help` to see available commands:
 make help
 ```
 
+```
+python3 -m pip install git+https://github.com/huntdatacenter/jupyter-pgadmin-proxy.git@main
+``
+
 ## Testing in docker
 
 Run/rebuild local Jupyterlab service:

docker-compose.yaml

@@ -16,6 +16,7 @@ services:
       PGDATABASE: postgres
       PGUSER: postgres
       PGPASSWORD: postgres
+      # PGADMIN_ENABLED: 'false'
     volumes:
       - "${PWD}:/home/jovyan/jupyter-pgadmin-proxy"
   postgres:
@@ -28,9 +29,8 @@ services:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
     volumes:
-      - db:/var/lib/postgresql/data
+      - pgtestdb:/var/lib/postgresql/data
 
 volumes:
-  db:
-    name: db
+  pgtestdb: {}
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "jupyter-pgadmin-proxy"
-version = "0.0.1"
+version = "0.0.2"
 authors = [
   { name="Matus Kosut", email="[email protected]" },
   { name="Diepiriye Okujagu", email="[email protected]" },
@@ -14,11 +14,11 @@ readme = "README.md"
 license = { file = "LICENSE.md" }
 requires-python = ">=3.8"
 dependencies = [
-    "jupyter-server-proxy>=3.2.2",
+    "jupyter-server-proxy>=3.2.2,<4.0.0",
     "pgadmin4",
     "simple-websocket",
     "psycopg",
-    "uwsgi"
+    "gunicorn",
 ]
 classifiers = [
     "Framework :: Jupyter",

setup/Dockerfile

@@ -5,9 +5,6 @@ RUN set -x \
     && apt-get update \
     && apt-get install -y curl postgresql-client
 
-WORKDIR /etc/pgadmin
-COPY setup/config_system.py /etc/pgadmin/config_system.py
-
 # setup package, enable classic extension, build lab extension
 # USER "${NB_USER}"
 RUN mamba install -q -c conda-forge -y uwsgi simple-websocket psycopg
@@ -31,5 +28,8 @@ RUN cp /etc/jupyter/jupyter_notebook_config.py /etc/jupyter/jupyter_notebook_con
 COPY setup/jupyter_notebook_config.py /etc/jupyter/jupyter_notebook_config.py
 RUN fix-permissions /etc/jupyter
 
+WORKDIR /etc/pgadmin
+COPY setup/config_system.py /etc/pgadmin/config_system.py
 
 USER "${NB_USER}"
+WORKDIR "${HOME}"

setup/config_system.py

@@ -24,6 +24,14 @@
 
 # from pgadmin.utils import env
 
+
+TRUTHY = ("true", "1", "yes", "on", "y")
+
+
+def truthy(val):
+    return str(val).strip('"').strip("'").lower() in TRUTHY
+
+
 ##########################################################################
 # Application settings
 ##########################################################################
@@ -115,11 +123,11 @@
 #       SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR, and
 #       AZURE_CREDENTIAL_CACHE_DIR
 
-if (not hasattr(builtins, 'SERVER_MODE')) or builtins.SERVER_MODE is None:
-    SERVER_MODE = True
-else:
-    SERVER_MODE = builtins.SERVER_MODE
-# SERVER_MODE = False
+# if (not hasattr(builtins, 'SERVER_MODE')) or builtins.SERVER_MODE is None:
+#     SERVER_MODE = True
+# else:
+#     SERVER_MODE = builtins.SERVER_MODE
+SERVER_MODE = truthy(os.getenv('PGADMIN_SERVER_MODE'))
 
 # HTTP headers to search for CSRF token when it is not provided in the form.
 # Default is ['X-CSRFToken', 'X-CSRF-Token']
@@ -334,7 +342,7 @@
 # Using PGPASS file
 # postgresql://username@host:port?options=-csearch_path=pgadmin
 ##########################################################################
-CONFIG_DATABASE_URI = ''
+CONFIG_DATABASE_URI = ""
 
 ##########################################################################
 # User account and settings storage
@@ -584,7 +592,7 @@
 # Master password is used to encrypt/decrypt saved server passwords
 # Applicable for desktop mode only
 ##########################################################################
-MASTER_PASSWORD_REQUIRED = True
+MASTER_PASSWORD_REQUIRED = truthy(os.getenv("MASTER_PASSWORD_REQUIRED"))
 
 ##########################################################################
 

src/jupyter_pgadmin_proxy/__init__.py

@@ -6,10 +6,17 @@
 import site
 
 logging.basicConfig(level="INFO")
-logger = logging.getLogger("pgadmin")
+logger = logging.getLogger("pgAdmin4")
 logger.setLevel("INFO")
 
 
+TRUTHY = ("true", "1", "yes", "on", "y")
+
+
+def truthy(val):
+    return str(val).strip('"').strip("'").lower() in TRUTHY
+
+
 def _get_env(port, base_url):
     """
     Returns a dict containing environment settings to launch the Web App.
@@ -24,16 +31,21 @@ def _get_env(port, base_url):
     logger.info(f"pgAdmin ENV: {base_url}pgadmin4/")
 
     default_email = os.getenv("PGADMIN_DEFAULT_EMAIL", "[email protected]")
-    setup_email = os.getenv("PGADMIN_SETUP_EMAIL", "[email protected]")
+    # setup_email = os.getenv("PGADMIN_SETUP_EMAIL", "[email protected]")
     return {
-        "PGADMIN_SERVER_MODE": 'True',
+        # "PGADMIN_SERVER_MODE": "True",
+        # "PGADMIN_SETUP_EMAIL": setup_email,
+        # "PGADMIN_SETUP_PASSWORD": ".",
         "PGADMIN_DEFAULT_EMAIL": default_email,
-        "PGADMIN_SETUP_EMAIL": setup_email,
-        "PGADMIN_SETUP_PASSWORD": "",
         "PGADMIN_LISTEN_PORT": str(port),
         "APPLICATION_ROOT": f"{base_url}pgadmin4/",
         "SCRIPT_NAME": f"{base_url}pgadmin4/",
         "REMOTE_USER": os.getenv("USER", os.getenv("NB_USER", "nobody")),
+        "PGHOST": os.getenv("PGHOST"),
+        "PGPORT": os.getenv("PGPORT"),
+        "PGDATABASE": os.getenv("PGDATABASE"),
+        "PGUSER": os.getenv("PGUSER"),
+        "PGPASSWORD": os.getenv("PGPASSWORD"),
     }
 
 
@@ -43,7 +55,6 @@ def get_icon_path():
     )
 
 
-
 def get_system_user():
     try:
         user = pwd.getpwuid(os.getuid())[0]
@@ -62,38 +73,35 @@ def run_app():
 
     icon_path = get_icon_path()
     try:
-        executable_name = shutil.which("pgadmin4")
+        executable_name = shutil.which("gunicorn")
     except Exception:
-        executable_name = "pgadmin4"
-    host = "127.0.0.1"
+        executable_name = "gunicorn"
     user = get_system_user()
     try:
         chdir_path = f"{site.getsitepackages()[0]}/pgadmin4"
         if not os.path.exists(chdir_path):
             chdir_path = os.path.dirname(os.path.abspath(__file__))
     except Exception:
         chdir_path = "/"
-    logger.debug(f"[{user}] Icon_path:  {icon_path}")
+    logger.debug(f"[{user}] Icon path: {icon_path}")
     logger.debug(f"[{user}] Launch Command: {executable_name}")
+    logger.debug(f"[{user}] pgAdmin path: {chdir_path}")
     return {
         "command": [
-            # executable_name,
-            "uwsgi",
-            "--http-socket", "127.0.0.1:{port}",
-            "--mount", "{base_url}pgadmin4/=pgAdmin4:app",
-            "--chdir", chdir_path,
-            "--manage-script-name",
-            "--processes", "1",
-            "--threads", "25",
-            "--need-app",
+            executable_name,
+            '-b', '127.0.0.1:{port}',
+            '-e', 'SCRIPT_NAME={base_url}pgadmin',
+            '--chdir', chdir_path,
+            'pgAdmin4:app',
         ],
         "timeout": 300,
         "environment": _get_env,
         "absolute_url": True,
         # "rewrite_response": rewrite_netloc,
-        # "request_headers_override": {"X-Script-Name": "{base_url}pgadmin4/"},
+        # "request_headers_override": {"X-Script-Name": "{base_url}pgadmin"},
         "launcher_entry": {
             "title": "pgAdmin4",
-            "icon_path": icon_path
+            "icon_path": icon_path,
+            "enabled": truthy(os.getenv("PGADMIN_ENABLED", "true")),
         },
     }