Contributing

Welcome! As a Jupyter project, we follow the Jupyter contributor guide.

Setting up a local development environment

We ship a jupyterhub_config.py file that helps you test tmpauthenticator locally.

Clone this repository

git clone https://github.com/jupyterhub/tmpauthenticator.git

Setup a virtual environment. After cloning the repository, you should set up an isolated environment to install libraries required for running / developing kubespawner.

There are many ways of doing this: conda envs, virtualenv, pipenv, etc. Pick your favourite. We show you how to use venv:
```
cd tmpauthenticator

python3 -m venv .
source bin/activate
```
Install a locally editable version of tmpauthenticator and its dependencies for running it and testing it.
```
pip install -e .
```
Install the nodejs based Configurable HTTP Proxy (CHP), and make it accessible to JupyterHub.
```
npm install configurable-http-proxy
export PATH=$(pwd)/node_modules/.bin:$PATH
```

Start JupyterHub

# Run this from the tmpauthenticator repo's root directory where the preconfigured
# jupyterhub_config.py file resides!
jupyterhub