Merge pull request #2 from matplotlib/master

Update fork with latest version from origin

Author: coffincw

.gitignore

@@ -6,3 +6,4 @@ __pycache__
 *.egg-info
 .tox/
 .cache/
+*.code-workspace

.travis.yml

@@ -8,4 +8,6 @@ matrix:
     - python: 3.8
 install:
   - pip install tox-travis
-script: tox
+script: 
+  - tox
+  - /bin/bash scripts/check_version.sh $TRAVIS_PULL_REQUEST

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+- Contributing can as simple as **asking questions**, participating in discussions, suggesting enhancements, etc.  **All of these are valuable!**  There are many ways to contribute.
+
+- All of the usual/typical open source contribution guidelines apply (see for example, **[Matplotlib Contributing](https://matplotlib.org/3.1.1/devel/contributing.html)** and **[Open Source Guide to Contributing](https://opensource.guide/how-to-contribute/)**).  Therefore, here, on this page, we will mention just a few items that we may be particular about in **mplfinance**.
+
+
+- Coding:
+  - If you write code, please don't use tabs; rather use spaces.
+  - If you add a significant feature --that is, a feature for which explaining its usage takes more than just a few sentences-- please also create a "tutorial notebook" for that feature.  **[For examples of tutorial notebooks, please see the jupyter notebooks in the examples folder.](https://github.com/matplotlib/mplfinance/tree/master/examples)**
+  - If you add a significant feature, please also create a regression test file **[in the tests folder](https://github.com/matplotlib/mplfinance/tree/master/tests)**, similar to the other regression tests that are there.  *Often, the simplest way to do this is to take a few of the examples from the feature's "tutorial notebook"* (see previous point).

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

README.md

@@ -1,26 +1,32 @@
 [![Build Status](https://travis-ci.org/matplotlib/mplfinance.svg?branch=master)](https://travis-ci.org/matplotlib/mplfinance)
 
 # mplfinance
-## matplotlib utilities for the visualization, and visual analysis, of financial data
+matplotlib utilities for the visualization, and visual analysis, of financial data
 
----
+##  Installation
+```bash
+pip install --upgrade mplfinance
+```
+- mplfinance requires [matplotlib](https://pypi.org/project/matplotlib/) and [pandas](https://pypi.org/project/pandas/)
 
-# Installation
-##    `pip install --upgrade mplfinance`
-   - mplfinance requires [matplotlib](https://pypi.org/project/matplotlib/) and [pandas](https://pypi.org/project/pandas/)
+---
 
+## <a name="announcements"></a>**&roarr; [Latest Release Information](https://github.com/matplotlib/mplfinance/blob/master/RELEASE_NOTES.md) &loarr;**
 ---
 
-# Contents
+## <a name="tutorials"></a>Contents and Tutorials
 
   - **[The New API](https://github.com/matplotlib/mplfinance#newapi)**
-  - **[Basic Usage](https://github.com/matplotlib/mplfinance#usage)**
-  - **[Adding Your Own Technical Studies to Plots](https://github.com/matplotlib/mplfinance/blob/master/examples/addplot.ipynb)**
-  - **[Saving the Plot to a File](https://github.com/matplotlib/mplfinance/blob/master/examples/savefig.ipynb)**
-  - **[Customizing the Appearance of Plots](https://github.com/matplotlib/mplfinance/blob/master/examples/customization_and_styles.ipynb)**
-  - **[Price-Movement Plots (Renko, P&F, etc)](https://github.com/matplotlib/mplfinance/blob/master/examples/price-movement_plots.ipynb)**
-  - Technical Studies (presently in development)
-  - **[Latest Release Info](https://github.com/matplotlib/mplfinance#release)**
+  - **[Tutorials](https://github.com/matplotlib/mplfinance#tutorials)**
+    - **[Basic Usage](https://github.com/matplotlib/mplfinance#usage)**
+    - **[Customizing the Appearance of Plots](https://github.com/matplotlib/mplfinance/blob/master/markdown/customization_and_styles.md)** (New features: June 2020)
+    - **[Adding Your Own Technical Studies to Plots](https://github.com/matplotlib/mplfinance/blob/master/examples/addplot.ipynb)**
+    - **[Subplots: Multiple Plots on a Single Figure](https://github.com/matplotlib/mplfinance/blob/master/markdown/subplots.md)** (**New features: August 2020**)
+    - **[Price-Movement Plots (Renko, P&F, etc)](https://github.com/matplotlib/mplfinance/blob/master/examples/price-movement_plots.ipynb)**
+    - **[Trends, Support, Resistance, and Trading Lines](https://github.com/matplotlib/mplfinance/blob/master/examples/using_lines.ipynb)**
+    - **[Saving the Plot to a File](https://github.com/matplotlib/mplfinance/blob/master/examples/savefig.ipynb)**
+    - **[Animation/Updating your plots in realtime](https://github.com/matplotlib/mplfinance/blob/master/markdown/animation.md)** (**New: August 2020**)
+  - **&roarr; [Latest Release Info](https://github.com/matplotlib/mplfinance/blob/master/RELEASE_NOTES.md) &loarr;**
   - **[Some Background History About This Package](https://github.com/matplotlib/mplfinance#history)**
   - **[Old API Availability](https://github.com/matplotlib/mplfinance#oldapi)**
 
@@ -51,7 +57,7 @@ I am very interested to hear from you regarding what you think of the new `mplfi
 
 ---
 
-# <a name="usage"></a>Basic Usage
+## <a name="usage"></a>Basic Usage
 Start with a Pandas DataFrame containing OHLC data.  For example,
 
 
@@ -163,7 +169,6 @@ daily.tail(3)
 </table>
 
 
----
 <br>
 
 After importing mplfinance, plotting OHLC data is as simple as calling `mpf.plot()` on the dataframe
@@ -178,7 +183,6 @@ mpf.plot(daily)
 ![png](https://raw.githubusercontent.com/matplotlib/mplfinance/master/readme_files/readme_4_1.png)
 
 
----
 <br>
 
 The default plot type, as you can see above, is `'ohlc'`.  Other plot types can be specified with the keyword argument `type`, for example, `type='candle'`, `type='line'`, `type='renko'`, or `type='pnf'`
@@ -377,7 +381,7 @@ intraday.tail(3)
 
 
 
-The above dataframe contains Open,High,Low,Close data at 1 minute intervervals for the S&P 500 stock index for November 5, 6, 7 and 8, 2019.  Let's look at the last hour of trading on November 6th, with a 7 minute and 12 minute moving average.
+The above dataframe contains Open,High,Low,Close data at 1 minute intervals for the S&P 500 stock index for November 5, 6, 7 and 8, 2019.  Let's look at the last hour of trading on November 6th, with a 7 minute and 12 minute moving average.
 
 
 ```python
@@ -568,22 +572,6 @@ mpf.plot(df[700:850],type='bars',volume=True,mav=(20,40))
 
 For more examples of using mplfinance, please see the jupyter notebooks in the **[`examples`](https://github.com/matplotlib/mplfinance/blob/master/examples/)** directory.
 
----
- 
-# <a name="release"></a>Release Notes
-
-| Version  |  Description   | Release Date |
-|:---------|:-------------|:---------------|
-| 0.12.3a3   | - `linecolor` kwarg for line plots<br> - implement save figure to in-memory buffer<br> -- Thank you Caleb Coffin @coffincw for contributing the above. | 2020-03-04 |
-| 0.12.3a2   | - implement custom markers (issue#30)<br> - fix minor issue with chart `type` validator<br> -- Thank you Amir Atashin @amiaty for contributing the above.<br> - add internal functions: `_bypass_kwarg_validation()` and `_kwarg_not_implemented()` | 2020-02-21 |
-| 0.12.3a1   | - fix issue#28: math.log crash on zero in data<br> - remove "Implemented" field from kwarg dicts<br> - yahoo style show colors for `ohlc bars` | 2020-02-16 |
-| 0.12.3a0   | - kwarg `block=False` for non-blocking call to `mpf.plot()`<br> - customize aspect ratio, figure title, y-labels<br> - customize colors and other `style` aspects of plot<br> - `no_xgaps` now defaults to True: use `show_nontrading=True` to set no_xgaps to false<br> - secondary y-axis available to `make_addplot()`<br> - bug fix for volume widths | 2020-02-12 |
-| 0.12.0a3   | Increase mav limit from 3 to 7 different mavs  | 2020-01-16 |
-| 0.12.0a2   | Ability to save plot to a file (pdf, svg, png, jpg, ...) | 2020-01-14 |
-| 0.12.0a1   | Ability to 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 |
-| 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-12-20  |
-| 0.10.x   | Old mpl-finance API set up as its own package<br> (i.e. removed from the matplotlib package). | 2016-09-08   |
-
 ---
 
 ## <a name="history"></a>Some History
@@ -592,9 +580,12 @@ My name is Daniel Goldfarb.  In November 2019, I became the maintainer of `matpl
 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`.
 
 ---
-### <a name="oldapi"></a>old API availability
+## <a name="oldapi"></a>Old API availability
+
+**With this new ` mplfinance ` package installed, in addition to the new API, users can still access the old API**.<br> The old API may be removed someday, but for the foreseeable future we will keep it ... at least until we are very confident that users of the old API can accomplish the same things with the new API.  
+
+To access the old API with the new ` mplfinance ` package installed, change the old import statments
 
-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>
 **from:**
 
 ```python
@@ -615,10 +606,3 @@ where `<method>` indicates the method you want to import, for example:
 ```python
     from mplfinance.original_flavor import candlestick_ohlc
 ```
-
----
-
-
-```python
-
-```