Add pre-commit

Author: manics

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# pre-commit is a tool to perform a predefined set of tasks manually and/or
+# automatically before git commits are made.
+#
+# Config reference: https://pre-commit.com/#pre-commit-configyaml---top-level
+#
+# Common tasks
+#
+# - Run on all files:   pre-commit run --all-files
+# - Register git hooks: pre-commit install --install-hooks
+#
+repos:
+  # Autoformat: Python code
+  - repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+      - id: black
+        args:
+          - --target-version=py38
+          - --target-version=py39
+          - --target-version=py310
+
+  # Autoformat: markdown, yaml
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+      - id: prettier

README.md

@@ -12,47 +12,45 @@
 **jupyterhub-deploy-docker** provides a reference
 deployment of [JupyterHub](https://github.com/jupyter/jupyterhub), a
 multi-user [Jupyter Notebook](http://jupyter.org/) environment, on a
-**single host** using [Docker](https://docs.docker.com).  
+**single host** using [Docker](https://docs.docker.com).
 
 Possible **use cases** include:
 
-* Creating a JupyterHub demo environment that you can spin up relatively
+- Creating a JupyterHub demo environment that you can spin up relatively
   quickly.
-* Providing a multi-user Jupyter Notebook environment for small classes,
+- Providing a multi-user Jupyter Notebook environment for small classes,
   teams, or departments.
 
 ## Disclaimer
 
-This deployment is **NOT** intended for a production environment. 
-It is a reference implementation that does not meet traditional 
-requirements in terms of availability nor scalability. 
+This deployment is **NOT** intended for a production environment.
+It is a reference implementation that does not meet traditional
+requirements in terms of availability nor scalability.
 
 If you are looking for a more robust solution to host JupyterHub, or
 you require scaling beyond a single host, please check out the
 excellent [zero-to-jupyterhub-k8s](https://github.com/jupyterhub/zero-to-jupyterhub-k8s)
 project.
 
-
 ## Technical Overview
 
 Key components of this reference deployment are:
 
-* **Host**: Runs the [JupyterHub components](https://jupyterhub.readthedocs.org/en/latest/getting-started.html#overview)
+- **Host**: Runs the [JupyterHub components](https://jupyterhub.readthedocs.org/en/latest/getting-started.html#overview)
   in a Docker container on the host.
 
-* **Authenticator**: Uses [Native Authenticator](https://github.com/jupyterhub/nativeauthenticator) to authenticate users.
+- **Authenticator**: Uses [Native Authenticator](https://github.com/jupyterhub/nativeauthenticator) to authenticate users.
 
-* **Spawner**:Uses [DockerSpawner](https://github.com/jupyter/dockerspawner)
+- **Spawner**:Uses [DockerSpawner](https://github.com/jupyter/dockerspawner)
   to spawn single-user Jupyter Notebook servers in separate Docker
   containers on the same host.
 
-* **Persistence of Hub data**: Persists JupyterHub data in a Docker
+- **Persistence of Hub data**: Persists JupyterHub data in a Docker
   volume on the host.
 
-* **Persistence of user notebook directories**: Persists user notebook
+- **Persistence of user notebook directories**: Persists user notebook
   directories in Docker volumes on the host.
 
-
 ## Prerequisites
 
 ### Docker
@@ -62,7 +60,6 @@ This deployment uses Docker, via [Docker Compose](https://docs.docker.com/compos
 1. Use [Docker's installation instructions](https://docs.docker.com/engine/installation/)
    to set up Docker for your environment.
 
-
 ## Authenticator setup
 
 This deployment uses [JupyterHub Native Authenticator](https://native-authenticator.readthedocs.io/en/latest/) to authenticate users.
@@ -79,7 +76,6 @@ This deployment uses [JupyterHub Native Authenticator](https://native-authentica
    docker-compose build
    ```
 
-
 ## Customisation: Jupyter Notebook Image
 
 You can configure JupyterHub to spawn Notebook servers from any Docker image, as
@@ -90,12 +86,12 @@ To specify which Notebook image to spawn for users, you set the value of the
 `DOCKER_NOTEBOOK_IMAGE` environment variable to the desired container image.
 
 Whether you build a custom Notebook image or pull an image from a public or
-private Docker registry, the image must reside on the host.  
+private Docker registry, the image must reside on the host.
 
 If the Notebook image does not exist on host, Docker will attempt to pull the
-image the first time a user attempts to start his or her server.  In such cases,
+image the first time a user attempts to start his or her server. In such cases,
 JupyterHub may timeout if the image being pulled is large, so it is better to
-pull the image to the host before running JupyterHub.  
+pull the image to the host before running JupyterHub.
 
 This deployment defaults to the
 [jupyter/minimal-notebook](https://hub.docker.com/r/jupyter/minimal-notebook/)
@@ -136,7 +132,7 @@ docker-compose down
 
 ### How can I view the logs for JupyterHub or users' Notebook servers?
 
-Use `docker logs <container>`.  For example, to view the logs of the `jupyterhub` container
+Use `docker logs <container>`. For example, to view the logs of the `jupyterhub` container
 
 ```bash
 docker logs jupyterhub
@@ -175,7 +171,7 @@ kernels.
 
 ### How can I backup a user's notebook directory?
 
-There are multiple ways to [backup and restore](https://docs.docker.com/engine/userguide/containers/dockervolumes/#backup-restore-or-migrate-data-volumes) data in Docker containers.  
+There are multiple ways to [backup and restore](https://docs.docker.com/engine/userguide/containers/dockervolumes/#backup-restore-or-migrate-data-volumes) data in Docker containers.
 
 Suppose you have the following running containers:
 
@@ -195,7 +191,7 @@ In this deployment, the user's notebook directories (`/home/jovyan/work`) are ba
     [{jtyberg /var/lib/docker/volumes/jtyberg/_data /home/jovyan/work local rw true rprivate}]
 ```
 
-We can backup the user's notebook directory by running a separate container that mounts the user's volume and creates a tarball of the directory.  
+We can backup the user's notebook directory by running a separate container that mounts the user's volume and creates a tarball of the directory.
 
 ```bash
 docker run --rm \

jupyterhub_config.py

@@ -11,34 +11,34 @@
 # configuration parameter.
 
 # Spawn single-user servers as Docker containers
-c.JupyterHub.spawner_class = 'dockerspawner.DockerSpawner'
+c.JupyterHub.spawner_class = "dockerspawner.DockerSpawner"
 
 # Spawn containers from this image
-c.DockerSpawner.image = os.environ['DOCKER_NOTEBOOK_IMAGE']
+c.DockerSpawner.image = os.environ["DOCKER_NOTEBOOK_IMAGE"]
 
 # JupyterHub requires a single-user instance of the Notebook server, so we
 # default to using the `start-singleuser.sh` script included in the
 # jupyter/docker-stacks *-notebook images as the Docker run command when
 # spawning containers.  Optionally, you can override the Docker run command
 # using the DOCKER_SPAWN_CMD environment variable.
-spawn_cmd = os.environ.get('DOCKER_SPAWN_CMD', "start-singleuser.sh")
+spawn_cmd = os.environ.get("DOCKER_SPAWN_CMD", "start-singleuser.sh")
 c.DockerSpawner.cmd = spawn_cmd
 
 # Connect containers to this Docker network
-network_name = os.environ['DOCKER_NETWORK_NAME']
+network_name = os.environ["DOCKER_NETWORK_NAME"]
 c.DockerSpawner.use_internal_ip = True
 c.DockerSpawner.network_name = network_name
 
 # Explicitly set notebook directory because we'll be mounting a volume to it.
 # Most jupyter/docker-stacks *-notebook images run the Notebook server as
 # user `jovyan`, and set the notebook directory to `/home/jovyan/work`.
 # We follow the same convention.
-notebook_dir = os.environ.get('DOCKER_NOTEBOOK_DIR') or '/home/jovyan/work'
+notebook_dir = os.environ.get("DOCKER_NOTEBOOK_DIR") or "/home/jovyan/work"
 c.DockerSpawner.notebook_dir = notebook_dir
 
 # Mount the real user's Docker volume on the host to the notebook user's
 # notebook directory in the container
-c.DockerSpawner.volumes = { 'jupyterhub-user-{username}': notebook_dir }
+c.DockerSpawner.volumes = {"jupyterhub-user-{username}": notebook_dir}
 
 # Remove containers once they are stopped
 c.DockerSpawner.remove = True
@@ -47,17 +47,17 @@
 c.DockerSpawner.debug = True
 
 # User containers will access hub by container name on the Docker network
-c.JupyterHub.hub_ip = 'jupyterhub'
+c.JupyterHub.hub_ip = "jupyterhub"
 c.JupyterHub.hub_port = 8080
 
 # Persist hub data on volume mounted inside container
-c.JupyterHub.cookie_secret_file = '/data/jupyterhub_cookie_secret'
+c.JupyterHub.cookie_secret_file = "/data/jupyterhub_cookie_secret"
 c.JupyterHub.db_url = "sqlite:////data/jupyterhub.sqlite"
 
 # Authenticate users with Native Authenticator
-c.JupyterHub.authenticator_class = 'nativeauthenticator.NativeAuthenticator'
+c.JupyterHub.authenticator_class = "nativeauthenticator.NativeAuthenticator"
 
 # Allowed admins
-admin = os.environ.get('JUPYTERHUB_ADMIN')
+admin = os.environ.get("JUPYTERHUB_ADMIN")
 if admin:
     c.Authenticator.admin_users = [admin]