Is there any way to setup development environment for jupyterhub on windows?

Hey, I know jupyterhub only runs on linux. But is there any way to setup development environment of jupyterhub who only have windows machine? How others manage development environment of jupyterhub with windows machine?

1 Like

It may depend on what part you are working on contributing to. The docs, for example, should work fine with:

pip install -r docs/requirements.txt

But JupyterHub is not tested or maintained on Windows, so using linux via docker or a VM may be best.

That said, pip install --editable . should still work on Windows (the tests should not be expected to pass). If you are running JupyterHub for testing, you’ll want to pick the dummy authenticator. The simple spawner is not supported on Windows, but I believe folks have contributed patches that make it work. We have a simple testing config file in testing/jupyterhub_config.py which enables these two things.

Alternately, you can run things in a docker image:

# mount your local checkout in `/src/`
docker run -v $PWD:/src -w /src -p 127.0.0.1:8000:8000 quay.io/jupyterhub/jupyterhub

then in the container:

pip install --editable .[test]

and you should be pretty well set.

1 Like

Dear @Kriyanshi_Shah,

My personal recommendation is to use Windows Subsystem for Linux (WSL). Instructions to install it is available at Install WSL | Microsoft Learn.

1 Like