deephaven-plugin-tradingview-lightweight

A Deephaven plugin for creating TradingView Lightweight Charts from Python.

Usage

import deephaven.plot.tradingview_lightweight as tvl

# Example daily OHLCV data: Timestamp, Open, High, Low, Close, Volume, Ema
ohlc = tvl.data.ohlc()

# Candlesticks with an EMA overlay on top, volume histogram in a second pane below
chart = tvl.chart(
    tvl.candlestick(ohlc),
    tvl.line(ohlc, timestamp="Timestamp", value="Ema"),
    tvl.histogram(ohlc, timestamp="Timestamp", value="Volume", pane=1),
    pane_stretch_factors=[3, 1],
    # Daily data: label the time axis with dates rather than time of day
    time_scale=tvl.time_scale(time_visible=False),
)

Docs

User-facing documentation lives in docs/ and follows the same structure plotly-express does: one Markdown page per chart type and concept, ending with a ## API Reference block that dhautofunction expands from the Python docstrings.

Build the docs locally

From this plugin's directory (plugins/tradingview-lightweight/):

pip install -r ../../sphinx_ext/sphinx-requirements.txt
pip install dist/deephaven_plugin_tradingview_lightweight-*.whl
python make_docs.py

The rendered Markdown lands in docs/build/markdown/. Don't commit it — docs/build/ is gitignored.

Use plugin_builder.py (recommended)

The same plugin_builder.py workflow used for ui and plotly-express works here. From the repo root:

# Reinstall the wheel, then build docs.
python tools/plugin_builder.py --docs --reinstall tradingview-lightweight

# Build docs and regenerate Pass-1 (table) snapshots.
python tools/plugin_builder.py --docs --snapshots --reinstall tradingview-lightweight

Preview the docs

# Live preview at http://localhost:3001 (uses source markdown, no API reference).
npm run docs

# Or, after running `python tools/plugin_builder.py --docs tradingview-lightweight`:
BUILT=true npm run docs

Doc snapshots

TVL has none. docker-compose.docs-snapshots.yml — which backs npm run update-doc-snapshots and plugin_builder.py --snapshots — names only ui and plotly-express in its extractor, snapshotter, and validator services, so running either is a no-op for this plugin.

An earlier docs/snapshots/ directory was removed: it had been produced by out-of-repo tooling, nothing in CI could regenerate or validate it, and the chart entries pointed at PNGs in a form Salmon has no renderer for. Wiring TVL into the shared pipeline is follow-up work; snapshots should come back from that pipeline rather than by hand.