update docs and fix app image

Author: claromes

README.md

@@ -6,14 +6,12 @@ Retrieves archived tweets CDX data from the Wayback Machine, performs necessary
 
 ## Installation
 
-Python 3.10+ is required to install `waybacktweets`.
+It is compatible with Python versions 3.10 and above. [See installation options](https://waybacktweets.claromes.com/installation).
 
 ```shell
 pipx install waybacktweets
 ```
 
-[Read more about the installation options](https://waybacktweets.claromes.com/installation).
-
 ## CLI
 
 ```shell
@@ -43,11 +41,14 @@ Options:
   -v, --verbose                   Shows the log.
   --version                       Show the version and exit.
   -h, --help                      Show this message and exit.
+
 Examples:
   waybacktweets jack
   waybacktweets --from 20200305 --to 20231231 --limit 300 --verbose jack
+
 Repository:
   https://github.com/claromes/waybacktweets
+
 Documentation:
   https://waybacktweets.claromes.com
 ```
@@ -102,13 +103,13 @@ Important: Starting from version 1.0, the web app will no longer receive all upd
 
 ## Documentation
 
-- [Wayback Tweets documentation](https://waybacktweets.claromes.com/)
-- [Wayback CDX Server API (Beta) documentation](https://archive.org/developers/wayback-cdx-server.html)
+- [Wayback Tweets documentation](https://waybacktweets.claromes.com/).
+- [Wayback CDX Server API (Beta) documentation](https://archive.org/developers/wayback-cdx-server.html).
 
 ## Acknowledgements
 
 - Tristan Lee (Bellingcat's Data Scientist) for the idea.
-- Jessica Smith (Snowflake's Community Growth Specialist) and Streamlit/Snowflake team for the additional server resources on Streamlit Cloud.
+- Jessica Smith (Snowflake's Community Growth Specialist) and Streamlit team for the additional server resources on Streamlit Cloud.
 - OSINT Community for recommending the package and the application.
 
 ## License

app/app.py

@@ -103,6 +103,9 @@
         div[class="st-emotion-cache-1v0mbdj e115fcil1"] {
             max-width: 100%;
         }
+        div[data-testid="stElementToolbarButtonContainer"] {
+            display: none;
+        }
     </style>
     """
 )
@@ -176,7 +179,7 @@ def scroll_page():
 
 # ------ UI Settings ------ #
 
-st.image(TITLE, use_container_width="never")
+st.image(TITLE, width=None)
 st.write(
     "Retrieves archived tweets CDX data in HTML, CSV, and JSON formats."  # noqa: E501
 )
@@ -211,7 +214,7 @@ def scroll_page():
 limit = st.text_input(
     "Limit",
     key="limit",
-    help="Query result limits",
+    help="Query result limits (int)",
 )
 
 unique = st.checkbox(

docs/api.rst

@@ -1,3 +1,5 @@
+.. _api:
+
 API
 ====
 

docs/outputs.rst

@@ -16,6 +16,8 @@ This format allows for easy viewing of the archived tweets, through the use of t
 
 - ``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. Refer to the :ref:`utils` for more details.
 
+If you want to define which viewing options should be displayed in the HTML file, you need to use the package as a module and specify the desired view in the field options. See the :ref:`api` Reference and the :ref:`module` usage example.
+
 Additionally, other fields are displayed.
 
 .. note::

docs/quickstart.rst

@@ -12,6 +12,8 @@ waybacktweets [OPTIONS] USERNAME
 
     waybacktweets --from 20150101 --to 20191231 --limit 250 jack
 
+.. _module:
+
 Module
 -------------
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "waybacktweets"
-version = "1.0"
+version = "1.0rc1"
 description = "Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing, and saves the data."
 authors = ["Claromes <support@claromes.com>"]
 license = "GPLv3"

waybacktweets/_cli.py

@@ -38,15 +38,18 @@ def format_help(
         formatter.write_text("  USERNAME: The Twitter username without @")
 
         self.format_options(ctx, formatter)
+        formatter.write("\n")
 
         formatter.write_heading("Examples")
         formatter.write_text("  waybacktweets jack")
         formatter.write_text(
             "  waybacktweets --from 20200305 --to 20231231 --limit 300 --verbose jack"
         )
+        formatter.write("\n")
 
         formatter.write_heading("Repository")
         formatter.write_text("  https://github.com/claromes/waybacktweets")
+        formatter.write("\n")
 
         formatter.write_heading("Documentation")
         formatter.write_text("  https://waybacktweets.claromes.com")

waybacktweets/api/parse.py

@@ -321,7 +321,7 @@ def parse(self, print_progress=False) -> Dict[str, List[Any]]:
 
             if self.show_resume_key:
                 rprint(
-                    f'[blue]Resumption Key: [bold]{self.archived_tweets_response[-1][0]}[/bold][/blue]\nUse this Resumption Key option (--resumption_key in the CLI or "resumption_key" in field_options via the API) to continue the query from where the previous one left off. This allows you to split a large query into smaller, more efficient ones.\n'  # noqa: E501
+                    f'[blue]Resumption Key: [bold]{self.archived_tweets_response[-1][0]}[/bold][/blue]\nUse this Resumption Key option (--resumption_key in the CLI or "resumption_key" in the Module) to continue the query from where the previous one left off. This allows you to split a large query into smaller, more efficient ones.\n'  # noqa: E501
                 )
 
             return self.parsed_tweets