added pgweb

Author: Hansstem

pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "jupyter-pgweb-proxy"
+version = "0.0.1"
+authors = [
+  { name="Matus Kosut", email="[email protected]" },
+  { name="Hans Stemshaug", email="[email protected]" },
+]
+description = "A small example package"
+readme = "README.md"
+license = { file = "LICENSE.md" }
+requires-python = ">=3.8"
+dependencies = [
+    "jupyter-server-proxy>=3.2.2",
+]
+classifiers = [
+    "Framework :: Jupyter",
+    "Framework :: Jupyter :: JupyterLab",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+]
+keywords = [
+    "Jupyter Proxy",
+    "Jupyter Server Proxy",
+    "JupyterLab",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/huntdatacenter/jupyter-pgweb-proxy"
+
+[project.optional-dependencies]
+dev = ["black", "ruamel.yaml", "pytest", "pytest-cov"]
+
+[project.entry-points.jupyter_serverproxy_servers]
+pgweb = "jupyter_pgweb_proxy:run_app"
+
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/jupyter_pgweb_proxy"]
+
+[tool.hatch.build]
+sources = ["src"]
+artifacts = [
+  "*.svg",
+]
+
+[tool.hatch.build.targets.sdist]
+artifacts = []
+exclude = [".github"]
+
+[tool.hatch.build.targets.jupyter_pgweb_proxy]

src/jupyter_pgweb_proxy/__init__.py

@@ -1 +1,82 @@
-# keep
+import os
+import logging
+import shutil
+import pwd
+import getpass
+from jupyter_pgweb_proxy.jupyter_config import config
+
+
+def _get_env(port, base_url):
+    """
+    Returns a dict containing environment settings to launch the Web App.
+    Args:
+        port (int): Port number on which the Web app will be started. Ex: 8888
+        base_url (str): Controls the prefix in the url on which
+                        the Web App will be available.
+                        Ex: localhost:8888/base_url/index.html
+    Returns:
+        [Dict]: Containing environment settings to launch the Web application.
+    """
+
+    return {
+        "PGWEB_RUN_PORT": str(port),
+        "PGWEB_URL_PREFIX": f"{base_url}pgweb",
+    }
+
+
+def get_icon_path():
+    return os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), "pgweb.svg"
+    )
+
+
+def _get_timeout(default=15):
+    try:
+        return float(os.getenv('RSESSION_TIMEOUT', default))
+    except Exception:
+        return default
+
+
+def get_system_user():
+    try:
+        user = pwd.getpwuid(os.getuid())[0]
+    except Exception:
+        user = os.getenv('USER', getpass.getuser())
+    return user
+
+
+def run_app():
+    """
+    Setup application.
+    This method is run by jupyter-server-proxy package to launch the Web app.
+    """
+
+    logging.basicConfig(level="INFO")
+    logger = logging.getLogger("pgweb")
+    logger.setLevel("INFO")
+    logger.info("Initializing Jupyter pgweb Proxy")
+
+    icon_path = get_icon_path()
+    try:
+        executable_name = shutil.which("pgweb")
+    except Exception:
+        executable_name = "pgweb"
+    host = "127.0.0.1"
+    user = get_system_user()
+    logger.debug(f"[{user}] Icon_path:  {icon_path}")
+    logger.debug(f"[{user}] Launch Command: {executable_name}")
+    return {
+        "command": [
+            executable_name,
+            f"--host={host}",
+            "--port={port}",
+        ],
+        "timeout": 100,
+        "environment": _get_env,
+        "absolute_url": True,
+        # "rewrite_response": rewrite_netloc,
+        "launcher_entry": {
+            "title": "pgweb",
+            "icon_path": icon_path
+        },
+    }

src/jupyter_pgweb_proxy/jupyter_config.py

@@ -0,0 +1,7 @@
+
+# Configure application proxy to extend for Jupyter
+config = {
+    # Link the documentation url here. This will show up on the website UI
+    # where users can create issue's or make enhancement requests
+    "doc_url": "https://docs.hdc.ntnu.no/do-science/hunt-workbench/",
+}