Name | jupyter-environment-manager JSON |
Version |
0.3.0
JSON |
| download |
home_page | None |
Summary | JupyterLab extension for managing execution environments, packages, and kernels. |
upload_time | 2024-10-15 21:29:46 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | Proprietary |
keywords |
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# jupyter-environment-manager
[](https://docs.qbraid.com/lab/user-guide/environments)
[](https://pypi.org/project/jupyter-environment-manager/)
[](https://github.com/qBraid/community/issues)
[](https://stackoverflow.com/questions/tagged/qbraid)
[](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/community.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/lab/user-guide/environments) to get started.
The Environment manager requires **Python 3.9 or greater**, and is compatible with **JupyterLab 4.x**.
### Local Install
The Environment Manager can be installed using pip:
```shell
pip install jupyter-environment-manager
```
### 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](https://account.qbraid.com/)
2. Copy your API Key token from the left side of your account page (see [docs](https://docs.qbraid.com/home/account)).
3. Save your API key using the [qbraid-cli](https://docs.qbraid.com/cli/api-reference/qbraid_configure):
```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'
```
> See also: [qBraid API Keys](https://docs.qbraid.com/home/account#api-keys), [Local configuration](https://docs.qbraid.com/cli/user-guide/overview#local-configuration)
## Community
- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/community/issues)
- For discussions, and specific questions about the Environment Manager, qBraid Lab, or
other topics, [join our discord community](https://discord.gg/TPBU2sa8Et)
- For questions that are more suited for a forum, post to [StackOverflow](https://stackoverflow.com/questions/tagged/qbraid) with the `qbraid` tag.
## Launch on qBraid
The "Launch on qBraid" button (top) 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`:
```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": null,
"name": "jupyter-environment-manager",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "qBraid Development Team <contact@qbraid.com>",
"download_url": "https://files.pythonhosted.org/packages/17/ca/28b30d09ddb4b56cfa5c2e390014c9a505b733e181edf1431db6b9e1fa65/jupyter_environment_manager-0.3.0.tar.gz",
"platform": null,
"description": "# jupyter-environment-manager\n\n[](https://docs.qbraid.com/lab/user-guide/environments)\n[](https://pypi.org/project/jupyter-environment-manager/)\n[](https://github.com/qBraid/community/issues)\n[](https://stackoverflow.com/questions/tagged/qbraid)\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/community.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/lab/user-guide/environments) to get started.\n\nThe Environment manager requires **Python 3.9 or greater**, and is compatible with **JupyterLab 4.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### Local Setup\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 (see [docs](https://docs.qbraid.com/home/account)).\n3. Save your API key using the [qbraid-cli](https://docs.qbraid.com/cli/api-reference/qbraid_configure):\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> See also: [qBraid API Keys](https://docs.qbraid.com/home/account#api-keys), [Local configuration](https://docs.qbraid.com/cli/user-guide/overview#local-configuration)\n\n## Community\n\n- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/community/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- For questions that are more suited for a forum, post to [StackOverflow](https://stackoverflow.com/questions/tagged/qbraid) with the `qbraid` tag.\n\n## Launch on qBraid\n\nThe \"Launch on qBraid\" button (top) 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\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.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/qBraid/community/issues",
"Homepage": "https://docs.qbraid.com/lab/user-guide/environments",
"Repository": "https://github.com/qBraid/lab-environment-manager.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f69e59693ff8126b78ae1718abe880a7ebffd3fa9a7074fd7ee50788743cecd8",
"md5": "9caae86966a328c9f1ba1320cfefa721",
"sha256": "60085a4be895b3b452dd458101b69bcb68404e470bf3754542436c4ad194aa17"
},
"downloads": -1,
"filename": "jupyter_environment_manager-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9caae86966a328c9f1ba1320cfefa721",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1291343,
"upload_time": "2024-10-15T21:29:44",
"upload_time_iso_8601": "2024-10-15T21:29:44.771438Z",
"url": "https://files.pythonhosted.org/packages/f6/9e/59693ff8126b78ae1718abe880a7ebffd3fa9a7074fd7ee50788743cecd8/jupyter_environment_manager-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17ca28b30d09ddb4b56cfa5c2e390014c9a505b733e181edf1431db6b9e1fa65",
"md5": "69c669185a5ae784a789119cc57a89b6",
"sha256": "9a300c172d05c3b73817b8ce95e111654c05b3af234370e04036549020f936bb"
},
"downloads": -1,
"filename": "jupyter_environment_manager-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "69c669185a5ae784a789119cc57a89b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1642118,
"upload_time": "2024-10-15T21:29:46",
"upload_time_iso_8601": "2024-10-15T21:29:46.779020Z",
"url": "https://files.pythonhosted.org/packages/17/ca/28b30d09ddb4b56cfa5c2e390014c9a505b733e181edf1431db6b9e1fa65/jupyter_environment_manager-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 21:29:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qBraid",
"github_project": "community",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyter-environment-manager"
}