update HTML, update docs app and spinner, update print msg, delete image preview
authorClaromes <claromes@hey.com>
Mon, 24 Jun 2024 11:40:11 +0000 (08:40 -0300)
committerClaromes <claromes@hey.com>
Mon, 24 Jun 2024 11:40:11 +0000 (08:40 -0300)
docs/api.rst
docs/index.rst
docs/streamlit.rst
docs/workflow.rst

index b068e1078f7146bf7c7d404e95cf438adbb1e0b7..6a5a2b49935acfda5e94ac596b39c4b9cffd591e 100644 (file)
@@ -64,25 +64,6 @@ Utils
 .. autofunction:: semicolon_parser
 .. autofunction:: timestamp_parser
 
-Exceptions
-------------
-
-.. automodule:: waybacktweets.exceptions.exceptions
-
-.. autoclass:: ReadTimeoutError
-    :members:
-
-.. autoclass:: ConnectionError
-    :members:
-
-.. autoclass:: HTTPError
-    :members:
-
-.. autoclass:: EmptyResponseError
-    :members:
-
-.. autoclass:: GetResponseError
-    :members:
 
 Config
 ------------
index 2b4b6b27c4e3308449b64a78e87eda978ab5f7dd..ce4e8af184b1b12930af8643fa667c2a2a176613 100644 (file)
@@ -11,10 +11,6 @@ Pre-release: |release|
 
 Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see :ref:`field_options`), and saves the data in CSV, JSON, and HTML formats.
 
-.. image:: ../assets/preview_image.jpg
-    :alt: Preview image
-    :align: center
-
 .. note::
     Intensive queries can lead to rate limiting, resulting in a temporary ban of a few minutes from web.archive.org.
 
index 1db42e0b2669c5afe2d0dc26bedc27be54195536..62ebc597895ca71feb1ba4cec4cea2e7417b4ba1 100644 (file)
@@ -8,14 +8,13 @@ Aplication that displays multiple archived tweets on Wayback Machine to avoid op
 
 Filters
 ----------
+
 - Filtering by date range: Using the ``from`` and ``to`` filters
 
 - Limit: Query result limits.
 
 - Offset: Allows for a simple way to scroll through the results.
 
-- Only unavailable tweets: Checks if the archived URL still exists on Twitter (see the :ref:`flowchart`)
-
 - Only unique Wayback Machine URLs: Filtering by the collapse option using the ``urlkey`` field and the URL Match Scope ``prefix``
 
 
index 046443c2b4e31b2cfde156190a896dc344b86e14..09361c53bfdd62c143ca8b4f88b8829c872064f1 100644 (file)
@@ -3,7 +3,7 @@
 Workflow
 ================
 
-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.
+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.
 
 Due to limitations of the Wayback CDX Server API, it is not always possible to parse the results with the mimetype ``application/json``, regardless, the data in CDX format are saved.
 
@@ -21,5 +21,5 @@ Use the mouse to zoom in and out the flowchart.
       C--> |4xx| E[return None]
       E--> F{request Archived\nTweet URL}
       F--> |4xx| G[return Only CDX data]
-      F--> |2xx/3xx: application/json| J[return JSON text]
+      F--> |TODO: 2xx/3xx: application/json| J[return JSON text]
       F--> |2xx/3xx: text/html, warc/revisit, unk| K[return HTML iframe tag]