# jupyter-environment-manager
[](https://docs.qbraid.com/projects/lab/en/latest/lab/environments.html)
[](https://pypi.org/project/jupyter-environment-manager/)
[](https://github.com/qBraid/qBraid-Lab/issues)
[](https://discord.gg/TPBU2sa8Et)
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.
[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qBraid-Lab.git)
## Installation & Setup
For the best experience, use the Environment Manager on [lab.qbraid.com](https://lab.qbraid.com).
Login (or [create an account](https://account.qbraid.com)) and follow instructions in [user guide](https://docs.qbraid.com/projects/lab/en/latest/lab/environments.html) 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:
```shell
pip install jupyter-environment-manager
```
**If your notebook version is < 5.3**, you need to enable the extension manually:
```shell
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
[<img src="https://qbraid-static.s3.amazonaws.com/manage-account.png" width="300" align="right">](https://account.qbraid.com)
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](https://account.qbraid.com/)
2. Copy your API Key token from the left side of your [account page](https://account.qbraid.com/):
3. Save your API key using the [qbraid-cli](https://docs.qbraid.com/projects/cli/en/latest/guide/overview.html):
```bash
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:
```bash
export QBRAID_API_KEY='QBRAID_API_KEY'
```
## Community
- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/qBraid-Lab/issues)
- For discussions, and specific questions about the Environment Manager, qBraid Lab, or
other topics, [join our discord community](https://discord.gg/TPBU2sa8Et)
- Want your open-source project featured as its own runtime environment on qBraid Lab? Fill out our
[New Environment Request Form](https://forms.gle/a4v7Kdn7G7bs9jYD8)
## 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.
[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qBraid.git)
Use the badge in your project's `README.md`:
```markdown
[<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`:
```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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/qBraid/qBraid-Lab",
"name": "jupyter-environment-manager",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "IPython, Jupyter, JupyterLab",
"author": "qBraid Development Team",
"author_email": "contact@qbraid.com",
"download_url": "https://files.pythonhosted.org/packages/2b/47/fe10a51e61ab4892f502eeef7d8e8b7dd03e2cb4e1a41b2a228d205c748f/jupyter_environment_manager-0.2.0.tar.gz",
"platform": "Linux",
"description": "# jupyter-environment-manager\n\n[](https://docs.qbraid.com/projects/lab/en/latest/lab/environments.html)\n[](https://pypi.org/project/jupyter-environment-manager/)\n[](https://github.com/qBraid/qBraid-Lab/issues)\n[](https://discord.gg/TPBU2sa8Et)\n\nJupyterLab extension for managing execution environments, packages, and kernels.\n\nThis extension is composed of a Python package named `jupyter_environment_manager` for the server extension and\nan NPM package named `@qbraid/jupyter-environment-manager` for the frontend extension.\n\n[<img src=\"https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\" width=\"150\">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qBraid-Lab.git)\n\n## Installation & Setup\n\nFor the best experience, use the Environment Manager on [lab.qbraid.com](https://lab.qbraid.com).\nLogin (or [create an account](https://account.qbraid.com)) and follow instructions in [user guide](https://docs.qbraid.com/projects/lab/en/latest/lab/environments.html) to get started.\n\nThe Environment manager requires **Python 3.9 or greater**, and is compatible with **JupyterLab 3.x**.\n\n### Local Install\n\nThe Environment Manager can be installed using pip:\n\n```shell\npip install jupyter-environment-manager\n```\n\n**If your notebook version is < 5.3**, you need to enable the extension manually:\n\n```shell\njupyter serverextension enable --py jupyter_environment_manager --sys-prefix\njupyter nbextension install --py jupyter_environment_manager --sys-prefix\njupyter nbextension enable --py jupyter_environment_manager --sys-prefix\n```\n\n### Local Setup\n\n[<img src=\"https://qbraid-static.s3.amazonaws.com/manage-account.png\" width=\"300\" align=\"right\">](https://account.qbraid.com)\n\nTo use the Environment Manager locally, you must configure your qBraid account credentials:\n\n1. Create a qBraid account or log in to your existing account by visiting [account.qbraid.com](https://account.qbraid.com/)\n2. Copy your API Key token from the left side of your [account page](https://account.qbraid.com/):\n3. Save your API key using the [qbraid-cli](https://docs.qbraid.com/projects/cli/en/latest/guide/overview.html):\n\n```bash\npip install qbraid-cli\nqbraid configure\n```\n\nThe command above stores your credentials locally in a configuration file `~/.qbraid/qbraidrc`,\nwhere `~` corresponds to your home (`$HOME`) directory.\n\nAlternatively, the Environment Manager can discover credentials from environment variables:\n\n```bash\nexport QBRAID_API_KEY='QBRAID_API_KEY'\n```\n\n## Community\n\n- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/qBraid-Lab/issues)\n- For discussions, and specific questions about the Environment Manager, qBraid Lab, or\n other topics, [join our discord community](https://discord.gg/TPBU2sa8Et)\n- Want your open-source project featured as its own runtime environment on qBraid Lab? Fill out our\n [New Environment Request Form](https://forms.gle/a4v7Kdn7G7bs9jYD8)\n\n## Launch on qBraid\n\nThe \"Launch on qBraid\" button (below) can be added to any public GitHub\nrepository. Clicking on it automaically opens qBraid Lab, and performs a\n`git clone` of the project repo into your account's home directory. Copy the\ncode below, and replace `YOUR-USERNAME` and `YOUR-REPOSITORY` with your GitHub\ninfo.\n\n[<img src=\"https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\" width=\"150\">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qBraid.git)\n\nUse the badge in your project's `README.md`:\n\n```markdown\n[<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)\n```\n\nUse the badge in your project's `README.rst`:\n\n```rst\n.. image:: https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\n :target: https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git\n :width: 150px\n```\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "JupyterLab extension for managing execution environments, packages, and kernels.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/qBraid/qBraid-Lab/issues",
"Documentation": "https://docs.qbraid.com/projects/lab/en/latest/lab/environments.html",
"Homepage": "https://github.com/qBraid/qBraid-Lab"
},
"split_keywords": [
"ipython",
" jupyter",
" jupyterlab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10018444a0e44012f8c71b55156cecf5399ba76a755ceca07c79199876b04ced",
"md5": "b90c40977a0336a537df2a7a5083317e",
"sha256": "9f111609de422b8d7cfb40b248a7e4e13c31a0f525b39fa03a93b82368cbedfc"
},
"downloads": -1,
"filename": "jupyter_environment_manager-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b90c40977a0336a537df2a7a5083317e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2363492,
"upload_time": "2024-04-24T01:28:01",
"upload_time_iso_8601": "2024-04-24T01:28:01.411475Z",
"url": "https://files.pythonhosted.org/packages/10/01/8444a0e44012f8c71b55156cecf5399ba76a755ceca07c79199876b04ced/jupyter_environment_manager-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b47fe10a51e61ab4892f502eeef7d8e8b7dd03e2cb4e1a41b2a228d205c748f",
"md5": "31071fb6b85ed686be98d35b8dac7915",
"sha256": "b205fb818fa01f463b0361b74e727ccd7137b6bc1ca5f772a4e35af95523dc5d"
},
"downloads": -1,
"filename": "jupyter_environment_manager-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "31071fb6b85ed686be98d35b8dac7915",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1451647,
"upload_time": "2024-04-24T01:28:03",
"upload_time_iso_8601": "2024-04-24T01:28:03.345565Z",
"url": "https://files.pythonhosted.org/packages/2b/47/fe10a51e61ab4892f502eeef7d8e8b7dd03e2cb4e1a41b2a228d205c748f/jupyter_environment_manager-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 01:28:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qBraid",
"github_project": "qBraid-Lab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-environment-manager"
}
JSON
