Deploying to gh-pages from @ b3f78fb 🚀

_sources/streamlit.rst.txt

@@ -15,7 +15,7 @@ Filters
 
 - Only unavailable tweets: Checks if the archived URL still exists on Twitter (see the :ref:`flowchart`)
 
-- Only unique URLs: Filtering by the collapse option using the ``urlkey`` field and the URL Match Scope ``prefix``
+- Only unique Wayback Machine URLs: Filtering by the collapse option using the ``urlkey`` field and the URL Match Scope ``prefix``
 
 
 Pagination

api.html

@@ -322,30 +322,30 @@ <h1>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h1
 <p>Generates an HTML file to visualize the parsed data.</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="waybacktweets.api.visualize.HTMLTweetsVisualizer">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">waybacktweets.api.visualize.</span></span><span class="sig-name descname"><span class="pre">HTMLTweetsVisualizer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">html_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#waybacktweets.api.visualize.HTMLTweetsVisualizer" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">waybacktweets.api.visualize.</span></span><span class="sig-name descname"><span class="pre">HTMLTweetsVisualizer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">json_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">html_file_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#waybacktweets.api.visualize.HTMLTweetsVisualizer" title="Link to this definition">¶</a></dt>
 <dd><p>Class responsible for generating an HTML file to visualize the parsed data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>json_file_path</strong> (<em>str</em>) – The path of the JSON file.</p></li>
-<li><p><strong>html_file_path</strong> (<em>str</em>) – The path where the HTML file will be saved.</p></li>
 <li><p><strong>username</strong> (<em>str</em>) – The username associated with the tweets.</p></li>
+<li><p><strong>json_file_path</strong> (<em>Union</em><em>[</em><em>str</em><em>, </em><em>List</em><em>[</em><em>str</em><em>]</em><em>]</em>) – The path of the JSON file or the JSON data itself.</p></li>
+<li><p><strong>html_file_path</strong> (<em>str</em><em>, </em><em>optional</em>) – The path where the HTML file will be saved.</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="waybacktweets.api.visualize.HTMLTweetsVisualizer._json_loader">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_json_loader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_file_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#waybacktweets.api.visualize.HTMLTweetsVisualizer._json_loader" title="Link to this definition">¶</a></dt>
-<dd><p>Reads and loads JSON data from a specified file path.</p>
+<dd><p>Reads and loads JSON data from a specified file path or JSON string.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>json_file_path</strong> (<em>str</em>) – The path of the JSON file.</p>
+<dd class="field-odd"><p><strong>json_file_path</strong> (<em>Union</em><em>[</em><em>str</em><em>, </em><em>List</em><em>[</em><em>str</em><em>]</em><em>]</em>) – The path of the JSON file or the JSON data itself.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>]]</span></p>
 </dd>
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>The content of the JSON file.</p>
+<dd class="field-odd"><p>The content of the JSON file or data.</p>
 </dd>
 </dl>
 </dd></dl>

streamlit.html

@@ -63,7 +63,7 @@ <h2>Filters<a class="headerlink" href="#filters" title="Link to this heading">¶
 <ul class="simple">
 <li><p>Filtering by date range: Using the <code class="docutils literal notranslate"><span class="pre">from</span></code> and <code class="docutils literal notranslate"><span class="pre">to</span></code> filters</p></li>
 <li><p>Only unavailable tweets: Checks if the archived URL still exists on Twitter (see the <a class="reference internal" href="workflow.html#flowchart"><span class="std std-ref">Workflow</span></a>)</p></li>
-<li><p>Only unique URLs: Filtering by the collapse option using the <code class="docutils literal notranslate"><span class="pre">urlkey</span></code> field and the URL Match Scope <code class="docutils literal notranslate"><span class="pre">prefix</span></code></p></li>
+<li><p>Only unique Wayback Machine URLs: Filtering by the collapse option using the <code class="docutils literal notranslate"><span class="pre">urlkey</span></code> field and the URL Match Scope <code class="docutils literal notranslate"><span class="pre">prefix</span></code></p></li>
 </ul>
 </section>
 <section id="pagination">

workflow.html

@@ -17,7 +17,7 @@
     <script src="https://unpkg.com/d3/dist/d3.min.js"></script>
     <script>
                 window.addEventListener("load", function () {
-                  var svgs = d3.selectAll(".mermaid#id-9bc141db-2761-4e9e-8e64-a4cce2828bd4 svg");
+                  var svgs = d3.selectAll(".mermaid#id-a5adfae9-4c79-434c-8c2f-37cf0e8d80a2 svg");
                   svgs.each(function() {
                     var svg = d3.select(this);
                     svg.html("<g>" + svg.html() + "</g>");
@@ -76,7 +76,7 @@ <h3>Navigation</h3>
 <p>The tool was written following a proposal not only to Retrieve data from archived tweets, but also to facilitate the reading of these tweets. Therefore, a flow is defined to obtain these results in the best possible way.</p>
 <p>Due to limitations of the Wayback CDX Server API, it is not always possible to parse the results with the mimetype <code class="docutils literal notranslate"><span class="pre">application/json</span></code>, regardless, the data in CDX format are saved.</p>
 <p>Use the mouse to zoom in and out the flowchart.</p>
-<div align="center" id="id-9bc141db-2761-4e9e-8e64-a4cce2828bd4" class="mermaid align-center">
+<div align="center" id="id-a5adfae9-4c79-434c-8c2f-37cf0e8d80a2" class="mermaid align-center">
             flowchart TB
    A[input Username]--&gt; B[(Wayback Machine)]
    B--&gt; B1[save Archived Tweets CDX data]