deephaven-plugin-ui


Namedeephaven-plugin-ui JSON
Version 0.25.0 PyPI version JSON
download
home_pagehttps://github.com/deephaven/deephaven-plugins
Summarydeephaven.ui plugin
upload_time2025-01-15 18:45:38
maintainerNone
docs_urlNone
authorDeephaven Data Labs
requires_pythonNone
licenseNone
keywords deephaven plugin graph
VCS
bugtrack_url
requirements pre-commit build pip setuptools tox
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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):

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

To build:

```sh
python -m build --wheel
```

The wheel is stored in `dist/`.

To test within [deephaven-core](https://github.com/deephaven/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:

```sh
tox -e py
```

## Usage

Once you have the JS and python plugins installed and the server started, you can use deephaven.ui. See [examples](docs/README.md) for examples.

## Logging

The Python library uses the [logging](https://docs.python.org/3/howto/logging.html) module to log messages. The default log level is `WARNING`. To change the log level for debugging, set the log level to `DEBUG`:

```python
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.

```python
# 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:
```shell
pip install -r ../../sphinx_ext/sphinx-requirements.txt
pip install dist/deephaven_plugin_ui-*.whl
```
then run the docs make script:
```shell
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`. 

```shell
npm install
cd plugins/ui
python make_icon_types.py
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/deephaven/deephaven-plugins",
    "name": "deephaven-plugin-ui",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "deephaven, plugin, graph",
    "author": "Deephaven Data Labs",
    "author_email": "support@deephaven.io",
    "download_url": "https://files.pythonhosted.org/packages/fc/60/5faf1784b45f6aaa2bd35c4de32c8c974e6c49112fbd8c37e92203f37ab3/deephaven_plugin_ui-0.25.0.tar.gz",
    "platform": "any",
    "description": "# deephaven.ui Plugin\n\nPlugin prototype for programmatic layouts and callbacks. Currently calling it `deephaven.ui` but that's not set in stone.\n\n## Build\n\nTo create your build / development environment (skip the first two lines if you already have a venv):\n\n```sh\npython -m venv .venv\nsource .venv/bin/activate\npip install --upgrade pip setuptools\npip install build deephaven-plugin plotly\n```\n\nTo build:\n\n```sh\npython -m build --wheel\n```\n\nThe wheel is stored in `dist/`.\n\nTo test within [deephaven-core](https://github.com/deephaven/deephaven-core), note where this wheel is stored (using `pwd`, for example).\nThen, follow the directions in the top-level README.md to install the wheel into your Deephaven environment.\n\nTo unit test, run the following command from the root of the repo:\n\n```sh\ntox -e py\n```\n\n## Usage\n\nOnce you have the JS and python plugins installed and the server started, you can use deephaven.ui. See [examples](docs/README.md) for examples.\n\n## Logging\n\nThe Python library uses the [logging](https://docs.python.org/3/howto/logging.html) module to log messages. The default log level is `WARNING`. To change the log level for debugging, set the log level to `DEBUG`:\n\n```python\nimport logging\nimport sys\n\n# Have the root logger output to stdout instead of stderr\nlogging.basicConfig(stream=sys.stdout, level=logging.WARNING)\n\n# Set the log level for the deephaven.ui logger to DEBUG\nlogging.getLogger(\"deephaven.ui\").setLevel(level=logging.DEBUG)\n```\n\nYou 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.\n\n```python\n# Only log warnings from deephaven.ui.hooks\nlogging.getLogger(\"deephaven.ui.hooks\").setLevel(level=logging.WARNING)\n\n# Log all debug messages from the render module specifically\nlogging.getLogger(\"deephaven.ui.render\").setLevel(level=logging.DEBUG)\n```\n\n## Docs\nDocs can be built locally\n\nInstall the necessary dependencies:\n```shell\npip install -r ../../sphinx_ext/sphinx-requirements.txt\npip install dist/deephaven_plugin_ui-*.whl\n```\nthen run the docs make script:\n```shell\npython make_docs.py\n```\n\nThe files will be built into `docs/build/markdown`.\nNote that these built files should not be committed to the repository.\n\n## Update Icon Types\nAvailable IconTypes can be generated automatically using icon TypeScript definitions in node_modules.\n\nWrites to `icon_types.py`. \n\n```shell\nnpm install\ncd plugins/ui\npython make_icon_types.py\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "deephaven.ui plugin",
    "version": "0.25.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/deephaven/deephaven-plugins/issues",
        "Homepage": "https://github.com/deephaven/deephaven-plugins",
        "Source Code": "https://github.com/deephaven/deephaven-plugins"
    },
    "split_keywords": [
        "deephaven",
        " plugin",
        " graph"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e07cb270b31b5127fee03ad7ec9a56ae8d7c52462b0e8011c259d3d59018f361",
                "md5": "82a0eb4e9506a213679428b283c4e788",
                "sha256": "94ae26a2ec785a92a3b6fd1f6f15e0b3fcd9b7f91231888bfd92ba1254a67bb6"
            },
            "downloads": -1,
            "filename": "deephaven_plugin_ui-0.25.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "82a0eb4e9506a213679428b283c4e788",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 1124303,
            "upload_time": "2025-01-15T18:45:35",
            "upload_time_iso_8601": "2025-01-15T18:45:35.939849Z",
            "url": "https://files.pythonhosted.org/packages/e0/7c/b270b31b5127fee03ad7ec9a56ae8d7c52462b0e8011c259d3d59018f361/deephaven_plugin_ui-0.25.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fc605faf1784b45f6aaa2bd35c4de32c8c974e6c49112fbd8c37e92203f37ab3",
                "md5": "2e9b894a6e975ba52f2d3ce74cd7cf9a",
                "sha256": "fec71f4da1bdeb6c5171481efbcdd5b12f9045d8280c21a4fa0748f66e6bee00"
            },
            "downloads": -1,
            "filename": "deephaven_plugin_ui-0.25.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e9b894a6e975ba52f2d3ce74cd7cf9a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1018157,
            "upload_time": "2025-01-15T18:45:38",
            "upload_time_iso_8601": "2025-01-15T18:45:38.511667Z",
            "url": "https://files.pythonhosted.org/packages/fc/60/5faf1784b45f6aaa2bd35c4de32c8c974e6c49112fbd8c37e92203f37ab3/deephaven_plugin_ui-0.25.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-15 18:45:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "deephaven",
    "github_project": "deephaven-plugins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pre-commit",
            "specs": [
                [
                    "==",
                    "3.3.3"
                ]
            ]
        },
        {
            "name": "build",
            "specs": []
        },
        {
            "name": "pip",
            "specs": []
        },
        {
            "name": "setuptools",
            "specs": []
        },
        {
            "name": "tox",
            "specs": []
        }
    ],
    "lcname": "deephaven-plugin-ui"
}
        
Elapsed time: 0.91955s