Merge pull request #153 from DanielGoldfarb/master

Version 0.12.5 Enhancements and Bug Fixes

Author: DanielGoldfarb

CONTRIBUTING.md

@@ -1,10 +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/)**)
-so here, on this page, we will mention just a few items for which we may be particular in **mplfinance**.
+- 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 --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,22 @@
 
 ---
 
+# <a name="announcements"></a>Announcing Version 0.12.5 Enhancements
+### [Version 0.12.5 brings a number of enhancements to mplfinance. Click here for full details.](https://github.com/matplotlib/mplfinance/blob/master/RELEASE_NOTES.md)
+
+---
+
 # <a name="tutorials"></a>Contents and Tutorials
 
   - **[The New API](https://github.com/matplotlib/mplfinance#newapi)**
   - **[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)**
-    - **[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)**
+    - **[Subplots: Multiple Plots on a Single Figure](https://github.com/matplotlib/mplfinance/blob/master/markdown/subplots.md)** (**New** June 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)**
   - **[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)**

RELEASE_NOTES.md

@@ -1,4 +1,41 @@
-- **v0.12.4a0       Released 2020-05-01**
+### <a name="v0.12.5a0"></a>v0.12.5a0 &nbsp;&nbsp;&nbsp;&nbsp; Released Date 2020-06-10
+#### Enhancements
+- **[Subplots: Create up to 10 "panels"](https://github.com/matplotlib/mplfinance/blob/master/markdown/subplots.md)**
+  - Can modify relative sizes of panels
+  - Can modify which is "main" panel
+  - Can modify which is "volume" panel
+  - addplot can plot to any panel
+  - MACD example
+- support bar charts in make_addplot (`type=` 'line', 'scatter', or 'bar')
+- make_addplot scatter now supports *sequence of markers* and sequence of colors<br>(Thank you [Elan Ernest](https://github.com/ImportanceOfBeingErnest) for posting the [sequence of markers solution here](https://github.com/matplotlib/matplotlib/issues/11155#issuecomment-385939618))
+- ability to custom format date/time labels ( ` datetime_format= `) (Thank you [Cam McLean](https://github.com/cammclean182))
+- ability to rotate date/time labels (` xrotation= `)
+- ability to turn axis off (`axisoff=True`) (Thank you [Will Whitty](https://github.com/tavurth) for testing, code review, and contributing code changes)
+- support ` tight_layout=True `
+- support ` fill_between= `
+- new algorithm for adjustment of candle widths, line widths, volume widths, ohlc tick widths **default change** (Thank you [Charles](https://github.com/char101) for your help).
+  - ability to scale the algorithm (up or down)
+  - ability to override the algorithm (i.e. set width and linewidth of volume bars, candles, ohlc bars. (iss num 81))
+- close plot when not needed to stay open **default change**
+  - fixes "20 open plots" warning
+  - removed code to close plots from regression tests: no longer needed
+- support NaNs in data to indicate missing data (also fix bug related to min/max and mav when NaNs in data) **default change** (Thank you [Charles](https://github.com/char101) for your help)
+  - allows display low liquidity
+  - remove support for -1 meaning missing data.  -1 is now considered valid data.
+- Travis check to ensure each Pull Request has a new version (Thank you [Aaron Soellinger](https://github.com/free-soellingeraj))
+- remove rcParams context: modifications made by mplfinance are now availabile after calling mplfinance. **default change**
+
+#### Bug Fixes
+  - fix bug displaying a single candle
+  - fix bug "StatisticsError" when only a single data point
+  - fix poor choice of default color for ` type=line ` chart **default change**
+  - fix `savefig` Figure Facecolor bug
+  - fix ohlc bars color in "blueskies" style **default change**
+
+---
+---
+
+### v0.12.4a0  &nbsp;&nbsp;&nbsp;&nbsp; Release Date 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) &nbsp;&nbsp;&nbsp;&nbsp;(Thank you [Caleb Coffin @coffincw](https://github.com/coffincw))

TODO.md

@@ -1,18 +1,13 @@
 # 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).
+- pass in Figure and Axes enhancement
+- clean up code for easier maintenance
+- how use configuration file
+- auto-pull updates for config file. possible?
+- collect anonymous data on feature usage
+- wrappers for technical studies.
+- documentation (replace old `https://matplotlib.org/api/finance_api.html`)
+- make code more efficient (ex: tlines reconstructing data frame).
+  - **daily plot slower than intraday ???**
+- add 'description' to valid kwargs table, and kwarg to print all kwargs information (kwarg and short description).