# Deephaven Plugin for Charts
Custom implementation built on top of plotly express to make it compatible with deephaven tables.
## 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 plugin installed and the server started, the recommended way to import the package mirrors plotly express:
```python
import deephaven.plot.express as dx
```
Then, you can create a table (or use an existing one) and start plotting
```python
from deephaven.column import int_col, string_col
import deephaven.plot.express as dx
from deephaven import new_table
source = new_table(
[
string_col("Categories", ["A", "B", "C"]),
int_col("Values", [1, 3, 5]),
]
)
fig = dx.bar(table=source, x="Categories", y="Values")
```
## Docs
Docs can be built locally
Install the necessary dependencies:
```shell
pip install -r ../../sphinx_ext/sphinx-requirements.txt
pip install dist/deephaven_plugin_plotly_express-*.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.
Raw data
{
"_id": null,
"home_page": "https://github.com/deephaven/deephaven-plugins",
"name": "deephaven-plugin-plotly-express",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "deephaven, plugin, graph",
"author": "Devin Smith, Vlad Babich, Joe Numainville",
"author_email": "josephnumainville@deephaven.io",
"download_url": "https://files.pythonhosted.org/packages/5b/ca/0dad2e5f0092029050cc9a38b51763f367944b17489ef094ae52ec6fdcad/deephaven_plugin_plotly_express-0.12.1.tar.gz",
"platform": "any",
"description": "# Deephaven Plugin for Charts\n\nCustom implementation built on top of plotly express to make it compatible with deephaven tables.\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 plugin installed and the server started, the recommended way to import the package mirrors plotly express:\n\n```python\nimport deephaven.plot.express as dx\n```\n\nThen, you can create a table (or use an existing one) and start plotting\n\n```python\nfrom deephaven.column import int_col, string_col\nimport deephaven.plot.express as dx\nfrom deephaven import new_table\n\nsource = new_table(\n [\n string_col(\"Categories\", [\"A\", \"B\", \"C\"]),\n int_col(\"Values\", [1, 3, 5]),\n ]\n)\n\nfig = dx.bar(table=source, x=\"Categories\", y=\"Values\")\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_plotly_express-*.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",
"bugtrack_url": null,
"license": null,
"summary": "Deephaven Chart Plugin",
"version": "0.12.1",
"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": "95999e3a48e590f832c81928b2c937b789675385c909750c41f76c31d4d3fa96",
"md5": "7e6eaaa9aea858a59600aeacaef32f6d",
"sha256": "75e3bad92247f0e4cce0c85606569828356b9b26e2940dd9b4d97ad9e3cc8bf2"
},
"downloads": -1,
"filename": "deephaven_plugin_plotly_express-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e6eaaa9aea858a59600aeacaef32f6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1663767,
"upload_time": "2024-12-12T21:21:34",
"upload_time_iso_8601": "2024-12-12T21:21:34.163315Z",
"url": "https://files.pythonhosted.org/packages/95/99/9e3a48e590f832c81928b2c937b789675385c909750c41f76c31d4d3fa96/deephaven_plugin_plotly_express-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5bca0dad2e5f0092029050cc9a38b51763f367944b17489ef094ae52ec6fdcad",
"md5": "5b266bc9de8536fd442d92bd7c80ed39",
"sha256": "f9e89a25e0cea759a348481faa9d53f259716b565f4a31ed239fbbca1609c398"
},
"downloads": -1,
"filename": "deephaven_plugin_plotly_express-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "5b266bc9de8536fd442d92bd7c80ed39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1609815,
"upload_time": "2024-12-12T21:21:35",
"upload_time_iso_8601": "2024-12-12T21:21:35.767260Z",
"url": "https://files.pythonhosted.org/packages/5b/ca/0dad2e5f0092029050cc9a38b51763f367944b17489ef094ae52ec6fdcad/deephaven_plugin_plotly_express-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 21:21:35",
"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-plotly-express"
}
JSON
