# bodo_jupyterlab
A JupyterLab extension for use on the Bodo Cloud Platform.
The extension has two components: a frontend component (see files in `src`) and a server component (see files in `bodo_jupyterlab`).
## Requirements
- JupyterLab >= 3.0
## Install
To install the extension, execute:
```bash
pip install bodo_jupyterlab
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall bodo_jupyterlab
```
## Contributing
### 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.
You also need to first install our fork of remote-ikernel: https://github.com/Bodo-inc/remote_ikernel
```bash
sudo chown bodo:bodo -R /opt
# Make sure you have nodejs installed.
# If you don't have mamba installed: conda install -c conda-forge mamba.
mamba install -c conda-forge nodejs=16.12
# Clone the repo to your local environment
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
# Enable it
jupyter server extension enable bodo_jupyterlab
jupyter lab extension enable bodo_jupyterlab
```
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
pip uninstall bodo_jupyterlab
```
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 `bodo-jupyterlab` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/Bodo-inc/jupyterlab-extensions",
"name": "bodo-jupyterlab",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3,Bodo",
"author": "Bodo, Inc.",
"author_email": "noreply@bodo.ai",
"download_url": "https://files.pythonhosted.org/packages/36/6f/a126b1d6acd0103bea312217cdf85d809bf4234ac15688b64602a10dfbc2/bodo_jupyterlab-1.18.2.tar.gz",
"platform": "Linux",
"description": "# bodo_jupyterlab\n\n\n\nA JupyterLab extension for use on the Bodo Cloud Platform.\n\nThe extension has two components: a frontend component (see files in `src`) and a server component (see files in `bodo_jupyterlab`).\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install bodo_jupyterlab\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall bodo_jupyterlab\n```\n\n## Contributing\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\nYou also need to first install our fork of remote-ikernel: https://github.com/Bodo-inc/remote_ikernel\n\n```bash\nsudo chown bodo:bodo -R /opt\n# Make sure you have nodejs installed.\n# If you don't have mamba installed: conda install -c conda-forge mamba.\nmamba install -c conda-forge nodejs=16.12\n# Clone the repo to your local environment\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm run build\n# Enable it\njupyter server extension enable bodo_jupyterlab\njupyter lab extension enable bodo_jupyterlab\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\npip uninstall bodo_jupyterlab\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 `bodo-jupyterlab` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A JupyterLab extension.",
"version": "1.18.2",
"project_urls": {
"Homepage": "https://github.com/Bodo-inc/jupyterlab-extensions"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3",
"bodo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e322803bb58cc1aaf1d78f22ab5328be0056ed23d03214a704c29f11dfc210b5",
"md5": "1585845aa97a23b01d7ca0904ea106c0",
"sha256": "3cf4f7b4abb23f644742192882dc9c31d1899a722084b5979e82f38d29a5a620"
},
"downloads": -1,
"filename": "bodo_jupyterlab-1.18.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1585845aa97a23b01d7ca0904ea106c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 373575,
"upload_time": "2023-11-16T11:53:05",
"upload_time_iso_8601": "2023-11-16T11:53:05.063670Z",
"url": "https://files.pythonhosted.org/packages/e3/22/803bb58cc1aaf1d78f22ab5328be0056ed23d03214a704c29f11dfc210b5/bodo_jupyterlab-1.18.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "366fa126b1d6acd0103bea312217cdf85d809bf4234ac15688b64602a10dfbc2",
"md5": "0d516f84a5d80fc9d45684146a338bfb",
"sha256": "ea5f624f93e24bc104cc8f0f6c972b27a7c6bad43d96eb28be3a7bd5e241ad3d"
},
"downloads": -1,
"filename": "bodo_jupyterlab-1.18.2.tar.gz",
"has_sig": false,
"md5_digest": "0d516f84a5d80fc9d45684146a338bfb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 318850,
"upload_time": "2023-11-16T11:53:06",
"upload_time_iso_8601": "2023-11-16T11:53:06.757133Z",
"url": "https://files.pythonhosted.org/packages/36/6f/a126b1d6acd0103bea312217cdf85d809bf4234ac15688b64602a10dfbc2/bodo_jupyterlab-1.18.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 11:53:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Bodo-inc",
"github_project": "jupyterlab-extensions",
"github_not_found": true,
"lcname": "bodo-jupyterlab"
}
JSON
