jupyter-environment-manager 0.2.0

JupyterLab extension for managing execution environments, packages, and kernels.

jupyter-environment-manager

JupyterLab extension for managing execution environments, packages, and kernels.

This extension is composed of a Python package named jupyter_environment_manager for the server extension and an NPM package named @qbraid/jupyter-environment-manager for the frontend extension.

Installation & Setup

For the best experience, use the Environment Manager on lab.qbraid.com. Login (or create an account) and follow instructions in user guide to get started.

The Environment manager requires Python 3.9 or greater, and is compatible with JupyterLab 3.x.

Local Install

The Environment Manager can be installed using pip:

pip install jupyter-environment-manager

If your notebook version is < 5.3, you need to enable the extension manually:

jupyter serverextension enable --py jupyter_environment_manager --sys-prefix
jupyter nbextension install --py jupyter_environment_manager --sys-prefix
jupyter nbextension enable --py jupyter_environment_manager --sys-prefix

Local Setup

To use the Environment Manager locally, you must configure your qBraid account credentials:

1. Create a qBraid account or log in to your existing account by visiting account.qbraid.com
2. Copy your API Key token from the left side of your account page:
3. Save your API key using the qbraid-cli:

pip install qbraid-cli
qbraid configure

The command above stores your credentials locally in a configuration file ~/.qbraid/qbraidrc, where ~ corresponds to your home ($HOME) directory.

Alternatively, the Environment Manager can discover credentials from environment variables:

export QBRAID_API_KEY='QBRAID_API_KEY'

Community

• For feature requests and bug reports: Submit an issue
• For discussions, and specific questions about the Environment Manager, qBraid Lab, or other topics, join our discord community
• Want your open-source project featured as its own runtime environment on qBraid Lab? Fill out our New Environment Request Form

Launch on qBraid

The "Launch on qBraid" button (below) can be added to any public GitHub repository. Clicking on it automaically opens qBraid Lab, and performs a git clone of the project repo into your account's home directory. Copy the code below, and replace YOUR-USERNAME and YOUR-REPOSITORY with your GitHub info.

Use the badge in your project's README.md:

[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git)

Use the badge in your project's README.rst:

.. image:: https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png
    :target: https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
    :width: 150px