Metadata-Version: 2.4
Name: python-lightweight-charts
Version: 1.2.0
Summary: A maintained Python wrapper for TradingView's Lightweight Charts v5.x — featuring StreamChart, plugins, multi-pane layouts, and full IChartApi coverage.
Author-email: Gopal Parashar <gopal.parashar421@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/gopalparashar421/lightweight-charts-python
Project-URL: Source, https://github.com/gopalparashar421/lightweight-charts-python
Project-URL: Documentation, https://python-lightweight-charts.readthedocs.io/en/latest/
Project-URL: Changelog, https://github.com/gopalparashar421/lightweight-charts-python/blob/main/CHANGELOG.md
Project-URL: Bug Tracker, https://github.com/gopalparashar421/lightweight-charts-python/issues
Keywords: lightweight-charts,tradingview,charts,finance,trading,candlestick,ohlc,stock,crypto,visualization
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: pywebview>=5.0.5
Requires-Dist: fastapi<1.0,>=0.100
Requires-Dist: uvicorn[standard]>=0.23
Dynamic: license-file

<div align="center">

# python-lightweight-charts

[![PyPi Release](https://img.shields.io/pypi/v/python-lightweight-charts?color=32a852&label=PyPi)](https://pypi.org/project/python-lightweight-charts/)
[![Made with Python](https://img.shields.io/badge/Python-3.10+-c7a002?logo=python&logoColor=white)](https://python.org "Go to Python homepage")
[![License](https://img.shields.io/github/license/gopalparashar421/lightweight-charts-python?color=9c2400)](https://github.com/gopalparashar421/lightweight-charts-python/blob/main/LICENSE)
[![Documentation](https://img.shields.io/badge/documentation-006ee3)](https://python-lightweight-charts.readthedocs.io/en/latest/)

![cover](https://raw.githubusercontent.com/gopalparashar421/lightweight-charts-python/main/cover.png)

A maintained Python wrapper for [TradingView's Lightweight Charts](https://www.tradingview.com/lightweight-charts/) v5.x.

> **Fork of** [`louisnw01/lightweight-charts-python`](https://github.com/louisnw01/lightweight-charts-python) — original library by [@louisnw01](https://github.com/louisnw01). This fork brings it up to Lightweight Charts v5, adds `StreamChart`, completes the `IChartApi` surface, and adds new plugins. Full credit and thanks to the original author.

</div>


## Installation
```
pip install python-lightweight-charts
```
___

## Features
1. Streamlined for live data, with methods for updating directly from tick data.
2. Multi-pane charts using [Subcharts](https://python-lightweight-charts.readthedocs.io/en/latest/reference/abstract_chart.html#AbstractChart.create_subchart) and a full pane-management API (`add_pane`, `move_pane`, `resize_pane`, `remove_pane`).
3. The [Toolbox](https://python-lightweight-charts.readthedocs.io/en/latest/reference/toolbox.html) — draw trendlines, rectangles, rays, and horizontal lines directly on charts.
4. [Events & Callbacks](https://python-lightweight-charts.readthedocs.io/en/latest/tutorials/events.html) — timeframe selectors, search, hotkeys, and more.
5. [Tables](https://python-lightweight-charts.readthedocs.io/en/latest/reference/tables.html) for watchlists, order entry, and trade management.
6. [StreamChart](https://python-lightweight-charts.readthedocs.io/en/latest/reference/stream_chart.html) — serve a chart over HTTP/WebSocket, viewable in any browser (no desktop window needed).
7. **Plugins:** `Tooltip`, `BandsIndicator`, `SessionHighlighting`, `HeatmapSeries`, `VolumeProfile`, `PositionTool`.
8. Full [Lightweight Charts v5 IChartApi](https://tradingview.github.io/lightweight-charts/docs/api) surface including `price_scale`, `time_scale`, watermark, grid, crosshair, and more.
9. Direct integration of market data through [Polygon.io's](https://polygon.io/?utm_source=affiliate&utm_campaign=pythonlwcharts) market data API.

**Supports:** Jupyter Notebooks, PyQt6, PyQt5, PySide6, wxPython, Streamlit, and asyncio.

PartTimeLarry: [Interactive Brokers API and TradingView Charts in Python](https://www.youtube.com/watch?v=TlhDI3PforA)
___

### 1. Display data from a csv:

```python
import pandas as pd
from lightweight_charts import Chart


if __name__ == '__main__':

    chart = Chart()

    # Columns: time | open | high | low | close | volume
    df = pd.read_csv('ohlcv.csv')
    chart.set(df)

    chart.show(block=True)

```
![setting_data image](https://raw.githubusercontent.com/gopalparashar421/lightweight-charts-python/main/examples/1_setting_data/setting_data.png)
___

### 2. Updating bars in real-time:

```python
import pandas as pd
from time import sleep
from lightweight_charts import Chart

if __name__ == '__main__':

    chart = Chart()

    df1 = pd.read_csv('ohlcv.csv')
    df2 = pd.read_csv('next_ohlcv.csv')

    chart.set(df1)

    chart.show()

    last_close = df1.iloc[-1]['close']

    for i, series in df2.iterrows():
        chart.update(series)

        if series['close'] > 20 and last_close < 20:
            chart.marker(text='The price crossed $20!')

        last_close = series['close']
        sleep(0.1)

```

![live data gif](https://github.com/gopalparashar421/lightweight-charts-python/blob/main/examples/2_live_data/live_data.gif?raw=true)
___

### 3. Updating bars from tick data in real-time:

```python
import pandas as pd
from time import sleep
from lightweight_charts import Chart


if __name__ == '__main__':

    df1 = pd.read_csv('ohlc.csv')

    # Columns: time | price
    df2 = pd.read_csv('ticks.csv')

    chart = Chart()

    chart.set(df1)

    chart.show()

    for i, tick in df2.iterrows():
        chart.update_from_tick(tick)

        sleep(0.03)

```
![tick data gif](https://raw.githubusercontent.com/gopalparashar421/lightweight-charts-python/main/examples/3_tick_data/tick_data.gif)
___

### 4. Line Indicators:

```python
import pandas as pd
from lightweight_charts import Chart


def calculate_sma(df, period: int = 50):
    return pd.DataFrame({
        'time': df['date'],
        f'SMA {period}': df['close'].rolling(window=period).mean()
    }).dropna()


if __name__ == '__main__':
    chart = Chart()
    chart.legend(visible=True)

    df = pd.read_csv('ohlcv.csv')
    chart.set(df)

    line = chart.create_line('SMA 50')
    sma_data = calculate_sma(df, period=50)
    line.set(sma_data)

    chart.show(block=True)

```
![line indicators image](https://raw.githubusercontent.com/gopalparashar421/lightweight-charts-python/main/examples/4_line_indicators/line_indicators.png)
___

### 5. Styling:

```python
import pandas as pd
from lightweight_charts import Chart


if __name__ == '__main__':

    chart = Chart()

    df = pd.read_csv('ohlcv.csv')

    chart.layout(background_color='#090008', text_color='#FFFFFF', font_size=16,
                 font_family='Helvetica')

    chart.candle_style(up_color='#00ff55', down_color='#ed4807',
                       border_up_color='#FFFFFF', border_down_color='#FFFFFF',
                       wick_up_color='#FFFFFF', wick_down_color='#FFFFFF')

    chart.volume_config(up_color='#00ff55', down_color='#ed4807')

    chart.watermark('1D', color='rgba(180, 180, 240, 0.7)')

    chart.crosshair(mode='normal', vert_color='#FFFFFF', vert_style='dotted',
                    horz_color='#FFFFFF', horz_style='dotted')

    chart.legend(visible=True, font_size=14)

    chart.set(df)

    chart.show(block=True)

```
![styling image](https://raw.githubusercontent.com/gopalparashar421/lightweight-charts-python/main/examples/5_styling/styling.png)
___

### 6. Callbacks:

```python
import pandas as pd
from lightweight_charts import Chart


def get_bar_data(symbol, timeframe):
    if symbol not in ('AAPL', 'GOOGL', 'TSLA'):
        print(f'No data for "{symbol}"')
        return pd.DataFrame()
    return pd.read_csv(f'bar_data/{symbol}_{timeframe}.csv')


def on_search(chart, searched_string):  # Called when the user searches.
    new_data = get_bar_data(searched_string, chart.topbar['timeframe'].value)
    if new_data.empty:
        return
    chart.topbar['symbol'].set(searched_string)
    chart.set(new_data)


def on_timeframe_selection(chart):  # Called when the user changes the timeframe.
    new_data = get_bar_data(chart.topbar['symbol'].value, chart.topbar['timeframe'].value)
    if new_data.empty:
        return
    chart.set(new_data, True)


def on_horizontal_line_move(chart, line):
    print(f'Horizontal line moved to: {line.price}')


if __name__ == '__main__':
    chart = Chart(toolbox=True)
    chart.legend(True)

    chart.events.search += on_search

    chart.topbar.textbox('symbol', 'TSLA')
    chart.topbar.switcher('timeframe', ('1min', '5min', '30min'), default='5min',
                          func=on_timeframe_selection)

    df = get_bar_data('TSLA', '5min')
    chart.set(df)

    chart.horizontal_line(200, func=on_horizontal_line_move)

    chart.show(block=True)

```
![callbacks gif](https://raw.githubusercontent.com/gopalparashar421/lightweight-charts-python/main/examples/6_callbacks/callbacks.gif)
___

### 7. StreamChart — browser-based chart over HTTP/WebSocket:

`StreamChart` spins up a local FastAPI/Uvicorn server and streams data to any browser tab. No desktop window is required — ideal for headless servers, notebooks, or remote development.

```python
import pandas as pd
from lightweight_charts import StreamChart

if __name__ == '__main__':
    chart = StreamChart()

    df = pd.read_csv('ohlcv.csv')   # columns: time | open | high | low | close | volume
    chart.set(df)

    chart.show(port=8080, block=True)
```

Running the script prints a URL such as:

```
Chart server running at http://127.0.0.1:8080/?token=<64-hex-chars> — press Ctrl+C to stop
```

Open that URL in your browser to view the chart. The URL contains a one-time security token — keep it private.

> **Tip:** pass `open_browser=True` to `chart.show()` to launch the browser automatically.

___

### 8. Plugins:

```python
import pandas as pd
from lightweight_charts import Chart
from lightweight_charts.plugins import BandsIndicator, Tooltip

if __name__ == '__main__':
    chart = Chart()

    df = pd.read_csv('ohlcv.csv')
    chart.set(df)

    # Bollinger Bands
    upper = df['close'].rolling(20).mean() + 2 * df['close'].rolling(20).std()
    lower = df['close'].rolling(20).mean() - 2 * df['close'].rolling(20).std()
    bands = BandsIndicator(chart)
    bands.set(df['time'], upper, lower)

    # Hover tooltip
    tooltip = Tooltip(chart)

    chart.show(block=True)
```

Available plugins: `Tooltip`, `BandsIndicator`, `SessionHighlighting`, `HeatmapSeries`, `VolumeProfile`, `PositionTool`.

See the [examples/](https://github.com/gopalparashar421/lightweight-charts-python/tree/main/examples) directory for a runnable script for each plugin.

___

<div align="center">

[![Documentation](https://img.shields.io/badge/documentation-006ee3)](https://python-lightweight-charts.readthedocs.io/en/latest/)

Maintained by [Gopal Parashar](https://github.com/gopalparashar421) · [gopal.parashar421@gmail.com](mailto:gopal.parashar421@gmail.com)

This is a maintained fork of [`louisnw01/lightweight-charts-python`](https://github.com/louisnw01/lightweight-charts-python) by [@louisnw01](https://github.com/louisnw01). Full credit to the original author.

___

_This package is an independent creation and has not been endorsed, sponsored, or approved by TradingView. The author of this package does not have any official relationship with TradingView, and the package does not represent the views or opinions of TradingView._
</div>
