Create classic technical analysis stock charts in Python with minimal code.
The library is built around matplotlib
and supports both pandas
and polars DataFrames.
Charts can be defined using a declarative interface,
based on a set of drawing primitives like Candlesticks, Volume
and technical indicators like SMA, EMA, RSI, ROC, MACD, etc ...
Warning
This project is experimental and the interface is likely to change. For a related project with a mature api you may want to look into mplfinance.
# Candlesticks chart with SMA, RSI and MACD indicators
import yfinance as yf
from mplchart.chart import Chart
from mplchart.primitives import Candlesticks, Volume, Pane, LinePlot
from mplchart.indicators import SMA, RSI, MACD
ticker = 'AAPL'
prices = yf.Ticker(ticker).history('5y')
Chart(prices, title=ticker, max_bars=250, normalize=True).plot(
Candlesticks(), Volume(), SMA(50), SMA(200),
Pane("above", yticks=(30, 50, 70)),
LinePlot(RSI(14), overbought=70, oversold=30),
Pane("below"),
MACD(),
).show()Prices data is expected to be a dataframe with columns open, high, low, close, volume in lower case and a datetime column named date or datetime (or a datetime index for pandas).
If your data has column names in different capitalization (like data from yfinance) use the normalize option Chart(..., normalize=True) or call normalize_prices explicitely to normalize the dataframe.
# Normalize prices to lower case column names
import yfinance as yf
from mplchart.utils import normalize_prices
prices = normalize_prices(yf.Ticker(ticker).history('5y'))The library contains drawing primitives that can be used like an indicator in the plot api. Primitives are classes and must be instantiated as objects before being used with the plot api.
# Candlesticks chart
from mplchart.chart import Chart
from mplchart.primitives import Candlesticks
Chart(prices, title=title, max_bars=250).plot(
Candlesticks()
).show()The main drawing primitives are :
Candlesticksfor candlestick plotsOHLCfor open, high, low, close bar plotsVolumefor volume bar plotsPaneto switch to a different pane (above or below)LinePlotdraw an indicator as line plotAreaPlotdraw an indicator as area plotBarPlotdraw an indicator as bar plotStripesto shade background areas where a condition is activeMarkersto mark signal crossings with symbolsZigZaglines between pivot pointsSwingsto mark local peaks and valleys (swing highs/lows)HLineto draw a horizontal reference line on the current paneVLineto draw a vertical line across all panes at a given date
The library includes some standard technical analysis indicators for pandas DataFrames.
Indicators are classes and must be instantiated as objects before being used with the plot api.
Instantiated they are callables, you can apply them like calling a function SMA(50)(prices).
Some of the indicators included are:
SMASimple Moving AverageEMAExponential Moving AverageWMAWeighted Moving AverageHMAHull Moving AverageRMARolling Moving Average (Wilder's)DEMADouble Exponential Moving AverageTEMATriple Exponential Moving AverageMOMMomentumROCRate of ChangeRSIRelative Strength IndexADXAverage Directional IndexDMIDirectional Movement IndexMACDMoving Average Convergence DivergencePPOPrice Percentage OscillatorBOPBalance of PowerCMFChaikin Money FlowMFIMoney Flow IndexSTOCHStochastic OscillatorTRANGETrue RangeATRAverage True RangeNATRNormalized Average True RangeBBANDSBollinger BandsBBPBollinger Bands PercentBBWBollinger Bands WidthKELTNERKeltner ChannelDONCHIANDonchian ChannelMEDPRICEMedian PriceTYPPRICETypical PriceWCLPRICEWeighted Close PriceAVGPRICEAverage Price
Pass an indicator to a rendering primitive to customize display — the @ binding operator is an equivalent alternative:
# Customizing indicator style with LinePlot
from mplchart.indicators import SMA, EMA, ROC
from mplchart.primitives import Candlesticks, LinePlot
indicators = [
Candlesticks(),
LinePlot(SMA(20), style="dashed", color="red", alpha=0.5, width=3)
]
Chart(prices).plot(indicators)For polars DataFrames, the expressions subpackage provides polars Expr factories
as an alternative to the indicator pattern.
These can be used directly with chart.plot().
# Candlesticks chart with polars expressions
from mplchart.chart import Chart
from mplchart.primitives import Candlesticks, Volume, Pane, LinePlot
from mplchart.expressions import SMA, EMA, RSI, MACD
Chart(prices, title=ticker, max_bars=250).plot(
Candlesticks(), Volume(), SMA(50), SMA(200),
Pane("above", yticks=(30, 50, 70)),
LinePlot(RSI(), overbought=70, oversold=30),
Pane("below"),
MACD(),
).show()Expressions are plain polars.Expr values — they can be composed with standard polars operators,
passed to df.select(), or used anywhere polars expressions are accepted.
Pass an expression to a rendering primitive to customize display — the @ binding operator is an equivalent alternative:
from mplchart.primitives import LinePlot, AreaPlot
from mplchart.expressions import SMA, RSI
LinePlot(SMA(50), color="red") # expression → primitive
AreaPlot(RSI(14), color="blue") # expression → primitive
SMA(50) @ LinePlot(color="red") # operator formIf you have ta-lib installed you can use its abstract functions as indicators. They are created by calling the Function factory with the name of the function and its parameters. Ta-lib functions work with both pandas and polars backends.
# Candlesticks chart with talib functions
from mplchart.primitives import Candlesticks
from talib.abstract import Function
indicators = [
Candlesticks(),
Function('SMA', 50),
Function('SMA', 200),
]
Chart(prices).plot(indicators).show()Example notebooks live in the examples/ folder.
pip install mplchartThe indicators module requires pandas; the expressions module requires polars.
If either is already in your environment, mplchart will use it automatically.
The [pandas], [polars], and [all] extras are just a convenience — they
install pandas or polars alongside mplchart, nothing more:
pip install mplchart[pandas]
pip install mplchart[polars]
pip install mplchart[all]Required:
- python >= 3.10
- matplotlib
- numpy
- pyarrow
Optional extras:
[pandas]— pandas[polars]— polars[all]— pandas and polars
- mplfinance - Matplotlib utilities for the visualization, and visual analysis, of financial data
- cufflinks - Productivity Tools for Plotly + Pandas
- matplotlib - Matplotlib: plotting with Python
- pandas - Flexible and powerful data analysis / manipulation library for Python
- polars - Fast DataFrame library for Python
- yfinance - Download market data from Yahoo! Finance's API