Skip to main content

Library replacing original matlibplot used by backtrader

Project description

backtrader_plotly

Plot backtrader's result using plotly instead of the default matplotlib

This is an experimental package, and it is done by replacing original matplotlib method calls.

Installation

$ pip install backtrader-plotly==1.3.0

New Scheme Arguments

New scheme arguments are added to provide extra control

Name of Argument Default Value Description
decimal_places 5 It is used to control the number of decimal places of price shown on the plot. For instance, forex price usually consists of 5 decimal places.
max_legend_text_width 16 It is used to limit the legend text width to prevent it from occupying the page.

Usage

# import the package after installation
from backtrader_plotly.plotter import BacktraderPlotly
from backtrader_plotly.scheme import PlotScheme
import plotly.io

# do whatever you want with `backtrader`
import backtrader as bt

# for instance
cerebro = bt.Cerebro()

# after adding data and strategy
cerebro.run()

# define plot scheme with new additional scheme arguments
scheme = PlotScheme(decimal_places=5, max_legend_text_width=16)

# plot and save figures as `plotly` graph object
figs = cerebro.plot(BacktraderPlotly(show=True, scheme=scheme))
figs = [x for fig in figs for x in fig]  # flatten output
for fig in figs:
    plotly.io.to_html(fig, full_html=False)  # open html in the browser
    plotly.io.write_html(fig, file='plot.html')  # save the html file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backtrader_plotly-1.4.0.dev1.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

backtrader_plotly-1.4.0.dev1-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file backtrader_plotly-1.4.0.dev1.tar.gz.

File metadata

  • Download URL: backtrader_plotly-1.4.0.dev1.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for backtrader_plotly-1.4.0.dev1.tar.gz
Algorithm Hash digest
SHA256 1bdd52e89bee021b3d0b6ff960827e02392166a85194b633e254899de48a18b3
MD5 84a16817fa54ba6b7f566bc27d8da1f5
BLAKE2b-256 673adf1fafeaaf0a80d23b7bc5d4f17ad3f868a1a1b7eff257be96853a78182c

See more details on using hashes here.

File details

Details for the file backtrader_plotly-1.4.0.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for backtrader_plotly-1.4.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 82f72a54cad6dd182121f822020dc3e4517c1bb2f2b2e54dd38a742583370888
MD5 024603862876e4e2d7a09475ee233de3
BLAKE2b-256 01f07c2bd65857d948559790c2d1fef622ea9591bfbe0fc75fe09f20613593f5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page