# Notebook server configuration using the Google Cloud SDK
This package provides Python classes that can be used in the Jupyter config file
(e.g. `~/.jupyter/jupyter_lab_config.py`) in order to fill in some configuration
using the Google Cloud SDK's [`gcloud` tool](https://cloud.google.com/sdk/gcloud).
## Included features
This package provides utility methods to look up any configuration options stored
in the active gcloud config, in particular the project and region.
Additionally, this provides a utility method to update a given
[`Config`](https://traitlets.readthedocs.io/en/latest/config-api.html#traitlets.config.Config)
object to connect to a kernel gateway URL managed by Google.
## Prerequisites
Install both Jupyter and [gcloud](https://cloud.google.com/sdk/docs/install).
For the kernel gateway feature, you will need an installation of Jupyter that uses the
`jupyter_server` project and the version of `jupyter_server` you have installed needs to be
at least version `2.4.0`.
You will also need to log in to gcloud:
```sh
gcloud auth login
```
... and configure your project and region:
```sh
gcloud config set core/project ${PROJECT}
gcloud config set compute/region ${REGION}
```
## Install
Clone this repository, and from this directory run the following:
```sh
pip install .
```
## Setup
If you do not already have a Jupyter config file (e.g. `~/.jupyter/jupyter_lab_config.py`),
the first generate one with the following command:
```sh
jupyter lab --generate-config
```
The open your config file and add the following two lines to the end:
```py
import google.cloud.jupyter_config
google.cloud.jupyter_config.configure_gateway_client(c)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/GoogleCloudPlatform/jupyter-extensions/tree/master/google-cloud-jupyter-config",
"name": "google-cloud-jupyter-config",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Google, Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4d/20/6af3cc778d73aaf34804e7df804d417db7a10ce2a51a96813848b9b683ca/google_cloud_jupyter_config-0.0.8.tar.gz",
"platform": null,
"description": "# Notebook server configuration using the Google Cloud SDK\n\nThis package provides Python classes that can be used in the Jupyter config file\n(e.g. `~/.jupyter/jupyter_lab_config.py`) in order to fill in some configuration\nusing the Google Cloud SDK's [`gcloud` tool](https://cloud.google.com/sdk/gcloud).\n\n## Included features\n\nThis package provides utility methods to look up any configuration options stored\nin the active gcloud config, in particular the project and region.\n\nAdditionally, this provides a utility method to update a given\n[`Config`](https://traitlets.readthedocs.io/en/latest/config-api.html#traitlets.config.Config)\nobject to connect to a kernel gateway URL managed by Google.\n\n## Prerequisites\n\nInstall both Jupyter and [gcloud](https://cloud.google.com/sdk/docs/install).\n\nFor the kernel gateway feature, you will need an installation of Jupyter that uses the\n`jupyter_server` project and the version of `jupyter_server` you have installed needs to be\nat least version `2.4.0`.\n\nYou will also need to log in to gcloud:\n\n```sh\ngcloud auth login\n```\n\n... and configure your project and region:\n\n```sh\ngcloud config set core/project ${PROJECT}\ngcloud config set compute/region ${REGION}\n```\n\n## Install\n\nClone this repository, and from this directory run the following:\n\n```sh\npip install .\n```\n\n## Setup\n\nIf you do not already have a Jupyter config file (e.g. `~/.jupyter/jupyter_lab_config.py`),\nthe first generate one with the following command:\n\n```sh\njupyter lab --generate-config\n```\n\nThe open your config file and add the following two lines to the end:\n\n```py\nimport google.cloud.jupyter_config\ngoogle.cloud.jupyter_config.configure_gateway_client(c)\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Jupyter configuration utilities using gcloud",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/GoogleCloudPlatform/jupyter-extensions/tree/master/google-cloud-jupyter-config"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d206af3cc778d73aaf34804e7df804d417db7a10ce2a51a96813848b9b683ca",
"md5": "60e84c8036d98b109c291fedae70418b",
"sha256": "ae377ebedfb5f7486ad33d58bfb1abc70afb3708e55d1e3ca4a551994c81473b"
},
"downloads": -1,
"filename": "google_cloud_jupyter_config-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "60e84c8036d98b109c291fedae70418b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9196,
"upload_time": "2024-05-02T17:08:32",
"upload_time_iso_8601": "2024-05-02T17:08:32.497050Z",
"url": "https://files.pythonhosted.org/packages/4d/20/6af3cc778d73aaf34804e7df804d417db7a10ce2a51a96813848b9b683ca/google_cloud_jupyter_config-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 17:08:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GoogleCloudPlatform",
"github_project": "jupyter-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "google-cloud-jupyter-config"
}
JSON
