Merge pull request #112 from DanielGoldfarb/master

implement "lines" and other changes

Author: DanielGoldfarb

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+- 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/)**)
+so here, on this page, we will mention just a few items for which we may be particular 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).

README.md

@@ -11,16 +11,17 @@
 
 ---
 
-# 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)**
+    - **[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)**
+    - **[Trends, Support, Resistance, and Trading Lines](https://github.com/matplotlib/mplfinance/blob/master/examples/using_lines.ipynb)**
+  - **[Latest Release Info](https://github.com/matplotlib/mplfinance/blob/master/RELEASE_NOTES.md)**
   - **[Some Background History About This Package](https://github.com/matplotlib/mplfinance#history)**
   - **[Old API Availability](https://github.com/matplotlib/mplfinance#oldapi)**
 
@@ -568,22 +569,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
@@ -594,7 +579,12 @@ It is my intention to archive the `matplotlib/mpl-finance` repository soon, and
 ---
 ### <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 (at least for the next several months) by changing their import statments<br>
+**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 some day, 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
+
 **from:**
 
 ```python

RELEASE_NOTES.md

@@ -0,0 +1,67 @@
+- **v0.12.4a0       Released 2020-05-01**
+
+  - regression tests for new API
+  - **[Renko plots](https://github.com/matplotlib/mplfinance/blob/master/examples/price-movement_plots.ipynb)** [(issue #11)](https://github.com/matplotlib/mplfinance/issues/11)     (Thank you [Caleb Coffin @coffincw](https://github.com/coffincw))
+  - **`style='binance'`**     (Thank you [@akgna](https://github.com/akgnah))
+  - return Figure and Axes (**`return_fig=True`**) ([issue #46](https://github.com/matplotlib/mplfinance/issues/46))
+  - check that inputs are all float, and rename IPython.display.Iamge to avoid confusion with PIL.Image
+  - ability to **`return_calculated_values=True`** ([issue #63](https://github.com/matplotlib/mplfinance/issues/63))     (Thank you [@WHug0](https://github.com/WHug0))
+  - **[Point and Figure (`type='pnf'`) plots.](https://github.com/matplotlib/mplfinance/blob/master/examples/price-movement_plots.ipynb)**      (Thank you [Caleb Coffin @coffincw](https://github.com/coffincw))
+  - custom column names     (Thank you [@borgstrom](https://github.com/borgstrom))
+  - **`set_ylim`** and **`set_ylim_panelB`** kwargs
+  - **`hlines`**, **`vlines`**, **`alines`**, **`tlines`** **[Trend, Support, Resistance, and Trading/Signal lines](https://github.com/matplotlib/mplfinance/blob/master/examples/using_lines.ipynb)**
+    - (Thank you [Aaron Soellinger @free-soellingeraj](https://github.com/free-soellingeraj) for writing regression tests for this.)
+  
+  
+
+---
+- **v0.12.3a3       Released 2020-03-04**
+
+  - `linecolor` kwarg for line plots     (Thank you Caleb Coffin @coffincw)
+  - implement save figure to in-memory buffer     (Thank you Caleb Coffin @coffincw)
+---
+- **v0.12.3a2      Released 2020-02-21**
+
+  - implement custom markers (issue#30)     (Thank you Amir Atashin @amiaty)
+  - fix minor issue with chart `type` validator     (Thank you Amir Atashin @amiaty)
+  - add internal functions: `_bypass_kwarg_validation()` and `_kwarg_not_implemented()`
+---
+- **v0.12.3a1      Released 2020-02-16**
+
+  - fix issue#28: math.log crash on zero in data
+  - remove "Implemented" field from kwarg dicts
+  - yahoo style show colors for `ohlc bars`
+---
+- **v0.12.3a0       Released 2020-02-12**
+
+  - kwarg `block=False` for non-blocking call to `mpf.plot()`
+  - customize aspect ratio, figure title, y-labels
+  - customize colors and other `style` aspects of plot
+  - `no_xgaps` now defaults to True: use `show_nontrading=True` to set no_xgaps to false
+  - secondary y-axis available to `make_addplot()`
+  - bug fix for volume widths
+---
+- **v0.12.0a3       Released 2020-01-16**
+
+  - Increase mav limit from 3 to 7 different mavs
+---
+- **v0.12.0a2       Released 2020-01-14**
+
+  - Ability to save plot to a file (pdf, svg, png, jpg, ...)
+---
+- **v0.12.0a1       Released 2020-01-09**
+
+  - Ability to plot arbitrary user data (in addition to basic OHLCV data).
+  - both line and scatter plots available.
+  - optionally plot on either the "main" or "lower" (aka "volume") axis.
+---
+- **v0.11.x       Released 2019-12-20**
+
+  - Basic Plotting from Pandas DataFrame of OHLC bars and candlesticks.
+  - optional display of volume
+  - optional display of (up to 3 different) moving averages.
+  - old API still available by importing from "mplfinance/original_flavor"
+---
+- **v0.10.x       Released 2016-09-08**
+
+  - Old mpl-finance API set up as its own package<br>(i.e. removed from the matplotlib package).

TODO.md

@@ -0,0 +1,18 @@
+# Wish List - TODO - To Prioritize
+
+ 1. pass in Figure and Axes enhancement
+ 2. clean up code for easier maintenance
+ 3. debug issue#77:
+    - ylimit diff scatter() vs plot()
+    - ylimit vs how subplot is created.
+ 4. how use configuration file
+ 5. auto-pull updates for config file. possible?
+ 6. collect anonymous data on feature usage
+ 7. wrappers for technical studies.
+ 8. force version change with each Pull Request
+ 9. tagging releases
+10. documentation (replace old `https://matplotlib.org/api/finance_api.html`)
+11. make code more efficient (ex: tlines reconstructing data frame).
+12. add 'description' to valid kwargs table, and kwarg to print
+    all kwargs information (kwarg and short description).
+