npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

junity

v0.3.1

Published

A JupyterLab extension for Unity Catalog

Downloads

80

Readme

junity

Github Actions Status

A JupyterLab extension for Unity Catalog. This extension allows you to browse and search for Unity Catalogs directly from JupyterLab. In addition, it supports authentication with Google and token-based access to the Unity Catalog server.

Junity Demo

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install junity

Uninstall

To remove the extension, execute:

pip uninstall junity

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.

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.

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.


## 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 that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# 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.

# 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:

jupyter lab build --minimize=False

Development uninstall

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 for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Linting and prettier

jlpm lint
jlpm prettier

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

Remarks

Also checkout my other library dunky for a matching jupyter kernel