0.9.4 release setup

- docs/ updated - added index examples to README.md and script response parsed as markdown - release setup
alvarobartt · Sep 24, 2019 · 03235ea · 03235ea
1 parent 73f043e
commit 03235ea
Show file tree

Hide file tree

Showing 26 changed files with 100 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@
 ## Introduction
 
 investpy is a Python package to retrieve real-time historical data from [Investing](https://www.investing.com/). 
-It provides historical data retrieval from up to **28.121 equities, 4.120 funds and 8.755 etfs**. Basically, 
+It provides historical data retrieval from up to **28.121 equities, 4.120 funds, 8.755 etfs and 385 indices**. Basically, 
 it allows you to download historical data from all the indexed equities, funds and etfs in Investing.com. Therefore,
 investpy is intended to wrap up all the available data from Investing, so that it can be retrieved via Python for 
 its further usage and/or analysis.
@@ -31,7 +31,7 @@ are some of the features that currently lead investpy to be one of the most cons
 In order to get this package working you will need to install [**investpy**](https://pypi.org/project/investpy/) using 
 pip on the terminal by typing:
 
-``$ pip install investpy==0.9.3``
+``$ pip install investpy==0.9.4``
 
 Every package used is listed in [requirements.txt](https://github.com/alvarob96/investpy/blob/master/requirements.txt) 
 file, which can also be installed via pip:
@@ -57,8 +57,8 @@ import investpy
 df = investpy.get_recent_data(equity='bbva',
                               country='spain')
 print(df.head())
-
->>>
+```
+```{r, engine='python', count_lines}
              Open   High    Low  Close    Volume Currency
 Date                                                     
 2019-08-13  4.263  4.395  4.230  4.353  27250000      EUR
@@ -77,16 +77,15 @@ df = investpy.get_historical_data(equity='bbva',
                                   from_date='01/01/2010',
                                   to_date='01/01/2019')
 print(df.head())
-
->>>
+```
+```{r, engine='python', count_lines}
              Open   High    Low  Close  Volume Currency
 Date                                                   
 2010-01-04  12.73  12.96  12.73  12.96       0      EUR
 2010-01-05  13.00  13.11  12.97  13.09       0      EUR
 2010-01-06  13.03  13.17  13.02  13.12       0      EUR
 2010-01-07  13.02  13.11  12.93  13.05       0      EUR
 2010-01-08  13.12  13.22  13.04  13.18       0      EUR
-
 ```
 
 #### Fund Data Retrieval
@@ -97,8 +96,8 @@ import investpy
 df = investpy.get_fund_recent_data(fund='bbva plan multiactivo moderado pp',
                                    country='spain')
 print(df.head())
-
->>>
+```
+```{r, engine='python', count_lines}
              Open   High    Low  Close Currency
 Date                                           
 2019-08-13  1.110  1.110  1.110  1.110      EUR
@@ -117,8 +116,8 @@ df = investpy.get_fund_historical_data(fund='bbva plan multiactivo moderado pp',
                                        from_date='01/01/2010',
                                        to_date='01/01/2019')
 print(df.head())
-
->>>
+```
+```{r, engine='python', count_lines}
              Open   High    Low  Close Currency
 Date                                           
 2018-02-15  1.105  1.105  1.105  1.105      EUR
@@ -137,8 +136,8 @@ import investpy
 df = investpy.get_etf_recent_data(etf='bbva accion dj eurostoxx 50',
                                   country='spain')
 print(df.head())
-
->>>
+```
+```{r, engine='python', count_lines}
               Open    High     Low   Close Currency
 Date                                               
 2019-08-13  33.115  33.780  32.985  33.585      EUR
@@ -157,8 +156,8 @@ df = investpy.get_etf_historical_data(etf='bbva accion dj eurostoxx 50',
                                       from_date='01/01/2018',
                                       to_date='01/01/2019')
 print(df.head())
-
->>>
+```
+```{r, engine='python', count_lines}
              Open   High    Low  Close Currency
 Date                                           
 2011-12-07  23.70  23.70  23.70  23.62      EUR
@@ -169,6 +168,46 @@ Date
 
 ```
 
+#### Index Data Retrieval
+
+```python
+import investpy
+
+df = investpy.get_index_recent_data(index='ibex 35',
+                                    country='spain')
+print(df.head())
+```
+```{r, engine='python', count_lines}
+               Open     High      Low    Close   Volume Currency
+Date
+2019-08-26  12604.7  12646.3  12510.4  12621.3  4770000      EUR
+2019-08-27  12618.3  12723.3  12593.6  12683.8  8230000      EUR
+2019-08-28  12657.2  12697.2  12585.1  12642.5  7300000      EUR
+2019-08-29  12637.2  12806.6  12633.8  12806.6  5650000      EUR
+2019-08-30  12767.6  12905.9  12756.9  12821.6  6040000      EUR
+
+```
+
+```python
+import investpy
+
+df = investpy.get_index_historical_data(index='ibex 35',
+                                        country='spain',
+                                        from_date='01/01/2018',
+                                        to_date='01/01/2019')
+print(df.head())
+```
+```{r, engine='python', count_lines}
+               Open     High      Low    Close    Volume Currency
+Date
+2018-01-02  15128.2  15136.7  14996.6  15096.8  10340000      EUR
+2018-01-03  15145.0  15186.9  15091.9  15106.9  12800000      EUR
+2018-01-04  15105.5  15368.7  15103.7  15368.7  17070000      EUR
+2018-01-05  15353.9  15407.5  15348.6  15398.9  11180000      EUR
+2018-01-08  15437.1  15448.7  15344.0  15373.3  12890000      EUR
+
+```
+
 ### Additional Data
 
 As Investing provides more data besides the historical one, some of that additional data can be fetched via investpy. 
@@ -183,8 +222,9 @@ import investpy
 company_profile = investpy.get_equity_company_profile(equity='bbva',
                                                       country='spain')
 print(company_profile)
-
->>> "Banco Bilbao Vizcaya Argentaria, S.A. (BBVA) is a diversified financial company engaged in retail banking ..."
+```
+```{r, engine='python', count_lines}
+"Banco Bilbao Vizcaya Argentaria, S.A. (BBVA) is a diversified financial company engaged in retail banking ..."
 ```
 
 #### Fund Additional Information Retrieval
@@ -196,8 +236,9 @@ fund_information = investpy.get_fund_information(fund='bbva plan multiactivo mod
                                                  country='spain',
                                                  as_json=True)
 print(fund_information)
-
->>> {
+```
+```{r, engine='python', count_lines}
+{
  'Fund Name': 'Bbva Plan Multiactivo Moderado Pp',
  'Rating': 4,
  '1-Year Change': '-1,19%',

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: fe5b37d19b9697c8d862d6a99d122e52
+config: 6bbd81e509dbe8888f7b66b16a5d8112
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/installation.rst.txt b/docs/_build/html/_sources/installation.rst.txt
@@ -5,7 +5,7 @@ Installation
 
 .. note::
 
-    After installing the package you are now available to use it! As investpy's latest release is 0.9.3 the installation is
+    After installing the package you are now available to use it! As investpy's latest release is 0.9.4 the installation is
     optimized for it. If you try installing another investpy release, some features may not work.
 
 First Installation

diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.9.3',
+    VERSION: '0.9.4',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>API Reference &mdash; investpy 0.9.3 documentation</title>
+  <title>API Reference &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/disclaimer.html b/docs/_build/html/disclaimer.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Disclaimer &mdash; investpy 0.9.3 documentation</title>
+  <title>Disclaimer &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/equities.html b/docs/_build/html/equities.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Stocks/Equities &mdash; investpy 0.9.3 documentation</title>
+  <title>Stocks/Equities &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/equities_api.html b/docs/_build/html/equities_api.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>investpy.equities &mdash; investpy 0.9.3 documentation</title>
+  <title>investpy.equities &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/etfs_api.html b/docs/_build/html/etfs_api.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>investpy.etfs &mdash; investpy 0.9.3 documentation</title>
+  <title>investpy.etfs &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/funds_api.html b/docs/_build/html/funds_api.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>investpy.funds &mdash; investpy 0.9.3 documentation</title>
+  <title>investpy.funds &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; investpy 0.9.3 documentation</title>
+  <title>Index &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Welcome to investpy’s documentation! &mdash; investpy 0.9.3 documentation</title>
+  <title>Welcome to investpy’s documentation! &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/information.html b/docs/_build/html/information.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Additional Information &mdash; investpy 0.9.3 documentation</title>
+  <title>Additional Information &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 

diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Installation &mdash; investpy 0.9.3 documentation</title>
+  <title>Installation &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>
 
 
@@ -166,7 +166,7 @@
 <span id="installation-label"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>After installing the package you are now available to use it! As investpy’s latest release is 0.9.3 the installation is
+<p>After installing the package you are now available to use it! As investpy’s latest release is 0.9.4 the installation is
 optimized for it. If you try installing another investpy release, some features may not work.</p>
 </div>
 <div class="section" id="first-installation">

diff --git a/docs/_build/html/introduction.html b/docs/_build/html/introduction.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Introduction &mdash; investpy 0.9.3 documentation</title>
+  <title>Introduction &mdash; investpy 0.9.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.3
+                0.9.4
               </div>