Merge pull request #13 from DanielGoldfarb/master

Implement `savefig` to save plot to file.

Author: DanielGoldfarb

.github/ISSUE_TEMPLATE/ask-a-question.md

@@ -2,7 +2,7 @@
 name: Ask a Question
 about: Question about usage, project priorities, or anything else related to mplfinance.
 title: ''
-labels: ''
+labels: 'question'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,8 +1,8 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
+title: 'Bug Report:'
+labels: 'bug'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,8 +1,8 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
+title: 'Feature Reuest:'
+labels: 'enhancement'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/feedback.md

@@ -1,8 +1,8 @@
 ---
 name: Feedback
 about: What do you think of mplfinance?  Pros? Cons?  Thoughts?
-title: ''
-labels: ''
+title: 'Comment:'
+labels: 'feedback'
 assignees: ''
 
 ---

README.md

@@ -16,6 +16,7 @@
   - **[The New API](https://github.com/matplotlib/mplfinance#newapi)**
   - **[Basic Usage](https://github.com/matplotlib/mplfinance#usage)**
   - **[Adding Custom Data to Ohlcv 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 (presently in development)
   - Technical Studies (presently in development)
   - **[Latest Release Info](https://github.com/matplotlib/mplfinance#release)**
@@ -535,7 +536,7 @@ For more examples of using mplfinance, please see the jupyter notebooks in the `
 
 | Version  |  Description   | Release Date |
 |----------|--------------|----------------|
-| 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 |
+| 0.12.x   | 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   |
 
@@ -567,3 +568,5 @@ where `<method>` indicates the method you want to import, for example:
 ```python
     from mplfinance.original_flavor import candlestick_ohlc
 ```
+---
+

examples/savefig.ipynb

@@ -1,4 +1,4 @@
-version_info = (0, 12, 0, 'alpha', 1)
+version_info = (0, 12, 0, 'alpha', 2)
 
 _specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}
 

src/mplfinance/_version.py

@@ -97,6 +97,11 @@ def _valid_kwargs_table():
                           'Implemented' : True,
                           'Validator'   : lambda value: isinstance(value,dict) or (isinstance(value,list) and all([isinstance(d,dict) for d in value])) },
 
+        'savefig'     : { 'Default'     : None, 
+                                          
+                          'Implemented' : True,
+                          'Validator'   : lambda value: isinstance(value,dict) or isinstance(value,str) },
+ 
     }
     # Check that we didn't make a typo in any of the things above:
     #  that should otherwise be the same for all kwags:
@@ -355,7 +360,14 @@ def plot( data, **kwargs ):
         vol_label = 'Volume x '+str(offset)
         ax2.set_ylabel(vol_label,size='x-large',weight='semibold')
 
-    plt.show()
+    if config['savefig'] is not None:
+        save = config['savefig']
+        if isinstance(save,dict):
+            plt.savefig(**save)
+        else:
+            plt.savefig(save)
+    else:
+        plt.show()
 
 def _valid_addplot_kwargs_table():