feat: Update readme, cleanup docker-compose (#4)

Author: jgwerner

README.md

@@ -1,6 +1,6 @@
 # jupyter-pgweb-proxy
 
-This package was built using the [`illumidesk/jupyter-server-proxy` cookiecutter template](https://github.com/illumidesk/cookiecutter-jupyter-server-proxy).
+This package was built from the [`illumidesk/cookiecutter-jupyter-server-proxy`](https://github.com/illumidesk/cookiecutter-jupyter-server-proxy) template.
 
 ## Requirements
 
@@ -10,27 +10,69 @@ This package was built using the [`illumidesk/jupyter-server-proxy` cookiecutter
 
 This package executes the standard `pgweb` command. This command assumes the `pgweb` command is available in the environment's `PATH`.
 
-### Install jupyter-pgweb-proxy
+## What?
 
-Install the package with pip:
+Check it out, [it's pretty sweet](https://github.com/sosedoff/pgweb).
 
-```
-pip install git+https://github.com/illumidesk/jupyter-pgweb-proxy.git
-```
+## Quick Starts
 
-## Example
+### Launch with `binder`
 
-Try with binder:
+This test requires you to have a database instance available as a public endpoint or installed within the notebook container itself.
 
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/illumidesk/jupyter-pgweb-proxy/main?urlpath=pgweb)
 
-Test locally:
+### Run locally with `docker-compose`
 
 ```bash
 docker build -t jupyter/pgweb .
 docker build -it --rm -p 8888:8888 jupyter/pgweb
 ```
 
+1. Open your browser: http://localhost:8889
+1. Click the `pgweb` item from the `New` dropdown in `Jupyter Classic` or click on the green `pgweb` icon in the Notebooks section in `Jupyter Lab`.
+1. Connect with the `Scheme` or `Standard` option.
+
+```
+postgres://postgres:postgres@testdb:5432/db?sslmode=disable
+```
+
+## The Hard Way
+
+### Create and Activate Environment
+
+```bash
+virtualenv -p python3 venv
+source venv/bin/activate
+```
+
+### Install jupyter-pgweb-proxy
+
+```bash
+pip install git+https://github.com/illumidesk/jupyter-pgweb-proxy.git
+```
+
+### Enable jupyter-pgweb-proxy Extensions
+
+1. For Jupyter Classic, activate the `jupyter-server-proxy` extension:
+
+```bash
+jupyter serverextension enable --sys-prefix jupyter_server_proxy
+```
+
+2. For Jupyter Lab, install the `@jupyterlab/server-proxy` extension:
+
+```bash
+jupyter labextension install @jupyterlab/server-proxy
+jupyter lab build
+```
+
+3. Start Jupyter Classic or Jupyter Lab
+
+4. Click on the `pgweb` icon from the Jupyter Lab Launcher or the `pgweb` item from the `New` dropdown in Jupyter Classic.
+
+5. Connect to your database as instructed in the [Quickstart](#quickstart) section.
+
 ## Credits
 
 - [`jupyter-server-proxy`](https://github.com/jupyterhub/jupyter-server-proxy)

dev-requirements.txt

@@ -0,0 +1 @@
+docker-compose

docker-compose.yaml

@@ -0,0 +1,25 @@
+version: "3.8"
+
+services:
+  jupyter:
+    image: jupyter/pgweb
+    build:
+      context: .
+    container_name: notebook
+    restart: always
+    ports:
+      - 8889:8888
+  testdb:
+    image: postgres:12.3-alpine
+    container_name: postgres-labs
+    restart: always
+    environment:
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+    volumes:
+      - db:/var/lib/postgresql/data
+
+volumes:
+  db:
+    name: db

setup.py

@@ -10,17 +10,17 @@
 
 setuptools.setup(
     name="jupyter-pgweb-proxy",
-    version='0.1.0',
+    version='0.1.1',
     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'],
+	keywords=['jupyter', 'pgweb', 'jupyterhub', 'jupyter-server-proxy'],
 	classifiers=['Framework :: Jupyter'],
     install_requires=[
-        'jupyter-server-proxy>=1.5.0'
+        'jupyter-server-proxy>=1.5.0',
     ],
     entry_points={
         'jupyter_serverproxy_servers': [