deploy: 67bb848

ahnazary · Apr 8, 2024 · 5d97fa1 · 5d97fa1
1 parent a2768dd
commit 5d97fa1
Show file tree

Hide file tree

Showing 12 changed files with 248 additions and 91 deletions.
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/readme.doctree b/docs/.doctrees/readme.doctree
diff --git a/docs/.doctrees/stockdex.doctree b/docs/.doctrees/stockdex.doctree
diff --git a/docs/_modules/stockdex/nasdaq_interface.html b/docs/_modules/stockdex/nasdaq_interface.html
diff --git a/docs/_modules/stockdex/ticker.html b/docs/_modules/stockdex/ticker.html
@@ -80,10 +80,11 @@ <h1>Source code for stockdex.ticker</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">bs4</span> <span class="kn">import</span> <span class="n">BeautifulSoup</span>
 
 <span class="kn">from</span> <span class="nn">stockdex.justetf</span> <span class="kn">import</span> <span class="n">JustETF</span>
+<span class="kn">from</span> <span class="nn">stockdex.nasdaq_interface</span> <span class="kn">import</span> <span class="n">NASDAQInterface</span>
 <span class="kn">from</span> <span class="nn">stockdex.ticker_api</span> <span class="kn">import</span> <span class="n">TickerAPI</span>
 
 
-<div class="viewcode-block" id="Ticker"><a class="viewcode-back" href="../../stockdex.html#stockdex.ticker.Ticker">[docs]</a><span class="k">class</span> <span class="nc">Ticker</span><span class="p">(</span><span class="n">TickerAPI</span><span class="p">,</span> <span class="n">JustETF</span><span class="p">):</span>
+<div class="viewcode-block" id="Ticker"><a class="viewcode-back" href="../../stockdex.html#stockdex.ticker.Ticker">[docs]</a><span class="k">class</span> <span class="nc">Ticker</span><span class="p">(</span><span class="n">TickerAPI</span><span class="p">,</span> <span class="n">JustETF</span><span class="p">,</span> <span class="n">NASDAQInterface</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Class for the Ticker</span>
 <span class="sd">    &quot;&quot;&quot;</span>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -88,6 +88,7 @@ <h1 id="index">Index</h1>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
  | <a href="#T"><strong>T</strong></a>
+ | <a href="#Y"><strong>Y</strong></a>
 
 </div>
 <h2 id="A">A</h2>
@@ -165,12 +166,8 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.get_response">get_response() (stockdex.nasdaq_interface.NASDAQInterface method)</a>
-
-      <ul>
-        <li><a href="stockdex.html#stockdex.ticker_base.TickerBase.get_response">(stockdex.ticker_base.TickerBase method)</a>
+      <li><a href="stockdex.html#stockdex.ticker_base.TickerBase.get_response">get_response() (stockdex.ticker_base.TickerBase method)</a>
 </li>
-      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="stockdex.html#stockdex.lib.get_user_agent">get_user_agent() (in module stockdex.lib)</a>
@@ -246,7 +243,11 @@ <h2 id="P">P</h2>
 <h2 id="Q">Q</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.quarterly_earnings">quarterly_earnings() (stockdex.nasdaq_interface.NASDAQInterface method)</a>
+      <li><a href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.quarterly_earnings_forecast">quarterly_earnings_forecast() (stockdex.nasdaq_interface.NASDAQInterface method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.quarterly_earnings_surprise">quarterly_earnings_surprise() (stockdex.nasdaq_interface.NASDAQInterface method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -333,6 +334,14 @@ <h2 id="T">T</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="Y">Y</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.yearly_earnings_forecast">yearly_earnings_forecast() (stockdex.nasdaq_interface.NASDAQInterface method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
            </div>

diff --git a/docs/index.html b/docs/index.html
@@ -82,7 +82,8 @@ <h1>Welcome to stockdex’s documentation!<a class="headerlink" href="#welcome-t
 <li class="toctree-l2"><a class="reference internal" href="readme.html#usage">Usage</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#fundamental-data-from-yahoo-finance-api-fast-queries-through-yahoo-finance-api">Fundamental data from <code class="docutils literal notranslate"><span class="pre">Yahoo</span> <span class="pre">Finance</span></code> API (fast queries through Yahoo Finance API):</a></li>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#fundamental-data-with-criteria-from-yahoo-finance-website-web-scraping">Fundamental data with criteria from <code class="docutils literal notranslate"><span class="pre">Yahoo</span> <span class="pre">Finance</span></code> website (web scraping):</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme.html#etf-data-from-justetf-website">ETF data from justETF website:</a></li>
+<li class="toctree-l3"><a class="reference internal" href="readme.html#nasdaq-data-from-nasdaq-web-scraping">NASDAQ data from <code class="docutils literal notranslate"><span class="pre">NASDAQ</span></code> (web scraping):</a></li>
+<li class="toctree-l3"><a class="reference internal" href="readme.html#eu-etf-data-from-justetf-web-scraping">EU ETF data from justETF (web scraping):</a></li>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#historical-dividends-data">Historical dividends data</a></li>
 </ul>
 </li>

diff --git a/docs/modules.html b/docs/modules.html
@@ -87,8 +87,9 @@ <h1>stockdex<a class="headerlink" href="#stockdex" title="Permalink to this head
 </li>
 <li class="toctree-l2"><a class="reference internal" href="stockdex.html#module-stockdex.nasdaq_interface">stockdex.nasdaq_interface module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface"><code class="docutils literal notranslate"><span class="pre">NASDAQInterface</span></code></a><ul>
-<li class="toctree-l4"><a class="reference internal" href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.get_response"><code class="docutils literal notranslate"><span class="pre">NASDAQInterface.get_response()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.quarterly_earnings"><code class="docutils literal notranslate"><span class="pre">NASDAQInterface.quarterly_earnings()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.quarterly_earnings_forecast"><code class="docutils literal notranslate"><span class="pre">NASDAQInterface.quarterly_earnings_forecast()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.quarterly_earnings_surprise"><code class="docutils literal notranslate"><span class="pre">NASDAQInterface.quarterly_earnings_surprise()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="stockdex.html#stockdex.nasdaq_interface.NASDAQInterface.yearly_earnings_forecast"><code class="docutils literal notranslate"><span class="pre">NASDAQInterface.yearly_earnings_forecast()</span></code></a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/readme.html b/docs/readme.html
@@ -50,7 +50,8 @@
 <li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#fundamental-data-from-yahoo-finance-api-fast-queries-through-yahoo-finance-api">Fundamental data from <code class="docutils literal notranslate"><span class="pre">Yahoo</span> <span class="pre">Finance</span></code> API (fast queries through Yahoo Finance API):</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#fundamental-data-with-criteria-from-yahoo-finance-website-web-scraping">Fundamental data with criteria from <code class="docutils literal notranslate"><span class="pre">Yahoo</span> <span class="pre">Finance</span></code> website (web scraping):</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#etf-data-from-justetf-website">ETF data from justETF website:</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#nasdaq-data-from-nasdaq-web-scraping">NASDAQ data from <code class="docutils literal notranslate"><span class="pre">NASDAQ</span></code> (web scraping):</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#eu-etf-data-from-justetf-web-scraping">EU ETF data from justETF (web scraping):</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#historical-dividends-data">Historical dividends data</a></li>
 </ul>
 </li>
@@ -160,11 +161,20 @@ <h3>Fundamental data with criteria from <code class="docutils literal notranslat
 </pre></div>
 </div>
 </section>
-<section id="etf-data-from-justetf-website">
-<h3>ETF data from justETF website:<a class="headerlink" href="#etf-data-from-justetf-website" title="Permalink to this heading"></a></h3>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span>
-<span class="c1"># build the ETF object, make sure to pass the ETF ISIN and use security_type to &quot;etf&quot;</span>
-<span class="n">etf</span> <span class="o">=</span> <span class="n">Ticker</span><span class="p">(</span><span class="n">isin</span><span class="o">=</span><span class="s1">&#39;IE00B4L5Y983&#39;</span><span class="p">,</span> <span class="n">security_type</span><span class="o">=</span><span class="s1">&#39;etf&#39;</span><span class="p">)</span>
+<section id="nasdaq-data-from-nasdaq-web-scraping">
+<h3>NASDAQ data from <code class="docutils literal notranslate"><span class="pre">NASDAQ</span></code> (web scraping):<a class="headerlink" href="#nasdaq-data-from-nasdaq-web-scraping" title="Permalink to this heading"></a></h3>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Data about quarterly and yearly earnings, updated on the same day as the earnings release (yahoo finance data is updated after a few days)</span>
+
+<span class="n">quarterly_earnings_surprise</span> <span class="o">=</span> <span class="n">ticker</span><span class="o">.</span><span class="n">quarterly_earnings_surprise</span>
+<span class="n">yearly_earnings_forecast</span> <span class="o">=</span> <span class="n">ticker</span><span class="o">.</span><span class="n">yearly_earnings_forecast</span>
+<span class="n">quarterly_earnings_forecast</span> <span class="o">=</span> <span class="n">ticker</span><span class="o">.</span><span class="n">quarterly_earnings_forecast</span>
+</pre></div>
+</div>
+</section>
+<section id="eu-etf-data-from-justetf-web-scraping">
+<h3>EU ETF data from justETF (web scraping):<a class="headerlink" href="#eu-etf-data-from-justetf-web-scraping" title="Permalink to this heading"></a></h3>
+<p>For EU ETFS, the <code class="docutils literal notranslate"><span class="pre">isin</span></code> and <code class="docutils literal notranslate"><span class="pre">security_type</span></code> should be passed to the <code class="docutils literal notranslate"><span class="pre">Ticker</span></code> object. The <code class="docutils literal notranslate"><span class="pre">isin</span></code> is the International Securities Identification Number of the ETF and the <code class="docutils literal notranslate"><span class="pre">security_type</span></code> should be set to <code class="docutils literal notranslate"><span class="pre">etf</span></code>.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">etf</span> <span class="o">=</span> <span class="n">Ticker</span><span class="p">(</span><span class="n">isin</span><span class="o">=</span><span class="s1">&#39;IE00B4L5Y983&#39;</span><span class="p">,</span> <span class="n">security_type</span><span class="o">=</span><span class="s1">&#39;etf&#39;</span><span class="p">)</span>
 
 <span class="n">etf_general_info</span> <span class="o">=</span> <span class="n">etf</span><span class="o">.</span><span class="n">etf_general_info</span>
 <span class="n">etf_wkn</span> <span class="o">=</span> <span class="n">etf</span><span class="o">.</span><span class="n">etf_wkn</span>