release fixed & fix setup

- 0.9.1 release has been fixed since currency data was not included in fund historical data retrieval - `fund_countries.csv` has been added to setup.py data_files - 0.9.2 release setup - docs/ updated
alvarobartt · Sep 13, 2019 · f876698 · f876698
1 parent 7ed1a27
commit f876698
Show file tree

Hide file tree

Showing 31 changed files with 317 additions and 213 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,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.1``
+``$ pip install investpy==0.9.2``
 
 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:
@@ -96,13 +96,13 @@ df = investpy.get_fund_recent_data(fund='bbva plan multiactivo moderado pp',
 print(df.head())
 
 >>>
-            Close   High    Low   Open
-Date                                  
-2019-07-12  1.128  1.128  1.128  1.128
-2019-07-15  1.130  1.130  1.130  1.130
-2019-07-16  1.130  1.130  1.130  1.130
-2019-07-17  1.129  1.129  1.129  1.129
-2019-07-18  1.126  1.126  1.126  1.126
+             Open   High    Low  Close Currency
+Date                                           
+2019-08-13  1.110  1.110  1.110  1.110      EUR
+2019-08-16  1.109  1.109  1.109  1.109      EUR
+2019-08-19  1.114  1.114  1.114  1.114      EUR
+2019-08-20  1.112  1.112  1.112  1.112      EUR
+2019-08-21  1.115  1.115  1.115  1.115      EUR
 
 ```
 
@@ -116,13 +116,13 @@ df = investpy.get_fund_historical_data(fund='bbva plan multiactivo moderado pp',
 print(df.head())
 
 >>>
-            Close   High    Low   Open
-Date                                  
-2018-02-15  1.105  1.105  1.105  1.105
-2018-02-16  1.113  1.113  1.113  1.113
-2018-02-17  1.113  1.113  1.113  1.113
-2018-02-18  1.113  1.113  1.113  1.113
-2018-02-19  1.111  1.111  1.111  1.111
+             Open   High    Low  Close Currency
+Date                                           
+2018-02-15  1.105  1.105  1.105  1.105      EUR
+2018-02-16  1.113  1.113  1.113  1.113      EUR
+2018-02-17  1.113  1.113  1.113  1.113      EUR
+2018-02-18  1.113  1.113  1.113  1.113      EUR
+2018-02-19  1.111  1.111  1.111  1.111      EUR
 
 ```
 

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/equities_api.doctree b/docs/_build/doctrees/equities_api.doctree
diff --git a/docs/_build/doctrees/etfs_api.doctree b/docs/_build/doctrees/etfs_api.doctree
diff --git a/docs/_build/doctrees/funds_api.doctree b/docs/_build/doctrees/funds_api.doctree
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/main_api.doctree b/docs/_build/doctrees/main_api.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: 70a5174f2acc3480f905925e73085ea0
+config: d489656db2532687c5b4eb366b70bbeb
 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.1 the installation is
+    After installing the package you are now available to use it! As investpy's latest release is 0.9.2 the installation is
     optimized for it. If you try installing another investpy release, some features may not work.
 
 First Installation
@@ -48,7 +48,7 @@ If you already had `investpy <https://pypi.org/project/investpy/>`_ installed an
 All the dependencies are already listed on the setup file of the package, but to sum them up, when installing
 `investpy <https://pypi.org/project/investpy/>`_, it will install the following dependencies:
 
-* `pandas 0.24.2 <https://pypi.org/project/pandas/>`_
+* `pandas 0.25.1 <https://pypi.org/project/pandas/>`_
 * `requests 2.22.0 <https://pypi.org/project/requests/>`_
-* `lxml 4.3.3 <https://pypi.org/project/lxml/>`_
-* `unidecode 1.0.23 <https://pypi.org/project/unidecode/>`_
+* `lxml 4.4.1 <https://pypi.org/project/lxml/>`_
+* `unidecode 1.1.1 <https://pypi.org/project/unidecode/>`_
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.1',
+    VERSION: '0.9.2',
     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.1 documentation</title>
+  <title>API Reference &mdash; investpy 0.9.2 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.1
+                0.9.2
               </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.1 documentation</title>
+  <title>Disclaimer &mdash; investpy 0.9.2 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.9.1
+                0.9.2
               </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.1 documentation</title>
+  <title>Stocks/Equities &mdash; investpy 0.9.2 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.1
+                0.9.2
               </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.1 documentation</title>
+  <title>investpy.equities &mdash; investpy 0.9.2 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.1
+                0.9.2
               </div>
 
 
@@ -306,7 +306,7 @@
 just used for inner function purposes.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>test_mode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – variable to avoid time waste on travis-ci since it just needs to test the basics in order to determine code
+<dd class="field-odd"><p><strong>test_mode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – variable to avoid time waste on travis-ci since it just needs to test the basics in order to improve code
 coverage.</p>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -327,6 +327,7 @@
 <dt class="field-even">Raises</dt>
 <dd class="field-even"><ul class="simple">
 <li><p><strong>ValueError</strong> – if any of the introduced arguments is not valid.</p></li>
+<li><p><strong>FileNotFoundError</strong> – raised if <cite>equity_countries.csv</cite> file does not exists or is empty.</p></li>
 <li><p><strong>ConnectionError</strong> – if GET requests does not return 200 status code.</p></li>
 <li><p><strong>IndexError</strong> – if equities information was unavailable or not found.</p></li>
 </ul>
@@ -343,7 +344,7 @@
 when retrieving all the information from the available equities in every country.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>test_mode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – variable to avoid time waste on travis-ci since it just needs to test the basics in order to determine code
+<dd class="field-odd"><p><strong>test_mode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – variable to avoid time waste on travis-ci since it just needs to test the basics in order to improve code
 coverage.</p>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -355,6 +356,7 @@
 </dd>
 <dt class="field-even">Raises</dt>
 <dd class="field-even"><ul class="simple">
+<li><p><strong>ValueError</strong> – raised if any of the introduced arguments is not valid.</p></li>
 <li><p><strong>ConnectionError</strong> – raised if connection to Investing.com could not be established.</p></li>
 <li><p><strong>RuntimeError</strong> – raised if no countries were retrieved from Investing.com equity listing.</p></li>
 </ul>
@@ -363,19 +365,20 @@
 </dd></dl>
 
 <dl class="function">
-<dt id="investpy.equities.retrieve_info">
-<code class="sig-prename descclassname">investpy.equities.</code><code class="sig-name descname">retrieve_info</code><span class="sig-paren">(</span><em class="sig-param">tag</em><span class="sig-paren">)</span><a class="headerlink" href="#investpy.equities.retrieve_info" title="Permalink to this definition">¶</a></dt>
-<dd><p>This function retrieves both the ISIN code and the currency of an equity indexed in Investing.com, so to add
-additional information to the <cite>equities.csv</cite> file. The ISIN code will later be used in order to retrieve more
-information from the specified equity as the ISIN code is an unique identifier of every equity; and the currency
-which will be required in order to know which currency is the value in.</p>
+<dt id="investpy.equities.retrieve_equity_info">
+<code class="sig-prename descclassname">investpy.equities.</code><code class="sig-name descname">retrieve_equity_info</code><span class="sig-paren">(</span><em class="sig-param">tag</em><span class="sig-paren">)</span><a class="headerlink" href="#investpy.equities.retrieve_equity_info" title="Permalink to this definition">¶</a></dt>
+<dd><p>This function retrieves both the ISIN code, the currency and the symbol of an equity indexed in Investing.com, so
+to include additional information in <cite>equities.csv</cite> file. The ISIN code will later be used in order to retrieve more
+information from the specified equity, as the ISIN code is an unique identifier of each equity; the currency
+will be required in order to know which currency is the value in, and the symbol will be used for processing the
+request to HistoricalDataAjax to retrieve historical data from Investing.com.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><p><strong>tag</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – is the tag of the equity to retrieve the information from as indexed by Investing.com.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p><dl class="simple">
-<dt>The resulting <code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code> contains the needed information for the equities listing, so on, both the the ISIN</dt><dd><p>code of the introduced equity and the currency of its values.</p>
+<dt>The resulting <code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code> contains the needed information for the equities listing, so on, the ISIN</dt><dd><p>code of the introduced equity, the currency of its values and the symbol of the equity.</p>
 </dd>
 </dl>
 </p>

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.1 documentation</title>
+  <title>investpy.etfs &mdash; investpy 0.9.2 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                0.9.1
+                0.9.2
               </div>
 
 
@@ -312,6 +312,31 @@
 </dl>
 </dd></dl>
 
+<dl class="function">
+<dt id="investpy.etfs.retrieve_etf_info">
+<code class="sig-prename descclassname">investpy.etfs.</code><code class="sig-name descname">retrieve_etf_info</code><span class="sig-paren">(</span><em class="sig-param">tag</em><span class="sig-paren">)</span><a class="headerlink" href="#investpy.etfs.retrieve_etf_info" title="Permalink to this definition">¶</a></dt>
+<dd><p>This function retrieves additional information from the specified etf as indexed in Investing.com, in order to add
+more information to <cite>etfs.csv</cite> which can later be useful. Currently just the currency value is retrieved, since it
+is needed so to determine in which currency the historical data values are.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>tag</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – is the tag of the etf to retrieve the information from as indexed by Investing.com.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>The resulting <code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code> contains the needed information for the etfs listing.</p>
+</dd>
+<dt class="field-odd">Return type</dt>
+<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code> - info</p>
+</dd>
+<dt class="field-even">Raises</dt>
+<dd class="field-even"><ul class="simple">
+<li><p><strong>ConnectionError</strong> – raised if GET requests does not return 200 status code.</p></li>
+<li><p><strong>IndexError</strong> – raised if the information from the etf was not found or unable to retrieve.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="function">
 <dt id="investpy.etfs.retrieve_etfs">
 <code class="sig-prename descclassname">investpy.etfs.</code><code class="sig-name descname">retrieve_etfs</code><span class="sig-paren">(</span><em class="sig-param">test_mode=False</em><span class="sig-paren">)</span><a class="headerlink" href="#investpy.etfs.retrieve_etfs" title="Permalink to this definition">¶</a></dt>
@@ -324,7 +349,7 @@
 just used for inner function purposes.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>test_mode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – variable to avoid time waste on travis-ci since it just needs to test the basics in order to determine code
+<dd class="field-odd"><p><strong>test_mode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – variable to avoid time waste on travis-ci since it just needs to test the basics in order to improve code
 coverage.</p>
 </dd>
 <dt class="field-even">Returns</dt>