update description

diff --git a/README.md b/README.md
index bb3f763dcd4de191d2261842afd2fbfb4f9b7349..47d55da6095725778b8ecc3d3b1ee4dd21836012 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 [![PyPI](https://img.shields.io/pypi/v/waybacktweets)](https://pypi.org/project/waybacktweets) [![docs](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml/badge.svg)](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://waybacktweets.streamlit.app)
 
-Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see [Field Options](https://claromes.github.io/waybacktweets/field_options.html)), and saves the data in CSV, JSON, and HTML formats.
+Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see [Field Options](https://claromes.github.io/waybacktweets/field_options.html)), and saves the data in HTML (for easy viewing of the tweets using the `iframe` tag), CSV, and JSON formats.
 
 ## Installation
 
@@ -20,6 +20,10 @@ waybacktweets [OPTIONS] USERNAME
 waybacktweets --from 20150101 --to 20191231 --limit 250 jack
 ```
 
+### Using Wayback Tweets as a Web App
+
+[Open the application](https://waybacktweets.streamlit.app), a prototype written in Python with the Streamlit framework and hosted on Streamlit Cloud.
+
 ### Using Wayback Tweets as a Python Module
 
 ```python
@@ -45,10 +49,6 @@ if archived_tweets:
     exporter.save_to_csv()
 ```
 
-### Using Wayback Tweets as a Web App
-
-[Open the application](https://waybacktweets.streamlit.app), a prototype written in Python with the Streamlit framework and hosted on Streamlit Cloud.
-
 ## Documentation
 
 - [Wayback Tweets documentation](https://claromes.github.io/waybacktweets)
@@ -61,4 +61,4 @@ if archived_tweets:
 - OSINT Community for recommending the application.
 
 > [!NOTE]
-> If the application is down, please check the [Streamlit Cloud Status](https://www.streamlitstatus.com/).
+> If the Streamlit application is down, please check the [Streamlit Cloud Status](https://www.streamlitstatus.com/).

diff --git a/app/app.py b/app/app.py
index 19804497c2fe108f23f944b42e5680e566b86a84..379c892256f6e2cf390383861897a87488d38e9a 100644 (file)
--- a/app/app.py
+++ b/app/app.py
@@ -35,7 +35,7 @@ st.set_page_config(
         "About": f"""
     [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/claromes/waybacktweets?include_prereleases)](https://github.com/claromes/waybacktweets/releases) [![License](https://img.shields.io/github/license/claromes/waybacktweets)](https://github.com/claromes/waybacktweets/blob/main/LICENSE.md) [![Star](https://img.shields.io/github/stars/claromes/waybacktweets?style=social)](https://github.com/claromes/waybacktweets)
 
-    The application is a prototype hosted on Streamlit Cloud, allowing users to apply filters and download the data in different formats.
+    The application is a prototype hosted on Streamlit Cloud, serving as an alternative to the command line tool.
 
     © 2023 - {end_date.year}, [Claromes](https://claromes.com)
 
@@ -133,7 +133,9 @@ st.image(TITLE, use_column_width="never")
 st.caption(
     "[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/claromes/waybacktweets?include_prereleases)](https://github.com/claromes/waybacktweets/releases) [![Star](https://img.shields.io/github/stars/claromes/waybacktweets?style=social)](https://github.com/claromes/waybacktweets)"  # noqa: E501
 )
-st.write("Retrieve archived tweets CDX data in CSV, JSON, and HTML formats.")
+st.write(
+    "Retrieves archived tweets CDX data in HTML (for easy viewing of the tweets using the `iframe` tag), CSV, and JSON formats."  # noqa: E501
+)
 
 st.write(
     "This application uses the Wayback Tweets Python package, which can be used as a module or as a standalone command line tool. [Read the documentation](https://claromes.github.io/waybacktweets)."  # noqa: E501

diff --git a/docs/index.rst b/docs/index.rst
index 46b9945c0bbb50bce29e7bb7b1f5171d0a0a3942..99dfe60a668ecf49d3421833a1ae087ffcdfd3b7 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,7 +9,7 @@ Wayback Tweets
 
 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.
+Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see :ref:`field_options`), and saves the data in HTML (for easy viewing of the tweets using the ``iframe`` tag), CSV, and JSON formats.
 
 .. 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/quickstart.rst b/docs/quickstart.rst
index 4e3c4d7e11b81aca8adc95c78fd39ca2c142106b..d05e5c7d26c7c9831e1ca3b6fa2b0a228e69186e 100644 (file)
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -4,7 +4,7 @@ Quickstart
 CLI
 -------------
 
-Using Wayback Tweets as a standalone command line tool
+Using Wayback Tweets as a standalone command line tool.
 
 waybacktweets [OPTIONS] USERNAME
 
@@ -12,11 +12,17 @@ waybacktweets [OPTIONS] USERNAME
 
     waybacktweets --from 20150101 --to 20191231 --limit 250 jack
 
+Web App
+-------------
+
+Using Wayback Tweets as a Streamlit Web App.
+
+`Open the application <https://waybacktweets.streamlit.app>`_, a prototype written in Python with the Streamlit framework and hosted on Streamlit Cloud.
 
 Module
 -------------
 
-Using Wayback Tweets as a Python Module
+Using Wayback Tweets as a Python Module.
 
 .. code-block:: python
 
@@ -40,10 +46,3 @@ Using Wayback Tweets as a Python Module
 
         exporter = TweetsExporter(parsed_tweets, USERNAME, field_options)
         exporter.save_to_csv()
-
-Web App
--------------
-
-Using Wayback Tweets as a Streamlit Web App
-
-`Open the application <https://waybacktweets.streamlit.app>`_, a prototype written in Python with the Streamlit framework and hosted on Streamlit Cloud.

diff --git a/docs/streamlit.rst b/docs/streamlit.rst
index 56e16f605e8040cface651df2aabb7592e9fb0c3..ff964758c6703fa941fe961e38c51e06150a9e37 100644 (file)
--- a/docs/streamlit.rst
+++ b/docs/streamlit.rst
@@ -1,7 +1,7 @@
 Web App
 =========
 
-Aplication that displays multiple archived tweets on Wayback Machine to avoid opening each link manually. The application is a prototype written in Python with the Streamlit framework and hosted on Streamlit Cloud, allowing users to apply filters and view tweets that lack the original URL.
+The application is a prototype hosted on Streamlit Cloud, serving as an alternative to the command line tool.
 
 `Open the application <https://waybacktweets.streamlit.app>`_.
 

diff --git a/docs/todo.rst b/docs/todo.rst
index 295da466087f98aedb11a82279c9d09d86fb83f9..3c8d469b55f409e44df9500d3f176e5c18fc5a42 100644 (file)
--- a/docs/todo.rst
+++ b/docs/todo.rst
@@ -7,7 +7,7 @@ TODO
 
 |uncheck| Unit Tests
 
-|uncheck| JSON Parser: Create a separate function to handle JSON return, apply JsonParser (``waybacktweets/api/parse.py:111``), and avoid rate limiting
+|uncheck| JSON Parser: Create a separate function to handle JSON return, apply JsonParser (``waybacktweets/api/parse.py:110``), and avoid rate limiting
 
 |uncheck| Download images when tweet URL has extensions like JPG or PNG
 

diff --git a/pyproject.toml b/pyproject.toml
index fb6042f338df2eeb2c747fd90a2f5144c04ab9b5..f3ccec6be6ac50b43c8fa8940d5c72caeba94b85 100644 (file)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "waybacktweets"
-version = "1.0a3"
+version = "1.0a4"
 description = "Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing, and saves the data."
 authors = ["Claromes <support@claromes.com>"]
 license = "GPLv3"