chore: First commit (#1)

Author: jgwerner

.gitignore

@@ -0,0 +1,42 @@
+.conda/
+.config
+.bash_history
+.local
+.npm
+node_modules
+*~
+*.py[co]
+.cache
+.coverage
+.coverage.*
+.DS_Store
+*.egg-info
+.env
+.idea/
+*.ipynb
+.ipynb_checkpoints
+*.pid
+.pytest_cache
+*.retry
+.vim/
+.vscode
+.yarn
+hosts.*
+dist
+docs/_build
+docs/build
+docs/source/_static/rest-api
+grades-sender.lock
+hosts
+htmlcov
+jupyterhub_cookie_secret
+jupyterhub.sqlite
+MANIFEST
+pip-wheel-metadata
+*pycache*
+secrets
+share/jupyterhub/static/components
+share/jupyterhub/static/css/style.min.css
+share/jupyterhub/static/css/style.min.css.map
+src/build*
+venv

Dockerfile

@@ -0,0 +1,31 @@
+FROM jupyter/minimal-notebook:latest
+
+USER root
+RUN apt-get update \
+ && apt-get install -y \
+    curl \
+    unzip \
+    wget
+
+# install pgweb
+ENV PGWEB_VERSION=0.11.6
+RUN wget -q "https://github.com/sosedoff/pgweb/releases/download/v${PGWEB_VERSION}/pgweb_linux_amd64.zip" \
+ && unzip pgweb_linux_amd64.zip -d /usr/bin \
+ && mv /usr/bin/pgweb_linux_amd64 /usr/bin/pgweb
+
+# setup package, enable classic extension, build lab extension
+USER "${NB_USER}"
+COPY . "${HOME}"/
+COPY requirements.txt "${HOME}"/
+WORKDIR "${HOME}"
+RUN python3 -m pip install .
+RUN python3 -m pip install -r requirements.txt \
+ && jupyter serverextension enable --sys-prefix jupyter_server_proxy \
+ && jupyter labextension install @jupyterlab/server-proxy \
+ && jupyter lab build
+
+# copy configs, update permissions as root
+USER root
+RUN fix-permissions /etc/jupyter
+
+USER "${NB_USER}"

README.md

@@ -1,2 +1,40 @@
 # jupyter-pgweb-proxy
-Jupyter server proxy w/ pgweb
+
+This package was built using the [`illumidesk/jupyter-server-proxy` cookiecutter template](https://github.com/illumidesk/cookiecutter-jupyter-server-proxy).
+
+## Requirements
+
+- Python 3.6+
+- Jupyter Notebook 6.0+
+- JupyterLab 2.1+
+
+This package executes the standard `pgweb` command. This command assumes the `pgweb` command is available in the environment's `PATH`.
+
+### Install jupyter-pgweb-proxy
+
+Install the package with pip:
+
+```
+pip install git+https://github.com/illumidesk/jupyter-pgweb-proxy.git
+```
+
+## Example
+
+Try with binder:
+
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/illumidesk/jupyter-pgweb-proxy/main?urlpath=pgweb)
+
+Test locally:
+
+```bash
+docker build -t jupyter/pgweb .
+docker build -it --rm -p 8888:8888 jupyter/pgweb
+```
+
+## Credits
+
+- [`jupyter-server-proxy`](https://github.com/jupyterhub/jupyter-server-proxy)
+
+## License
+
+BSD 3-Clause

jupyter_notebook_config.py

@@ -0,0 +1,16 @@
+c = get_config()
+
+
+# load base config
+load_subconfig('/etc/jupyter/jupyter_notebook_config_base.py')
+
+
+# supports iframe and samesite cookies
+c.NotebookApp.tornado_settings = {
+    "headers": {"Content-Security-Policy": "frame-ancestors 'self' *"},
+    "cookie_options": {"SameSite": "None", "Secure": True},
+}
+c.NotebookApp.allow_root = True
+c.NotebookApp.allow_origin = '*'
+c.NotebookApp.token = ''
+c.NotebookApp.default_url = '/lab'

jupyter_pgweb_proxy/__init__.py

@@ -0,0 +1,42 @@
+import os
+import shutil
+import logging
+
+
+logger = logging.getLogger(__name__)
+logger.setLevel('INFO')
+
+
+def setup_pgweb():
+    """Setup commands and icon paths and return a dictionary compatible
+    with jupyter-server-proxy.
+    """
+    def _get_icon_path():
+        return os.path.join(
+            os.path.dirname(os.path.abspath(__file__)), 'icons', 'pgweb.svg'
+    )
+
+    # Make sure executable is in $PATH
+    def _get_pgweb_command(port):
+        executable = 'pgweb'
+        if not shutil.which(executable):
+            raise FileNotFoundError('Can not find pgweb executable in $PATH')
+        # Create working directory
+        home_dir = os.environ.get('HOME') or '/home/jovyan'
+        working_dir = f'{home_dir}/pgweb'
+        if not os.path.exists(working_dir):
+            os.makedirs(working_dir)
+            logger.info("Created directory %s" % working_dir)
+        else:    
+            logger.info("Directory %s already exists" % working_dir)
+        return ['pgweb', '--bind=0.0.0.0', '--listen=' + str(port)]
+    
+    return {
+        'command': _get_pgweb_command,
+        'timeout': 20,
+        'new_browser_tab': True,
+        'launcher_entry': {
+            'title': 'pgweb',
+            'icon_path': _get_icon_path()
+        },
+    }

jupyter_pgweb_proxy/icons/pgweb.svg

@@ -0,0 +1 @@
+jupyter-server-proxy>=1.5.0

requirements.txt

@@ -0,0 +1,33 @@
+import setuptools
+from os import path
+
+
+# read the contents of your README file
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+
+setuptools.setup(
+    name="jupyter-pgweb-proxy",
+    version='0.1.0',
+    url="https://github.com/illumidesk/jupyter-pgweb-proxy",
+    author="IllumiDesk Team",
+    description="[email protected]",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    packages=setuptools.find_packages(),
+	keywords=['jupyter', 'pgweb', 'jupyterhub'],
+	classifiers=['Framework :: Jupyter'],
+    install_requires=[
+        'jupyter-server-proxy>=1.5.0'
+    ],
+    entry_points={
+        'jupyter_serverproxy_servers': [
+            'pgweb = jupyter_pgweb_proxy:setup_pgweb',
+        ]
+    },
+    package_data={
+        'jupyter_pgweb_proxy': ['icons/pgweb.svg'],
+    },
+)