klinepy
Python wrapper for KLineCharts (klinecharts@10) — one chart spec, three outputs: standalone HTML, embeddable fragment, marimo/anywidget widget.
Three built-in themes — grayscale + amber (default), pastel green/red, black/grey — plus fully custom colors:
theme="default" |
theme="classic" |
theme="mono" |
|---|---|---|
 |
 |
 |
KLineChart(bars, theme="classic") # preset; explicit *_color kwargs still override
Custom palettes via a dict (merges into the theme) or the Colors dataclass
(replaces it) — both accept the same keys: up, down, no_change, accent,
price_line (dashed last-price line + tag), background, grid, border, text.
from klinepy import KLineChart, Colors
# tweak one key of a preset
KLineChart(bars, theme="classic", colors={"accent": "#b91c1c"})
# full custom, e.g. dark
KLineChart(bars, colors=Colors(
up="#4ade80", down="#f87171", accent="#fbbf24", price_line="#fbbf24",
background="#0f172a", grid="#1e293b", border="#334155", text="#94a3b8",
))
🎬 Animated tour
Dark-mode tour — candles + SMA, Darvas boxes, a static-charts-v1 bundle
(rs line + blue dots), and RRG mode. Video: docs/tour/tour.webm
(attach it to the release/PR for inline playback);
regenerate with uv run python scripts/emit-tour-html.py && node scripts/capture-tour.mjs
(requires npx playwright install chromium + ffmpeg).
Precedence: *_color kwargs > colors > theme > defaults.
Grayscale theme with a single amber accent (#d97706). The JS side loads the
klinecharts ESM build from jsDelivr (needs internet in the browser); the
Python side is pure data (polars/pandas frames or dicts — no data deps).
Usage
from klinepy import KLineChart, html, fragment
chart = KLineChart(
bars, # polars/pandas DataFrame or list of dicts
lines={"SMA 20": sma}, # overlay lines on the price pane, aligned/padded to bar count
panes={"rel vol": rv}, # own-pane series (one sub-pane per named series)
overlays=[boxes], # boxes / klinecharts overlay specs, see below
title="AAPL",
indicators=[{"name": "MACD"}}], # optional built-in klinecharts indicators
height=460,
)
# 1. marimo / Jupyter widget
mo.ui.anywidget(chart)
# 2. standalone HTML document (CDN ESM, no build step)
open("aapl.html", "w").write(chart.to_html()) # or: html(chart)
# 3. embeddable fragment for web apps (no <html> wrapper)
page += chart.fragment() # or: fragment(chart)
Overlays
lines and panes plot the values you pass (amber accent). For boxes — e.g.
Darvas:
chart = KLineChart(bars, overlays=[
{"start": dt.date(2026, 1, 5), "end": dt.date(2026, 1, 25),
"top": 103.0, "bottom": 97.0}, # rendered as an amber rect
])
Full klinecharts overlay specs
(priceLine, segment, simpleTag, …) pass through unchanged:
overlays=[{"name": "priceLine", "points": [{"timestamp": ts_ms, "value": 99.5}]}]
Static chart bundles (static-charts-v1)
One versioned, self-describing JSON per symbol — the data contract for
standalone HTML / static sites. Charts never fetch or compute data; you
produce the bundle (e.g. 2y OHLCV bars, rs_line, blue_dots, benchmark,
fundamentals), klinepy validates, stamps schema_version, and renders.
from klinepy import ChartBundle, emit, html, load_bundle
bundle = ChartBundle(
symbol="AAPL",
bars=bars, # same inputs as KLineChart
rs_line=rs, # price-pane overlay line
blue_dots=[{"session": d, "value": 104.0}], # dot markers at highs
benchmark="SPY", # metadata (not drawn)
fundamentals={"market_cap": 3.4e12}, # metadata (not drawn)
)
data = emit(bundle, "charts/AAPL.json") # validated + version-stamped
html("charts/AAPL.json") # bundle path → standalone HTML
html(data) # or the dict; fragment(...) works the same way
load_bundle("charts/AAPL.json") # read + validate a bundle
to_chart(bundle) / html(bundle) / fragment(bundle) also accept plain
KLineChart instances unchanged. Bump schema_version keys (static-charts-v2)
only for breaking shape changes; loaders reject unknown versions.
Development
uv sync
uv run pytest
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file klinepy-0.3.0.tar.gz.
File metadata
- Download URL: klinepy-0.3.0.tar.gz
- Upload date:
- Size: 17.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec4a227adcc3fc2d60fd73e43cefa16daf51c8d24a0b84a9fbc971cbff4055c4
|
|
| MD5 |
00503f48b1b029dadda97d93cb69335d
|
|
| BLAKE2b-256 |
69eff1b0539f7f3a147292822e1b1395aba7da212d10f2ebf05a9f6069a37ced
|
File details
Details for the file klinepy-0.3.0-py3-none-any.whl.
File metadata
- Download URL: klinepy-0.3.0-py3-none-any.whl
- Upload date:
- Size: 21.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9106ae514cab0b86aec00a6ff7dd2c98282b23fe1ea9f22d27056a44207765ee
|
|
| MD5 |
1fe1294afbf44149e4bd82a875bcb21d
|
|
| BLAKE2b-256 |
c20272e13ea835c0c78c2b95da9e6123a447846ac742c2e5add84f18f54c09fe
|
