This package was built from the illumidesk/cookiecutter-jupyter-server-proxy
template.
- 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
.
Check it out, it's pretty sweet.
This test requires you to have a database instance available as a public endpoint or installed within the notebook container itself.
make dev
- Open your browser: http://localhost:8889
- Click the
pgweb
item from theNew
dropdown inJupyter Classic
or click on the greenpgweb
icon in the Notebooks section inJupyter Lab
. - Connect with the
Scheme
orStandard
option.
For example, with the Scheme
option the string would look like so:
postgres://postgres:postgres@testdb:5432/postgres?sslmode=disable
Stop services:
make dev-down
Remove images and running containers:
NOTE: this will stop all running containers on the local, including those with the exit status.
make clean-all
virtualenv -p python3 venv
source venv/bin/activate
pip install git+https://github.com/illumidesk/jupyter-pgweb-proxy.git
- For Jupyter Classic, activate the
jupyter-server-proxy
extension:
jupyter serverextension enable --sys-prefix jupyter_server_proxy
- For Jupyter Lab, install the
@jupyterlab/server-proxy
extension:
jupyter labextension install @jupyterlab/server-proxy
jupyter lab build
-
Start Jupyter Classic or Jupyter Lab
-
Click on the
pgweb
icon from the Jupyter Lab Launcher or thepgweb
item from theNew
dropdown in Jupyter Classic. -
Connect to your database as instructed in the Quickstart section.
BSD 3-Clause