Jupyter Deploy
Jupyter deploy is an open-source command line interface tool (CLI) to deploy and manage interactive applications such as JupyterLab to the Cloud.
The CLI is vendor-neutral, but it provides a default template that uses terraform as the infrastructure-as-code engine and AWS as the cloud provider.
Documentation: jupyter-deploy.readthedocs.io
Getting started with the default template
We recommend using uv to set up your Python virtual environment.
Install the CLI and the default template:
uv init . --bare
uv venv
source .venv/bin/activate
uv add "jupyter-deploy[aws,proxy]"
uv add jupyter-deploy-tf-aws-ec2-jupyterlab
Create a project directory and let the CLI scaffold it:
mkdir my-first-deployment && cd my-first-deployment
jd init .
At this point, you need valid AWS credentials, plus terraform, the AWS CLI and jq installed locally.
The CLI checks for these tools and points you to the installation instructions for anything missing.
Deploy your app to AWS and start working:
jd config
jd up
jd open
jd open starts a local proxy that connects your browser to your own JupyterLab app
running on a dedicated EC2 instance in your AWS account.
The default template supports temporarily turning off your instance to reduce your cloud bill.
jd host stop
# To restart it later
jd host start
# You may also need to start the containers that run your application
jd server start
To delete all the resources, run:
jd down
Templates
The jupyter-deploy CLI interacts with templates: infrastructure-as-code packages
that you can use to create your own project and deploy resources in your own cloud provider account.
Templates are nominally Python packages distributed on PyPI. You can install and manage templates in your virtual
environment with pip or uv. jupyter-deploy automatically finds the templates installed in your Python environment.
The default template is jupyter-deploy-tf-aws-ec2-jupyterlab: a single-user JupyterLab on an EC2 instance, reached through the local client proxy over pinned self-signed TLS and authorized by your AWS identity.
Other templates are available, such as:
- jupyter-deploy-tf-aws-ec2-base for a multi-user JupyterLab served on your own domain
- jupyter-deploy-tf-aws-eks-oidc for multi-tenant workspaces on an EKS cluster
Installation
Consider creating or activating a virtual environment.
From your uv environment:
uv add jupyter-deploy
Or with pip:
pip install jupyter-deploy
The CLI is cloud-provider agnostic, so cloud dependencies come as optional extras:
aws: required by every AWS templatek8s: required by Kubernetes templates such asjupyter-deploy-tf-aws-eks-oidcproxy: installs the local client proxy thatjd openandjd proxyuse to reach your deployment
Pick the extras that your template requires, for example "jupyter-deploy[aws,proxy]" for the
default template. Each template's PyPI page lists its install command and prerequisites.
Entry points
From a terminal, run:
jupyter-deploy --help
# or use the alias
jd --help
# or use the jupyter CLI
jupyter deploy --help
License
The jupyter-deploy CLI is licensed under the MIT License.
4 maintainers
Metadata
4 maintainers
Release files for jupyter-deploy 0.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| jupyter_deploy-0.8.1.tar.gz | 525.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jupyter_deploy-0.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 870.7 kB
Release files / jupyter_deploy-0.8.1.tar.gz
| Download URL | jupyter_deploy-0.8.1.tar.gz |
|---|---|
| Size | 525.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4ad0e8cf0545918e46b60538c1b4b3ece76f705f97f6109d23245f6794c7d0f0
|
|
BLAKE2b-256 checksum How to use checksums |
0d655d950e7167b20a6055b7e1eb05610deb79003046ddbb73acb5f086180363
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / jupyter_deploy-0.8.1-py3-none-any.whl
| Download URL | jupyter_deploy-0.8.1-py3-none-any.whl |
|---|---|
| Size | 345.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3957c4d48a68d0659cb4a36ca890efd789df730401cc8e5f3263d0e1f9c9e582
|
|
BLAKE2b-256 checksum How to use checksums |
62fb30044691189466e6cf0fc57363a4c32d210229469b78172a49305ce85dd5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for jupyter-deploy 0.8.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
