Skip to main content

deephaven.ui Plugin

Plugin prototype for programmatic layouts and callbacks. Currently calling it deephaven.ui but that's not set in stone.

Build

To create your build / development environment (skip the first two lines if you already have a venv):

python -m venv .venv
source .venv/bin/activate
pip install --upgrade pip setuptools
pip install build deephaven-plugin plotly

To build:

python -m build --wheel

The wheel is stored in dist/.

To test within deephaven-core, note where this wheel is stored (using pwd, for example). Then, follow the directions in the top-level README.md to install the wheel into your Deephaven environment.

To unit test, run the following command from the root of the repo:

tox -e py

Usage

Once you have the JS and python plugins installed and the server started, you can use deephaven.ui. See examples for examples.

Logging

The Python library uses the logging module to log messages. The default log level is WARNING. To change the log level for debugging, set the log level to DEBUG:

import logging
import sys

# Have the root logger output to stdout instead of stderr
logging.basicConfig(stream=sys.stdout, level=logging.WARNING)

# Set the log level for the deephaven.ui logger to DEBUG
logging.getLogger("deephaven.ui").setLevel(level=logging.DEBUG)

You can also set the log level for specific modules if you want to see specific modules' debug messages or filter out other ones, e.g.

# Only log warnings from deephaven.ui.hooks
logging.getLogger("deephaven.ui.hooks").setLevel(level=logging.WARNING)

# Log all debug messages from the render module specifically
logging.getLogger("deephaven.ui.render").setLevel(level=logging.DEBUG)

Docs

Docs can be built locally

Install the necessary dependencies:

pip install -r ../../sphinx_ext/sphinx-requirements.txt
pip install dist/deephaven_plugin_ui-*.whl

then run the docs make script:

python make_docs.py

The files will be built into docs/build/markdown. Note that these built files should not be committed to the repository.

Update Icon Types

Available IconTypes can be generated automatically using icon TypeScript definitions in node_modules.

Writes to icon_types.py.

npm install
cd plugins/ui
python make_icon_types.py

Metadata

Release files for deephaven-plugin-ui 0.43.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deephaven-plugin-ui 0.43.2
File Size Uploaded Provenance Actions
deephaven_plugin_ui-0.43.2.tar.gz 1.1 MB Without provenance Details for deephaven_plugin_ui-0.43.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for deephaven-plugin-ui 0.43.2
File Interpreter ABI Platform Actions
deephaven_plugin_ui-0.43.2-py3-none-any.whl Python 3 none any Details for deephaven_plugin_ui-0.43.2-py3-none-any.whl

Total release size: 2.3 MB

Release files / deephaven_plugin_ui-0.43.2.tar.gz

Download URL deephaven_plugin_ui-0.43.2.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
ae9ddf4bfde34fe5b88f1b8c7fa7a5657b54b03839c7dfa1ac7466899cf1de86
BLAKE2b-256 checksum
How to use checksums
664aebe731584f0c11b1b2c5fe03176881a1c36d7aacf8199243006de83d6b5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / deephaven_plugin_ui-0.43.2-py3-none-any.whl

Download URL deephaven_plugin_ui-0.43.2-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8470afd83ff9e711ea8973c1e99cbf14ce9fc45fb170220785dac6375e096186
BLAKE2b-256 checksum
How to use checksums
2a796516a93c90158157b43ff30ded946fa5c47d779e6ff3179d433abc1ba4a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Security for deephaven-plugin-ui 0.43.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.43.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page