From: Claromes Date: Sat, 15 Jun 2024 22:34:33 +0000 (-0300) Subject: update copy, todo and logo X-Git-Url: https://git.claromes.com/?a=commitdiff_plain;h=72c1d224bc52c526e16ff75a348e60eddd52cfdd;p=waybacktweets.git update copy, todo and logo --- diff --git a/app/app.py b/app/app.py index ac2683f..e0245da 100644 --- a/app/app.py +++ b/app/app.py @@ -15,7 +15,8 @@ from waybacktweets.utils.utils import ( # Initial Settings -LOGO = "app/assets/parthenon.svg" +LOGO = "assets/parthenon.svg" +TITLE = "assets/waybacktweets.png" st.set_page_config( page_title="Wayback Tweets", @@ -55,6 +56,9 @@ st.html( scale: 4; padding-left: 10px; } + button[data-testid="StyledFullScreenButton"] { + display: none; + } """ ) @@ -163,10 +167,7 @@ Retrieve archived tweets CDX data in CSV, JSON, and HTML formats using the comma Read the documentation: [claromes.github.io/waybacktweets](https://claromes.github.io/waybacktweets).""" # noqa: E501 ) -st.title( - "Wayback Tweets", - anchor=False, -) +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 ) diff --git a/app/assets/parthenon.svg b/app/assets/parthenon.svg deleted file mode 100644 index 3be2d40..0000000 --- a/app/assets/parthenon.svg +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/assets/parthenon.svg b/assets/parthenon.svg new file mode 100644 index 0000000..3be2d40 --- /dev/null +++ b/assets/parthenon.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/waybacktweets.png b/assets/waybacktweets.png new file mode 100644 index 0000000..937a666 Binary files /dev/null and b/assets/waybacktweets.png differ diff --git a/docs/_static/parthenon.svg b/docs/_static/parthenon.svg deleted file mode 100644 index 3be2d40..0000000 --- a/docs/_static/parthenon.svg +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/cli.rst b/docs/cli.rst index f64b299..0d6b8f3 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -71,7 +71,7 @@ Read below text extracted from the official Wayback CDX Server API (Beta) docume The matchType may also be set implicitly by using wildcard '*' at end or beginning of the url: - - If url is ends in '/*', eg url=archive.org/* the query is equivalent to url=archive.org/&matchType=prefix - - If url starts with '*.', eg url=*.archive.org/ the query is equivalent to url=archive.org/&matchType=domain + - If url is ends in '/\*', eg url=archive.org/\* the query is equivalent to url=archive.org/&matchType=prefix + - If url starts with '\*.', eg url=\*.archive.org/ the query is equivalent to url=archive.org/&matchType=domain (Note: The domain mode is only available if the CDX is in `SURT `_-order format.) diff --git a/docs/conf.py b/docs/conf.py index 5debc6e..643113f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,11 +3,9 @@ import datetime from pallets_sphinx_themes import ProjectLink, get_version project = "Wayback Tweets" -copyright = ( - f"2023 - {datetime.datetime.now().year}, Claromes · Icon by The Doodle Library" -) -author = "Claromes" release, version = get_version("waybacktweets") +copyright = f"2023 - {datetime.datetime.now().year}, Claromes · Icon by The Doodle Library · Title Font by Google, licensed under the Open Font License · Wayback Tweets v{version}" # noqa: E501 +author = "Claromes" # -- General configuration --------------------------------------------------- @@ -23,7 +21,6 @@ extensions = [ templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -autodoc_typehints = "description" # -- Options for HTML output ------------------------------------------------- @@ -46,7 +43,7 @@ html_sidebars = { "index": ["project.html", "localtoc.html", "searchbox.html"], "**": ["localtoc.html", "relations.html", "searchbox.html"], } -html_favicon = "_static/parthenon.svg" -html_logo = "_static/parthenon.svg" +html_favicon = "../assets/parthenon.svg" +html_logo = "../assets/parthenon.svg" html_title = f"Wayback Tweets Documentation ({version})" html_show_sourcelink = False diff --git a/docs/index.rst b/docs/index.rst index df48609..c6e5175 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,9 +3,8 @@ Wayback Tweets ================ - -Wayback Tweets Documentation ------------------------------- +.. image:: ../assets/waybacktweets.png + :align: center Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing, and saves the data in CSV, JSON, and HTML formats. diff --git a/docs/todo.rst b/docs/todo.rst index 58d1feb..1dce342 100644 --- a/docs/todo.rst +++ b/docs/todo.rst @@ -5,9 +5,11 @@ TODO -|uncheck| Code: JSON Issue: Create a separate function to handle JSON return, apply JsonParser (``waybacktweets/api/parse_tweets.py:73``), and avoid rate limiting +|uncheck| Code: JSON Issue: Create a separate function to handle JSON return, apply JsonParser (``waybacktweets/api/parse_tweets.py:73``), and avoid rate limiting (`Planned for v1.1`) -|uncheck| Docs: Add tutorial on how to save Tweet via command line +|uncheck| Docs: Add tutorial on how to save Tweet via command line (`Planned for v1.1`) -|uncheck| Web App: Return complete JSON when mimetype is ``application/json`` +|uncheck| Code: Download images when tweet URL has extensions like JPG or PNG (`Planned for v1.2`) + +|uncheck| Code: Develop a scraper to download snapshots from https://archive.today (`Not planned`)