docs updated & release setup

- both docstrings and rst files updated - argument rename from *start* and *end* to *from_date* and *to_date*, as described on #16
alvarobartt · Aug 12, 2019 · cce9ca3 · alvarobartt · Aug 12, 2019 · cce9ca3
1 parent d19de48
commit cce9ca3
Show file tree

Hide file tree

Showing 33 changed files with 121 additions and 121 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,7 @@ install:
   - pip install requests==2.22.0
   - pip install lxml==4.3.3
   - pip install Unidecode==1.0.23
-  - pip install investpy==0.8.6
+  - pip install investpy==0.8.7
   - pip install pytest==4.5.0
   - pip install codecov==2.0.15
   - pip install pytest-cov==2.7.1

diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ investpy seeks to be one of the most used Python packages when it comes to histo
 
 In order to get this package working you will need to install [**investpy**](https://pypi.org/project/investpy/) from PyPi via Terminal typing:
 
-``pip install investpy==0.8.6``
+``pip install investpy==0.8.7``
 
 All the dependencies are already listed on the setup file of the package, but to sum them up, you will need the following requirements:
 
@@ -55,7 +55,7 @@ Date
 2019-07-17  4.905  4.965  4.900  4.952  22410000
 2019-07-18  4.856  4.894  4.812  4.879  35820000
 
-df = investpy.get_historical_data(equity='bbva', start='01/01/2018', end='12/08/2019', as_json=False, order='ascending')
+df = investpy.get_historical_data(equity='bbva', from_date='01/01/2018', to_date='12/08/2019', as_json=False, order='ascending')
 print(df.head())
 
 >>>
@@ -85,7 +85,7 @@ Date
 2019-07-17  1.129  1.129  1.129  1.129
 2019-07-18  1.126  1.126  1.126  1.126
 
-df = investpy.get_fund_historical_data(fund='bbva plan multiactivo moderado pp', start='01/01/2018', end='12/08/2019', as_json=False, order='ascending')
+df = investpy.get_fund_historical_data(fund='bbva plan multiactivo moderado pp', from_date='01/01/2018', to_date='12/08/2019', as_json=False, order='ascending')
 print(df.head())
 
 >>>
@@ -115,7 +115,7 @@ Date
 2019-07-17  35.830  36.080  35.810  35.965
 2019-07-18  35.640  35.785  35.515  35.515
 
-df = investpy.get_etf_historical_data(etf='bbva accion dj eurostoxx 50', start='01/01/2018', end='12/08/2019', as_json=False, order='ascending')
+df = investpy.get_etf_historical_data(etf='bbva accion dj eurostoxx 50', from_date='01/01/2018', to_date='12/08/2019', as_json=False, order='ascending')
 print(df.head())
 
 >>>

diff --git a/docs/_build/html/_sources/equities.rst.txt b/docs/_build/html/_sources/equities.rst.txt
@@ -10,7 +10,7 @@ protect investors from fraudulent practices. Historically, they have outperforme
 run. These investments can be purchased from most online stock brokers.
 
 In this case, historical data from stocks or equities is retrieved from `Investing Equities <https://es.investing.com/equities/spain>`_
-just for the Spanish Stock Market, on the current release 0.8.6.
+just for the Spanish Stock Market, on the current release 0.8.7.
 
 Getting Started
 ---------------

diff --git a/docs/_build/html/_sources/installation.md.txt b/docs/_build/html/_sources/installation.md.txt
@@ -29,5 +29,5 @@ it will install the following dependencies:
 
 .. note::
 
-    After installing the package you are now available to use it! As investpy's latest release is 0.8.6 the installation is
+    After installing the package you are now available to use it! As investpy's latest release is 0.8.7 the installation is
     optimized for it. If you try installing another investpy release, some features may not work.
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.8.6 the installation is
+    After installing the package you are now available to use it! As investpy's latest release is 0.8.7 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.8.6',
+    VERSION: '0.8.7',
     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.8.6 documentation</title>
+  <title>API Reference &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </div>
 
 

diff --git a/docs/_build/html/contribution.html b/docs/_build/html/contribution.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Contribute to investpy - &mdash; investpy 0.8.6 documentation</title>
+  <title>Contribute to investpy - &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>Disclaimer &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>Stocks/Equities &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </div>
 
 
@@ -175,7 +175,7 @@ <h1>Stocks/Equities<a class="headerlink" href="#stocks-equities" title="Permalin
 protect investors from fraudulent practices. Historically, they have outperformed most other investments over the long
 run. These investments can be purchased from most online stock brokers.</p>
 <p>In this case, historical data from stocks or equities is retrieved from <a class="reference external" href="https://es.investing.com/equities/spain">Investing Equities</a>
-just for the Spanish Stock Market, on the current release 0.8.6.</p>
+just for the Spanish Stock Market, on the current release 0.8.7.</p>
 <div class="section" id="getting-started">
 <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
 <p>To get started using <a class="reference external" href="https://pypi.org/project/investpy/">investpy</a> you first need to install it as described on

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.8.6 documentation</title>
+  <title>investpy.equities &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>investpy.etfs &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </div>
 
 

diff --git a/docs/_build/html/examples.html b/docs/_build/html/examples.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>GitHub Gists on investpy use &mdash; investpy 0.8.6 documentation</title>
+  <title>GitHub Gists on investpy use &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>investpy.funds &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>Index &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>Welcome to investpy’s documentation! &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>Additional Information &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </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.8.6 documentation</title>
+  <title>Installation &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </div>
 
 
@@ -165,7 +165,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.8.6 the installation is
+<p>After installing the package you are now available to use it! As investpy’s latest release is 0.8.7 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.8.6 documentation</title>
+  <title>Introduction &mdash; investpy 0.8.7 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.8.6
+                0.8.7
               </div>
 
 

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

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

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