From 51f2dae05b74d04f90dfa56098ca176257ae74c6 Mon Sep 17 00:00:00 2001 From: Claromes Date: Mon, 24 Jun 2024 13:03:31 -0300 Subject: [PATCH] update description --- README.md | 12 ++++++------ app/app.py | 6 ++++-- docs/index.rst | 2 +- docs/quickstart.rst | 17 ++++++++--------- docs/streamlit.rst | 2 +- docs/todo.rst | 2 +- pyproject.toml | 2 +- 7 files changed, 22 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index bb3f763..47d55da 100644 --- 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 1980449..379c892 100644 --- 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 46b9945..99dfe60 100644 --- 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 4e3c4d7..d05e5c7 100644 --- 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 `_, 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 `_, 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 56e16f6..ff96475 100644 --- 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 `_. diff --git a/docs/todo.rst b/docs/todo.rst index 295da46..3c8d469 100644 --- 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 fb6042f..f3ccec6 100644 --- 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 "] license = "GPLv3" -- 2.34.1