JupyterLab extension for managing execution environments, packages, and kernels.
Project description
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:
- Create a qBraid account or log in to your existing account by visiting account.qbraid.com
- Copy your API Key token from the left side of your account page:
- 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyter_environment_manager-0.2.0rc6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0897ae4dd1dbae4c157cd6009d20b0946a359f4936ccedf08d867b09ccc172e9 |
|
MD5 | 4112da4279dc84a1101d8be4e0b0d312 |
|
BLAKE2b-256 | 878a57020c48f4f59b0c33409f527fc037b0ffa43735fdbcde4ed85295706cbc |
Hashes for jupyter_environment_manager-0.2.0rc6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8446d552675b9019987aacde51ba8303bd7f1605dea8b210b6564a1e4e1bc83 |
|
MD5 | 5943e372675ad803dd7c99f55ad15377 |
|
BLAKE2b-256 | 316d376858a338db8d24840987c7951fe21761e43af372cdf72692a61227ab56 |