From: Claromes Date: Mon, 24 Jun 2024 15:40:10 +0000 (-0300) Subject: add outputs docs X-Git-Url: https://git.claromes.com/?a=commitdiff_plain;h=270dc82acac55f209c1a6bbca1a5296e3012974f;p=waybacktweets.git add outputs docs --- diff --git a/docs/exceptions.rst b/docs/exceptions.rst index 22f0f3f..a7500a7 100644 --- a/docs/exceptions.rst +++ b/docs/exceptions.rst @@ -4,14 +4,14 @@ Exceptions These are the most common errors and are handled by the ``waybacktweets`` package. ReadTimeoutError ----------------- +------------------ This error occurs when a request to the web.archive.org server takes too long to respond. The server could be overloaded or there could be network issues. The output message from the package would be: ``Connection to web.archive.org timed out.`` ConnectionError ----------------- +------------------ This error is raised when the package fails to establish a new connection with web.archive.org. This could be due to network issues or the server being down. @@ -23,15 +23,22 @@ This is the error often returned when performing experimental parsing of URLs wi The warning output message from the package would be: ``Connection error with https://web.archive.org/web//https://twitter.com//status/. Max retries exceeded. Error parsing the JSON, but the CDX data was saved.`` HTTPError ----------------- +------------------ This error occurs when the Internet Archive services are temporarily offline. This could be due to maintenance or server issues. The output message from the package would be: ``Temporarily Offline: Internet Archive services are temporarily offline. Please check Internet Archive Twitter feed (https://twitter.com/internetarchive) for the latest information.`` EmptyResponseError ----------------------- +--------------------- This exception raised for empty responses. The output message from the package would be: ``No data was saved due to an empty response.`` + +Warning +------------------ + +It is possible to encounter the following warning when running the ``TweetsParser`` class (:ref:`parser`): `` not available on the user's Twitter account, but the CDX data was saved.`` + +This occurs when the original tweet is no longer available on Twitter and has possibly been deleted. diff --git a/docs/index.rst b/docs/index.rst index ce4e8af..46b9945 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,6 +25,7 @@ User Guide quickstart workflow field_options + outputs exceptions contribute todo diff --git a/docs/outputs.rst b/docs/outputs.rst new file mode 100644 index 0000000..365db72 --- /dev/null +++ b/docs/outputs.rst @@ -0,0 +1,29 @@ +Outputs +========== + +It is possible to save the CDX data in three formats. In the command line tool, these three formats are saved automatically. + +HTML +-------- + +This format allows for easy viewing of the archived tweets, through the use of the ``iframe`` tag. Each tweet contains four viewing options, which render when clicking on the accordion: + +- ``archived_tweet_url``: (`str`) The archived URL. + +- ``parsed_archived_tweet_url``: (`str`) The archived URL after parsing. It is not guaranteed that this option will be archived, it is just a facilitator, as the originally archived URL does not always exist, due to changes in URLs and web services of the social network Twitter. Check the :ref:`utils`. + +- ``original_tweet_url``: (`str`) The original tweet URL. + +- ``parsed_tweet_url``: (`str`) The original tweet URL after parsing. Old URLs were archived in a nested manner. The parsing applied here unnests these URLs, when necessary. Check the :ref:`utils`. + +Additionally, other fields are displayed. + +CSV +-------- + +Option to analyze the CDX data in comma-separated values. + +JSON +-------- + +Option to analyze the data in JavaScript Object Notation. diff --git a/docs/streamlit.rst b/docs/streamlit.rst index 62ebc59..56e16f6 100644 --- a/docs/streamlit.rst +++ b/docs/streamlit.rst @@ -45,8 +45,7 @@ Community Comments Legacy App ------------- -To access the legacy version (v0.4.3) of Wayback Tweets `click here `_. - +To access the legacy version of Wayback Tweets `click here `_. .. note::