From: Claromes Date: Mon, 24 Jun 2024 11:40:11 +0000 (-0300) Subject: update HTML, update docs app and spinner, update print msg, delete image preview X-Git-Url: https://git.claromes.com/?a=commitdiff_plain;h=ac094ded6a0dac5536f840feabbee859984a0ce3;p=waybacktweets.git update HTML, update docs app and spinner, update print msg, delete image preview --- diff --git a/docs/api.rst b/docs/api.rst index b068e10..6a5a2b4 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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 ------------ diff --git a/docs/index.rst b/docs/index.rst index 2b4b6b2..ce4e8af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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. diff --git a/docs/streamlit.rst b/docs/streamlit.rst index 1db42e0..62ebc59 100644 --- a/docs/streamlit.rst +++ b/docs/streamlit.rst @@ -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`` diff --git a/docs/workflow.rst b/docs/workflow.rst index 046443c..09361c5 100644 --- a/docs/workflow.rst +++ b/docs/workflow.rst @@ -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]