# JupyterLab Kernel Usage
> Advance notice: this extension is being contributed upstream; future versions will be published under [jupyter-server/jupyter-resource-usage](https://github.com/jupyter-server/jupyter-resource-usage).
This is an extension for [JupyterLab](https://github.com/jupyterlab/jupyterlab) to get kernel usage in a sidebar.
This extension is composed of a Python package named `jupyterlab_kernel_usage` for the server extension and a NPM package named `jupyterlab-kernel-usage` for the frontend extension.
## Requirements
This usage is only show for IPython kernels with [ipykernel](https://github.com/ipython/ipykerne) >= 6.11.0.
## Contributing
### Develop
Use the provided `environment.yaml` to install the conda environment.
```base
conda deactivate && \
make env-rm && \
make env
conda activate jupyterlab-kernel-usage
```
```python
# Install the server and frontend in dev mode.
make install-dev
```
```python
# In terminal 1, Start the jupyterlab.
# open http://localhost:8234?token=...
make jlab
```
```python
# In terminal 2, start the extension building in watch mode.
make watch
```
When making changes to the extension you will need to issue a `jupyter labextension build`, or, start `jlpm run watch` in the root of the repository to rebuild on every changes. You do not need to restart or rebuild JupyterLab for changes on the frontend extensions, but do need to restart the server for changes to the Python code.
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab_kernel_usage directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_kernel_usage
# Rebuild extension Typescript source after making changes
jlpm run build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_kernel_usage
pip uninstall jupyterlab_kernel_usage
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyterlab_kernel_usage` within that folder.
## Requirements
* JupyterLab >= 3.0
## Install
To install the extension, execute:
```bash
pip install jupyterlab_kernel_usage
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterlab_kernel_usage
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/quansight/jupyterlab-kernel-usage",
"name": "jupyterlab-kernel-usage",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "Eric Charles",
"author_email": "eric@datalayer.io",
"download_url": "https://files.pythonhosted.org/packages/b0/21/6ddbc74d13ad9ee093f3f0062c6861a2203c34d0f8ef32f8efa32927d889/jupyterlab_kernel_usage-0.6.0.tar.gz",
"platform": "Linux",
"description": "# JupyterLab Kernel Usage\n\n> Advance notice: this extension is being contributed upstream; future versions will be published under [jupyter-server/jupyter-resource-usage](https://github.com/jupyter-server/jupyter-resource-usage).\n\nThis is an extension for [JupyterLab](https://github.com/jupyterlab/jupyterlab) to get kernel usage in a sidebar.\n\n\n\nThis extension is composed of a Python package named `jupyterlab_kernel_usage` for the server extension and a NPM package named `jupyterlab-kernel-usage` for the frontend extension.\n\n## Requirements\n\nThis usage is only show for IPython kernels with [ipykernel](https://github.com/ipython/ipykerne) >= 6.11.0.\n\n## Contributing\n\n### Develop\n\nUse the provided `environment.yaml` to install the conda environment.\n\n```base\nconda deactivate && \\\n make env-rm && \\\n make env\nconda activate jupyterlab-kernel-usage\n```\n\n```python\n# Install the server and frontend in dev mode.\nmake install-dev\n```\n\n```python\n# In terminal 1, Start the jupyterlab.\n# open http://localhost:8234?token=...\nmake jlab\n```\n\n```python\n# In terminal 2, start the extension building in watch mode.\nmake watch\n```\n\nWhen making changes to the extension you will need to issue a `jupyter labextension build`, or, start `jlpm run watch` in the root of the repository to rebuild on every changes. You do not need to restart or rebuild JupyterLab for changes on the frontend extensions, but do need to restart the server for changes to the Python code.\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyterlab_kernel_usage directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable jupyterlab_kernel_usage\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable jupyterlab_kernel_usage\npip uninstall jupyterlab_kernel_usage\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupyterlab_kernel_usage` within that folder.\n\n## Requirements\n\n* JupyterLab >= 3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlab_kernel_usage\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab_kernel_usage\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Get kernel usage",
"version": "0.6.0",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c7c3b0511a54568bae314c1d6bd300ea",
"sha256": "70940d095d5b734b8ee7e269aca3304b91144d1256c09df694471e5e690ee58d"
},
"downloads": -1,
"filename": "jupyterlab_kernel_usage-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7c3b0511a54568bae314c1d6bd300ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 88056,
"upload_time": "2022-12-17T15:31:18",
"upload_time_iso_8601": "2022-12-17T15:31:18.438180Z",
"url": "https://files.pythonhosted.org/packages/99/99/94fc39f39dc34ec0f4a976022a7f11bd4caeafc46a8169ef12d0aec93ab7/jupyterlab_kernel_usage-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "0236603ea709024107894961d27f51af",
"sha256": "1b67026a491ca00849cf5d046f6ff2a91980fee9196cf3104df2bf496399f6b9"
},
"downloads": -1,
"filename": "jupyterlab_kernel_usage-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "0236603ea709024107894961d27f51af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 154957,
"upload_time": "2022-12-17T15:31:20",
"upload_time_iso_8601": "2022-12-17T15:31:20.682017Z",
"url": "https://files.pythonhosted.org/packages/b0/21/6ddbc74d13ad9ee093f3f0062c6861a2203c34d0f8ef32f8efa32927d889/jupyterlab_kernel_usage-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-17 15:31:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "quansight",
"github_project": "jupyterlab-kernel-usage",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyterlab-kernel-usage"
}
JSON
