litecharts 0.1.0__tar.gz

litecharts-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+tests/html_output/
+
+# Bundled JS (downloaded at build time)
+src/litecharts/js/*.js
+!src/litecharts/js/.gitkeep
+
+# Lock file (library, not application)
+uv.lock
+
+# Dev tools
+CLAUDE.md
+claude-docs/
+.mcp.json

litecharts-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Chad Thackray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

litecharts-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: litecharts
+Version: 0.1.0
+Summary: Python wrapper for TradingView Lightweight Charts
+Project-URL: Homepage, https://github.com/chad/litecharts
+Project-URL: Repository, https://github.com/chad/litecharts
+Author: Chad Thackray
+License-Expression: MIT
+License-File: LICENSE
+Keywords: candlestick,charts,finance,trading,visualization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pandas-stubs>=2.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# litecharts
+
+[![PyPI version](https://badge.fury.io/py/litecharts.svg)](https://pypi.org/project/litecharts/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Typed](https://img.shields.io/badge/typed-strict-blue.svg)](https://mypy-lang.org/)
+
+> **Warning:** This library is in alpha. The API may change unexpectedly between versions.
+
+Thin Python wrapper for [TradingView Lightweight Charts](https://tradingview.github.io/lightweight-charts/).
+
+## Installation
+
+```bash
+pip install litecharts
+```
+
+## Quick Start
+
+```python
+from litecharts import createChart, CandlestickSeries
+
+# Create a chart
+chart = createChart({"width": 800, "height": 600})
+
+# Add a candlestick series
+candles = chart.addSeries(CandlestickSeries)
+candles.setData([
+    {"time": 1609459200, "open": 100, "high": 105, "low": 95, "close": 102},
+    {"time": 1609545600, "open": 102, "high": 110, "low": 100, "close": 108},
+    {"time": 1609632000, "open": 108, "high": 115, "low": 105, "close": 112},
+])
+
+# Display the chart
+chart.show()  # Auto-detects Jupyter or opens browser
+```
+
+## Features
+
+- Candlestick, Line, Area, Bar, Histogram, and Baseline series
+- Multi-pane layouts with synced time scales
+- Pandas DataFrame and NumPy array support
+- Jupyter notebook integration
+- Self-contained HTML output
+
+## Data Input
+
+Accepts multiple formats:
+
+```python
+# List of dicts
+candles.setData([{"time": 1609459200, "open": 100, "high": 105, "low": 95, "close": 102}])
+
+# Pandas DataFrame
+import pandas as pd
+df = pd.DataFrame({"open": [100], "high": [105], "low": [95], "close": [102]},
+                  index=pd.to_datetime(["2021-01-01"]))
+candles.setData(df)
+
+# NumPy array (columns: time, open, high, low, close)
+import numpy as np
+arr = np.array([[1609459200, 100, 105, 95, 102]])
+candles.setData(arr)
+```
+
+## Multi-Pane Charts
+
+```python
+from litecharts import createChart, CandlestickSeries, HistogramSeries
+
+chart = createChart({"width": 800, "height": 600})
+
+# Main pane
+mainPane = chart.addPane({"heightRatio": 3})
+candles = mainPane.addSeries(CandlestickSeries)
+candles.setData(ohlcData)
+
+# Volume pane
+volumePane = chart.addPane({"heightRatio": 1})
+volume = volumePane.addSeries(HistogramSeries)
+volume.setData(volumeData)
+
+chart.show()
+```
+
+## License
+
+MIT - see [LICENSE](LICENSE)
+
+This package bundles [Lightweight Charts](https://github.com/tradingview/lightweight-charts) by TradingView, Inc., licensed under Apache 2.0. See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md).

litecharts-0.1.0/README.md

@@ -0,0 +1,91 @@
+# litecharts
+
+[![PyPI version](https://badge.fury.io/py/litecharts.svg)](https://pypi.org/project/litecharts/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Typed](https://img.shields.io/badge/typed-strict-blue.svg)](https://mypy-lang.org/)
+
+> **Warning:** This library is in alpha. The API may change unexpectedly between versions.
+
+Thin Python wrapper for [TradingView Lightweight Charts](https://tradingview.github.io/lightweight-charts/).
+
+## Installation
+
+```bash
+pip install litecharts
+```
+
+## Quick Start
+
+```python
+from litecharts import createChart, CandlestickSeries
+
+# Create a chart
+chart = createChart({"width": 800, "height": 600})
+
+# Add a candlestick series
+candles = chart.addSeries(CandlestickSeries)
+candles.setData([
+    {"time": 1609459200, "open": 100, "high": 105, "low": 95, "close": 102},
+    {"time": 1609545600, "open": 102, "high": 110, "low": 100, "close": 108},
+    {"time": 1609632000, "open": 108, "high": 115, "low": 105, "close": 112},
+])
+
+# Display the chart
+chart.show()  # Auto-detects Jupyter or opens browser
+```
+
+## Features
+
+- Candlestick, Line, Area, Bar, Histogram, and Baseline series
+- Multi-pane layouts with synced time scales
+- Pandas DataFrame and NumPy array support
+- Jupyter notebook integration
+- Self-contained HTML output
+
+## Data Input
+
+Accepts multiple formats:
+
+```python
+# List of dicts
+candles.setData([{"time": 1609459200, "open": 100, "high": 105, "low": 95, "close": 102}])
+
+# Pandas DataFrame
+import pandas as pd
+df = pd.DataFrame({"open": [100], "high": [105], "low": [95], "close": [102]},
+                  index=pd.to_datetime(["2021-01-01"]))
+candles.setData(df)
+
+# NumPy array (columns: time, open, high, low, close)
+import numpy as np
+arr = np.array([[1609459200, 100, 105, 95, 102]])
+candles.setData(arr)
+```
+
+## Multi-Pane Charts
+
+```python
+from litecharts import createChart, CandlestickSeries, HistogramSeries
+
+chart = createChart({"width": 800, "height": 600})
+
+# Main pane
+mainPane = chart.addPane({"heightRatio": 3})
+candles = mainPane.addSeries(CandlestickSeries)
+candles.setData(ohlcData)
+
+# Volume pane
+volumePane = chart.addPane({"heightRatio": 1})
+volume = volumePane.addSeries(HistogramSeries)
+volume.setData(volumeData)
+
+chart.show()
+```
+
+## License
+
+MIT - see [LICENSE](LICENSE)
+
+This package bundles [Lightweight Charts](https://github.com/tradingview/lightweight-charts) by TradingView, Inc., licensed under Apache 2.0. See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md).

litecharts-0.1.0/build_hooks.py

@@ -0,0 +1,26 @@
+"""Build hook to download Lightweight Charts JS at package build time."""
+
+from __future__ import annotations
+
+import urllib.request
+from pathlib import Path
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+LWC_VERSION = "5.1.0"
+LWC_URL = f"https://cdn.jsdelivr.net/npm/lightweight-charts@{LWC_VERSION}/dist/lightweight-charts.standalone.production.js"
+JS_DIR = Path(__file__).parent / "src" / "litecharts" / "js"
+JS_FILE = JS_DIR / "lightweight-charts.js"
+
+
+class CustomBuildHook(BuildHookInterface):
+    """Download Lightweight Charts JS during build."""
+
+    def initialize(self, version: str, build_data: dict) -> None:
+        """Download LWC JS if not already present."""
+        JS_DIR.mkdir(parents=True, exist_ok=True)
+
+        if not JS_FILE.exists():
+            print(f"Downloading Lightweight Charts v{LWC_VERSION}...")
+            urllib.request.urlretrieve(LWC_URL, JS_FILE)
+            print(f"Downloaded to {JS_FILE}")

litecharts-0.1.0/pyproject.toml

@@ -0,0 +1,75 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "litecharts"
+version = "0.1.0"
+description = "Python wrapper for TradingView Lightweight Charts"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Chad Thackray" }
+]
+keywords = ["trading", "charts", "visualization", "finance", "candlestick"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "mypy>=1.0",
+    "ruff>=0.8",
+    "pandas-stubs>=2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/chad/litecharts"
+Repository = "https://github.com/chad/litecharts"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/build_hooks.py",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/litecharts"]
+
+[tool.hatch.build.hooks.custom]
+path = "build_hooks.py"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_ignores = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF", "N"]
+ignore = [
+    "N802",  # Function name should be lowercase (we use camelCase to match LWC)
+    "N803",  # Argument name should be lowercase (we use camelCase to match LWC)
+    "N806",  # Variable in function should be lowercase (we use camelCase to match LWC)
+    "N815",  # Variable in class scope should not be mixedCase (we use camelCase)
+    "N816",  # Variable in global scope should not be mixedCase (we use camelCase)
+]

litecharts-0.1.0/src/litecharts/__init__.py

@@ -0,0 +1,100 @@
+"""Litecharts - Python wrapper for TradingView Lightweight Charts."""
+
+from .chart import Chart, createChart
+from .pane import Pane
+from .series import (
+    AreaSeries,
+    BarSeries,
+    BaselineSeries,
+    BaseSeries,
+    CandlestickSeries,
+    HistogramSeries,
+    LineSeries,
+    createSeriesMarkers,
+)
+from .types import (
+    AreaSeriesOptions,
+    AutoScaleMargins,
+    AxisDoubleClickOptions,
+    AxisPressedMouseMoveOptions,
+    BarSeriesOptions,
+    BaselineSeriesOptions,
+    BaseSeriesOptions,
+    BaseValuePrice,
+    CandlestickSeriesOptions,
+    ChartOptions,
+    CrosshairLineOptions,
+    CrosshairOptions,
+    GridLineOptions,
+    GridOptions,
+    HandleScaleOptions,
+    HandleScrollOptions,
+    HistogramSeriesOptions,
+    KineticScrollOptions,
+    LastPriceAnimationOptions,
+    LayoutOptions,
+    LineSeriesOptions,
+    LocalizationOptions,
+    Marker,
+    MarkerTooltip,
+    OhlcData,
+    PaneOptions,
+    PriceFormat,
+    PriceLineOptions,
+    PriceScaleMargins,
+    PriceScaleOptions,
+    RectangleOptions,
+    SingleValueData,
+    TimeScaleOptions,
+    WatermarkOptions,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "AreaSeries",
+    "AreaSeriesOptions",
+    "AutoScaleMargins",
+    "AxisDoubleClickOptions",
+    "AxisPressedMouseMoveOptions",
+    "BarSeries",
+    "BarSeriesOptions",
+    "BaseSeries",
+    "BaseSeriesOptions",
+    "BaseValuePrice",
+    "BaselineSeries",
+    "BaselineSeriesOptions",
+    "CandlestickSeries",
+    "CandlestickSeriesOptions",
+    "Chart",
+    "ChartOptions",
+    "CrosshairLineOptions",
+    "CrosshairOptions",
+    "GridLineOptions",
+    "GridOptions",
+    "HandleScaleOptions",
+    "HandleScrollOptions",
+    "HistogramSeries",
+    "HistogramSeriesOptions",
+    "KineticScrollOptions",
+    "LastPriceAnimationOptions",
+    "LayoutOptions",
+    "LineSeries",
+    "LineSeriesOptions",
+    "LocalizationOptions",
+    "Marker",
+    "MarkerTooltip",
+    "OhlcData",
+    "Pane",
+    "PaneOptions",
+    "PriceFormat",
+    "PriceLineOptions",
+    "PriceScaleMargins",
+    "PriceScaleOptions",
+    "RectangleOptions",
+    "SingleValueData",
+    "TimeScaleOptions",
+    "WatermarkOptions",
+    "createChart",
+    "createSeriesMarkers",
+]

litecharts-0.1.0/src/litecharts/_js.py

@@ -0,0 +1,29 @@
+"""Lightweight Charts JavaScript asset loading."""
+
+from __future__ import annotations
+
+from functools import lru_cache
+from importlib.resources import files
+
+
+@lru_cache(maxsize=1)
+def getLwcJs() -> str:
+    """Load the bundled Lightweight Charts JavaScript.
+
+    Returns:
+        The LWC JavaScript source code.
+
+    Raises:
+        FileNotFoundError: If the JS file is not found (package not built correctly).
+    """
+    jsPath = files("litecharts.js").joinpath("lightweight-charts.js")
+
+    try:
+        return jsPath.read_text(encoding="utf-8")
+    except FileNotFoundError:
+        msg = (
+            "Lightweight Charts JS not found. "
+            "This usually means the package was not built correctly. "
+            "Try reinstalling: pip install --force-reinstall litecharts"
+        )
+        raise FileNotFoundError(msg) from None