update readme, description, add count state and update style

diff --git a/.streamlit/config.toml b/.streamlit/config.toml
index d50b43438a8ade74c04777408612a3cb925f4f6f..5fcdbd6a014dc912154f6f0b0b4fb0ee4b83281b 100644 (file)
--- a/.streamlit/config.toml
+++ b/.streamlit/config.toml
@@ -1,7 +1,9 @@
 [theme]
 base="light"
 primaryColor="#ab2e33"
+textColor="#000000"
 backgroundColor="#e7e7e7"
+font="serif"
 
 [client]
 displayEnabled=true

diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644 (file)
index df8fe21..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# Changelog
-
-## [v0.2](https://github.com/claromes/waybacktweets/releases/tag/v0.2) - 2023-08-16
-
-- Displays tweets as text
-- Displays RTs info
-- Displays JSON MIME type as JSON (if tweet was deleted)
-- Adds progress bar
-- Adds warning to `warc/revisit` MIME type
-- Improves code quality
-- Screenshot tests as an alternative to `iframe`
-  - Keeps `iframe`
-  - Each website screenshot takes too long
-
-## [v0.1.4](https://github.com/claromes/waybacktweets/releases/tag/v0.1.4) - 2023-07-21
-- Add Pagination via CDX Server API
-- Update theme/ style
-- Update about
-- Decrease tweets per page (30)
-- Fix `cache_data`
-
-## [v0.1.3.2](https://github.com/claromes/waybacktweets/releases/tag/v0.1.3.2) - 2023-06-04
-- Update Streamlit version
-
-## [v0.1.3.1](https://github.com/claromes/waybacktweets/releases/tag/v0.1.3.1) - 2023-06-01
-- Add `cache_data`
-
-## [v0.1.3](https://github.com/claromes/waybacktweets/releases/tag/v0.1.3) - 2023-05-31
-- Fix TypeError 'NoneType'
-
-## [v0.1.2.1](https://github.com/claromes/waybacktweets/releases/tag/v0.1.2.1) - 2023-05-27
-- Fix range
-
-## [v0.1.2](https://github.com/claromes/waybacktweets/releases/tag/v0.1.2) - 2023-05-19
-- Increase tweets per page (100)
-- Increase iframe height
-- Fix "Only deleted tweets" msg
-
-## [v0.1.1](https://github.com/claromes/waybacktweets/releases/tag/v0.1.1) - 2023-05-19
-- Fix scroll to top
-
-## [v0.1.0](https://github.com/claromes/waybacktweets/releases/tag/v0.1.0) - 2023-05-19
-- Add Pagination
-
-## [v0.0.2](https://github.com/claromes/waybacktweets/releases/tag/v0.0.2) - 2023-05-12
-- Minor bugs
-
-## [v0.0.1](https://github.com/claromes/waybacktweets/releases/tag/v0.0.1) - 2023-05-11
-- Initial commit

diff --git a/README.md b/README.md
index a8352e46c98ed1c234bb5366306b9beb99e41dde..5002568bfe6e02c0781d6c7f134dbe75e4f60c41 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
 
 # 🏛️ Wayback Tweets
 
-[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_red.svg)](https://waybacktweets.streamlit.app) [![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)
+[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://waybacktweets.streamlit.app) [![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)
 
 
 Tool that displays multiple archived tweets on Wayback Machine to avoid opening each link manually. Via [Wayback CDX Server API](https://github.com/internetarchive/wayback/tree/master/wayback-cdx-server).
@@ -18,8 +18,9 @@ Tool that displays multiple archived tweets on Wayback Machine to avoid opening
 
 ## Features
 
-- 30 tweets per page
-- Filtering by only deleted tweets
+- Tweets per page defined by user
+- Filtering by saved date
+- Filtering by deleted tweets
 
 ## Development
 
@@ -48,23 +49,7 @@ Streamlit will be served at http://localhost:8501
 - [x] `IndexError`
 - [ ] Timeout error
 
-## Roadmap
-
-- [x] Pagination
-    - [x] Footer
-    - [x] Disabled/ Empty
-- [x] Feedbacks
-- [ ] Download dataset
-- [x] Review data cache
-- [x] Changelog
-- [ ] Prevent duplicate URLs
-- [x] Range size defined by user
-- [ ] `parse_links` exception
-- [ ] Add current page to page title
-- [ ] Parse MIME type `warc/revisit`
-- [ ] Parse MIME type `text/plain`
-- [x] Filter by period/datetime
-- [ ] Apply filters by API endpoints
-- [ ] Add contributing guidelines
-
-## [Changelog](/CHANGELOG.md)
+## Docs
+
+- [Roadmap](docs/ROADMAP.md)
+- [Changelog](docs/CHANGELOG.md)

diff --git a/app.py b/app.py
index 5526d23869e1f4ee22b7c22b00f06b603d7c54a3..bebc4247a336933e66d9a19a16fb5e8f679c3640 100644 (file)
--- a/app.py
+++ b/app.py
@@ -18,10 +18,11 @@ st.set_page_config(
 
         [![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)
 
-        Tool that displays multiple archived tweets on Wayback Machine to avoid opening each link manually.
+        Tool that displays multiple archived tweets on Wayback Machine to avoid opening each link manually. Via Wayback CDX Server API.
 
-        - 30 tweets per page
-        - Filtering by only deleted tweets
+        - Tweets per page defined by user
+        - Filtering by saved date
+        - Filtering by deleted tweets
 
         This tool is experimental, please feel free to send your [feedbacks](https://github.com/claromes/waybacktweets/issues).
 
@@ -73,6 +74,9 @@ if 'offset' not in st.session_state:
 if 'date_created' not in st.session_state:
     st.session_state.date_created = (2006, year)
 
+if 'count' not in st.session_state:
+    st.session_state.count = False
+
 def scroll_into_view():
     js = f'''
     <script>
@@ -182,7 +186,7 @@ def attr(i):
 
 # UI
 st.title('Wayback Tweets [![Star](https://img.shields.io/github/stars/claromes/waybacktweets?style=social)](https://github.com/claromes/waybacktweets)', anchor=False)
-st.write('Display multiple archived tweets on Wayback Machine via Wayback CDX Server API')
+st.write('Display multiple archived tweets on Wayback Machine and avoid opening each link manually')
 
 handle = st.text_input('Username', placeholder='jack')
 
@@ -196,19 +200,19 @@ query = st.button('Query', type='primary', use_container_width=True)
 
 bar = st.empty()
 
-if query or handle :
+if query or st.session_state.count:
     if handle != st.session_state.current_handle:
         st.session_state.offset = 0
 
     if query != st.session_state.current_query:
         st.session_state.offset = 0
 
-    count = tweets_count(handle, st.session_state.date_created)
+    st.session_state.count = tweets_count(handle, st.session_state.date_created)
 
-    st.write(f'**{count} URLs have been captured**')
+    st.write(f'**{st.session_state.count} URLs have been captured**')
 
-    if tweets_per_page > count:
-        tweets_per_page = count
+    if tweets_per_page > st.session_state.count:
+        tweets_per_page = st.session_state.count
 
     try:
         bar.progress(0)
@@ -281,7 +285,7 @@ if query or handle :
                     st.divider()
 
             start_index = st.session_state.offset
-            end_index = min(count, start_index + tweets_per_page)
+            end_index = min(st.session_state.count, start_index + tweets_per_page)
 
             for i in range(tweets_per_page):
                 try:
@@ -321,7 +325,7 @@ if query or handle :
                     else:
                         st.session_state.prev_disabled = False
 
-                    if i + 1 == count:
+                    if i + 1 == st.session_state.count:
                         st.session_state.next_disabled = True
                     else:
                         st.session_state.next_disabled = False

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
new file mode 100644 (file)
index 0000000..df8fe21
--- /dev/null
+++ b/docs/CHANGELOG.md
@@ -0,0 +1,49 @@
+# Changelog
+
+## [v0.2](https://github.com/claromes/waybacktweets/releases/tag/v0.2) - 2023-08-16
+
+- Displays tweets as text
+- Displays RTs info
+- Displays JSON MIME type as JSON (if tweet was deleted)
+- Adds progress bar
+- Adds warning to `warc/revisit` MIME type
+- Improves code quality
+- Screenshot tests as an alternative to `iframe`
+  - Keeps `iframe`
+  - Each website screenshot takes too long
+
+## [v0.1.4](https://github.com/claromes/waybacktweets/releases/tag/v0.1.4) - 2023-07-21
+- Add Pagination via CDX Server API
+- Update theme/ style
+- Update about
+- Decrease tweets per page (30)
+- Fix `cache_data`
+
+## [v0.1.3.2](https://github.com/claromes/waybacktweets/releases/tag/v0.1.3.2) - 2023-06-04
+- Update Streamlit version
+
+## [v0.1.3.1](https://github.com/claromes/waybacktweets/releases/tag/v0.1.3.1) - 2023-06-01
+- Add `cache_data`
+
+## [v0.1.3](https://github.com/claromes/waybacktweets/releases/tag/v0.1.3) - 2023-05-31
+- Fix TypeError 'NoneType'
+
+## [v0.1.2.1](https://github.com/claromes/waybacktweets/releases/tag/v0.1.2.1) - 2023-05-27
+- Fix range
+
+## [v0.1.2](https://github.com/claromes/waybacktweets/releases/tag/v0.1.2) - 2023-05-19
+- Increase tweets per page (100)
+- Increase iframe height
+- Fix "Only deleted tweets" msg
+
+## [v0.1.1](https://github.com/claromes/waybacktweets/releases/tag/v0.1.1) - 2023-05-19
+- Fix scroll to top
+
+## [v0.1.0](https://github.com/claromes/waybacktweets/releases/tag/v0.1.0) - 2023-05-19
+- Add Pagination
+
+## [v0.0.2](https://github.com/claromes/waybacktweets/releases/tag/v0.0.2) - 2023-05-12
+- Minor bugs
+
+## [v0.0.1](https://github.com/claromes/waybacktweets/releases/tag/v0.0.1) - 2023-05-11
+- Initial commit

diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md
new file mode 100644 (file)
index 0000000..e6ae500
--- /dev/null
+++ b/docs/ROADMAP.md
@@ -0,0 +1,18 @@
+# Roadmap
+
+- [x] Pagination
+    - [x] Footer
+    - [x] Disabled/ Empty
+- [x] Feedbacks
+- [ ] Download dataset
+- [x] Review data cache
+- [x] Changelog
+- [ ] Prevent duplicate URLs
+- [x] Range size defined by user
+- [ ] `parse_links` exception
+- [ ] Add current page to page title
+- [ ] Parse MIME type `warc/revisit`
+- [ ] Parse MIME type `text/plain`
+- [x] Filter by period/datetime
+- [ ] Apply filters by API endpoints
+- [ ] Add contributing guidelines
\ No newline at end of file