Skip to content

Commit 3aba464

Browse files
author
Daniel Goldfarb
committed
update README
1 parent 135bf13 commit 3aba464

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,19 @@
1111

1212
---
1313

14-
# Usage
14+
# Contents
15+
16+
- **[Basic Usage](#usage)**
17+
- **[Adding Custom Data to Ohlcv Plots](https://github.com/DanielGoldfarb/mplfinance/blob/master/examples/addplot.ipynb)**
18+
- Customizing the Appearance of Plots (presently in development)
19+
- Technical Studies (presently in development)
20+
- **[Latest Release Info](#release)**
21+
- **[Some Background History About This Package](#history)**
22+
- **[Old API Availability](#oldapi)**
23+
24+
---
25+
26+
# <a name="usage"></a>Basic Usage
1527
Start with a Pandas DataFrame containing OHLC data. For example,
1628

1729
```python
@@ -500,14 +512,19 @@ For more examples of using mplfinance, please see the jupyter notebooks in the `
500512
- technical studies, such as:
501513
- Trading Envelope, Bollinger Bands
502514
- MACD
503-
- custom studies and/or additional data on plot
504-
- Ability to plot specified additional columns from DataFrame either within the main ohlc plot, or only the lower axis where volume may be displayed.
505515
- save plot to file
506516

517+
# <a name="release"></a>Release Notes
518+
519+
| Version | Description | Release Date |
520+
|----------|--------------|----------------|
521+
| 0.12.x | Ability plot arbitrary user data (in addition to basic OHLCV data).<br> - both line and scatter plots available.<br> - optionally plot on either the "main" or "lower" (aka "volume") axis. | 2020-01-09 |
522+
| 0.11.x | Basic Plotting from Pandas DataFrame of OHLC bars and candlesticks.<br> - optional display of volume<br> - optional display of (up to 3 different) moving averages.<br> - old API still available by importing from "mplfinance/original_flavor" | 2019-13-20 |
523+
| 0.10.x | Old mpl-finance API set up as its own package<br> (i.e. removed from the matplotlib package). | 2016-09-08 |
507524

508525
---
509526

510-
## Some History
527+
## <a name="history"></a>Some History
511528
My name is Daniel Goldfarb. In November 2019, I became the maintainer of `matplotlib/mpl-finance`. That module is being deprecated in favor of the current `matplotlib/mplfinance`. The old `mpl-finance` consisted of code extracted from the deprecated `matplotlib.finance` module along with a few examples of usage. It has been mostly un-maintained for the past three years.
512529

513530
It is my intention to archive the `matplotlib/mpl-finance` repository soon, and direct everyone to `matplotlib/mplfinance`. The main reason for the rename is to avoid confusion with the hyphen and the underscore: As it was, `mpl-finance` was *installed with the hyphen, but imported with an underscore `mpl_finance`.* Going forward it will be a simple matter of both installing and importing `mplfinance`.
@@ -535,7 +552,7 @@ The most common usage is to then call `mpf.plot(data)` where `data` is a `Pandas
535552
I am very interested to hear from you regarding how you were using the old `mpl-finance` (if you were), what you think of the new `mplfinance`, plus any suggestions you may have for improvement. You can reach me at [email protected]
536553

537554
---
538-
### old API availability
555+
### <a name="oldapi"></a>old API availability
539556

540557
With this new ` mplfinance ` package installed, in addition to the new API, users can still access the old API (at least for the next several months) by changing their import statments<br>
541558
**from:**

0 commit comments

Comments
 (0)