| Name | junity JSON |
| Version |
0.7.8
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension for Unity Catalog |
| upload_time | 2024-12-05 17:24:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Daniel Tom All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/dan1elt0m/junity/actions/workflows/build.yml)
A OSS Unity Catalog extension for Jupyter Lab. This extension allows you to browse and manage the Unity Catalog.
## Features
- Browse and manage the Unity Catalog in JupyterLab
- SidePanel Catalog Tree with option to insert names into code cells
- Preview table data
- Oauth with Google and token based authentication
- Easy configuration with JupyterLab settings editor
- Docker example with JupyterLab, Unity Catalog and DuckDB
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install junity
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall junity
```
Or use the [JupyterLab extension manager](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#).
## Configuration
For configuration, you can use the JupyterLab settings editor or set Environmental variables.
Possible editor / env settings are:
- `hostUrl / JY_HOST_URL`: The URL of the Unity Catalog server. Default is `http://localhost:8080`.
- `accessToken / JY_ACCESS_TOKEN`: The token to authenticate with the Unity Catalog server. Default is `None`.
- `googleAuthEnabled / JY_GOOGLE_AUTH_ENABLED`: Enable or disable authentication. Default is `False`. If enabled, the `googleClientId` setting is required. In addition, the UC server must be configured to accept Google authentication and user must exist in the UC server.
- `googleClientId / JY_GOOGLE_CLIENT_ID`: The Google client ID for authentication. Default is `None`.
These settings can be configured partially in editor and partially in env variables. The env variables overwrite
editor settings. Env vars are only processed on startup, but editor settings can be changed at runtime.
Specific settings for data preview:
- `JY_AWS_REGION`: Required if data is stored on AWS. Default is `eu-west-1`
- `JY_DOCKER_HOST`: Required if both JupyterLab and Unity Catalog are running in Docker.
## Example
To run the example, navigate to the `/docker` directory and execute the following command:
```bash
docker compose up --build -d
```
After starting the Docker containers, you can access the Jupyter notebooks at http://localhost:8888/lab?token=junity.
The example notebook demonstrates how to use Junity, and DuckDB with Unity Catalog for data management and querying.
You can reach the Unity Catalog at http://localhost:8080/api/2.1/unity-catalog.
## Debugging
You can watch the Jupyter lab console output for logs/errors.
Possible errors:
- `Failed to fetch`: The server is not reachable. Check the `hostUrl` setting.
- `Authentication failed`: The authentication failed. Check the `accessToken` or `googleAuth` settings. Try logging in again.
- `Invalid token`: The token is invalid. Tokens are valid for 1 hour. You can get a new token by logging in again.
- `Cross Origin Request Blocked`: The UC server does not allow traffic from the JupyterLab server.
Add the JupyterLab server to the CORS settings in the UC server.
````bash
## Docker Example
In the `docker` folder, you can find an example of how to run JupyterLab and Unity Catalog in Docker containers.
To run the example, execute:
```bash
docker compose up --build -d
````
This will start JupyterLab on `http://localhost:8888` and Unity Catalog on `http://localhost:8080/api/2.1/unity-catalog`.
You can access the example notebook by opening this URL in your browser: `http://localhost:8888/lab?token=junity/tree/example.ipynb`
## 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.
```bash
# Clone the repo to your local environment
# Change directory to the junity directory
# 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 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 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 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 junity
```
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 `junity` within that folder.
### Testing the extension
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
## Linting and prettier
```sh
jlpm lint
jlpm prettier
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
#### Remarks
Also checkout my other library [dunky](https://github.com/dan1elt0m/dunky) for a matching jupyter kernel
Raw data
{
"_id": null,
"home_page": null,
"name": "junity",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Daniel Tom <d.e.tom89@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5e/cb/cdd44e7e1a01ff9ea26eac81b3c6665ad391f566bb4e88f1820c12f3d92e/junity-0.7.8.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/dan1elt0m/junity/actions/workflows/build.yml)\n\nA OSS Unity Catalog extension for Jupyter Lab. This extension allows you to browse and manage the Unity Catalog.\n\n\n\n## Features\n\n- Browse and manage the Unity Catalog in JupyterLab\n- SidePanel Catalog Tree with option to insert names into code cells\n- Preview table data\n- Oauth with Google and token based authentication\n- Easy configuration with JupyterLab settings editor\n- Docker example with JupyterLab, Unity Catalog and DuckDB\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install junity\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall junity\n```\n\nOr use the [JupyterLab extension manager](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#).\n\n## Configuration\n\nFor configuration, you can use the JupyterLab settings editor or set Environmental variables.\n\nPossible editor / env settings are:\n\n- `hostUrl / JY_HOST_URL`: The URL of the Unity Catalog server. Default is `http://localhost:8080`.\n- `accessToken / JY_ACCESS_TOKEN`: The token to authenticate with the Unity Catalog server. Default is `None`.\n- `googleAuthEnabled / JY_GOOGLE_AUTH_ENABLED`: Enable or disable authentication. Default is `False`. If enabled, the `googleClientId` setting is required. In addition, the UC server must be configured to accept Google authentication and user must exist in the UC server.\n- `googleClientId / JY_GOOGLE_CLIENT_ID`: The Google client ID for authentication. Default is `None`.\n\nThese settings can be configured partially in editor and partially in env variables. The env variables overwrite\neditor settings. Env vars are only processed on startup, but editor settings can be changed at runtime.\n\nSpecific settings for data preview:\n\n- `JY_AWS_REGION`: Required if data is stored on AWS. Default is `eu-west-1`\n- `JY_DOCKER_HOST`: Required if both JupyterLab and Unity Catalog are running in Docker.\n\n## Example\n\nTo run the example, navigate to the `/docker` directory and execute the following command:\n\n```bash\ndocker compose up --build -d\n```\n\nAfter starting the Docker containers, you can access the Jupyter notebooks at http://localhost:8888/lab?token=junity.\nThe example notebook demonstrates how to use Junity, and DuckDB with Unity Catalog for data management and querying.\n\nYou can reach the Unity Catalog at http://localhost:8080/api/2.1/unity-catalog.\n\n## Debugging\n\nYou can watch the Jupyter lab console output for logs/errors.\nPossible errors:\n\n- `Failed to fetch`: The server is not reachable. Check the `hostUrl` setting.\n- `Authentication failed`: The authentication failed. Check the `accessToken` or `googleAuth` settings. Try logging in again.\n- `Invalid token`: The token is invalid. Tokens are valid for 1 hour. You can get a new token by logging in again.\n- `Cross Origin Request Blocked`: The UC server does not allow traffic from the JupyterLab server.\n Add the JupyterLab server to the CORS settings in the UC server.\n\n````bash\n\n\n## Docker Example\n\nIn the `docker` folder, you can find an example of how to run JupyterLab and Unity Catalog in Docker containers.\nTo run the example, execute:\n\n```bash\ndocker compose up --build -d\n````\n\nThis will start JupyterLab on `http://localhost:8888` and Unity Catalog on `http://localhost:8080/api/2.1/unity-catalog`.\nYou can access the example notebook by opening this URL in your browser: `http://localhost:8888/lab?token=junity/tree/example.ipynb`\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\n```bash\n# Clone the repo to your local environment\n# Change directory to the junity 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# Rebuild extension Typescript source after making changes\njlpm 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 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 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 junity\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 `junity` within that folder.\n\n### Testing the extension\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n## Linting and prettier\n\n```sh\njlpm lint\njlpm prettier\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n\n#### Remarks\n\nAlso checkout my other library [dunky](https://github.com/dan1elt0m/dunky) for a matching jupyter kernel\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Daniel Tom All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A JupyterLab extension for Unity Catalog",
"version": "0.7.8",
"project_urls": {
"Bug Tracker": "https://github.com/dan1elt0m/junity/issues",
"Homepage": "https://github.com/dan1elt0m/junity",
"Repository": "https://github.com/dan1elt0m/junity.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "080511c43d692a1ef07b312bcb7de038c237dc96b09c60f5e5206f8c1854b306",
"md5": "7d6fe473cf67b3d7832819e3bccef7b9",
"sha256": "62b0b978ad127dc51c260f6657f18b0924937c0e26f848b377398794e0cb8224"
},
"downloads": -1,
"filename": "junity-0.7.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d6fe473cf67b3d7832819e3bccef7b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 414149,
"upload_time": "2024-12-05T17:24:00",
"upload_time_iso_8601": "2024-12-05T17:24:00.382924Z",
"url": "https://files.pythonhosted.org/packages/08/05/11c43d692a1ef07b312bcb7de038c237dc96b09c60f5e5206f8c1854b306/junity-0.7.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ecbcdd44e7e1a01ff9ea26eac81b3c6665ad391f566bb4e88f1820c12f3d92e",
"md5": "971727a125fbb6053f66877fbff993a5",
"sha256": "2ec80b4356179e872dc45efcc4859e07239a9d6e5ea0e6d8bbe4ad0fee2b81c6"
},
"downloads": -1,
"filename": "junity-0.7.8.tar.gz",
"has_sig": false,
"md5_digest": "971727a125fbb6053f66877fbff993a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 906699,
"upload_time": "2024-12-05T17:24:02",
"upload_time_iso_8601": "2024-12-05T17:24:02.438123Z",
"url": "https://files.pythonhosted.org/packages/5e/cb/cdd44e7e1a01ff9ea26eac81b3c6665ad391f566bb4e88f1820c12f3d92e/junity-0.7.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 17:24:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dan1elt0m",
"github_project": "junity",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "junity"
}
