Metadata-Version: 2.1
Name: backtrader-plotly
Version: 1.2.0
Summary: Library replacing original matlibplot used by backtrader
Home-page: https://github.com/lamkashingpaul/backtrader_plotly
Author: Paul Lam
Author-email: lamkashingpaul@gmail.com
License: GPLv3
Project-URL: Bug Tracker, https://github.com/lamkashingpaul/backtrader_plotly/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# 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 -i https://test.pypi.org/simple/ backtrader-plotly==1.1.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
```python
# 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
```


