update copy, todo and logo

diff --git a/app/app.py b/app/app.py
index ac2683f8d8baa99fa7ab8f2f114a79521e5749aa..e0245da9598f1d0677c48e725f0b422a947ece3f 100644 (file)
--- 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;
+    }
 </style>
 """
 )
@@ -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 (file)
index 3be2d40..0000000
--- a/app/assets/parthenon.svg
+++ /dev/null
@@ -1,26 +0,0 @@
-<svg width="400" height="400" viewBox="0 0 400 400" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M66.3377 155.388C65.7708 151.515 66.1155 142.825 71.4265 141.899C79.0689 140.57 79.2956 146.18 84.6566 147.58C96.4535 150.665 174.292 120.705 191.564 116.358C198.101 114.713 198.198 105 210.563 105C216.167 105 212.949 113.528 227.103 117.659C231.821 119.036 321.537 144.755 335.638 153.613C336.375 154.076 342.097 149.711 345.475 149.711C349.585 149.711 348.061 156.318 347.512 158.231" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M76.0438 157.18C104.715 153.671 133.644 159.144 162.337 159.144C180.702 159.144 198.876 159.796 217.155 160.78C232.592 161.607 248.391 161.432 263.851 161.432C268.61 161.432 339.399 162.499 339.992 163.068C341.344 164.376 339.313 175.156 339.313 177.794C339.313 179.238 340.507 188.39 339.992 188.592C312.456 199.24 148.067 185.975 105.484 185.975C100.317 185.975 74.2748 188.841 70.6327 185.319C69.0401 183.779 71.0896 170.186 71.3068 167.649" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M50.2399 286.757C48.2835 274.679 58.8072 280.438 63.1705 276.216C65.5956 273.869 62.1377 268.977 67.2563 267.326C86.9115 260.985 201.221 265.128 226.173 267.326C254.045 269.778 307.073 262.416 331.665 271.936C337.53 274.208 346.898 286.066 349.359 294" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M78.54 192.729C75.2103 217.791 74.8765 243.244 74.8765 268.404" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M95.6602 189.392C95.5489 213.231 94.1778 238.972 96.1587 261.728" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M120.11 189.392C117.82 213.426 116.295 237.66 114.546 261.728" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M133.018 191.617C130.467 214.481 133.489 242.725 131.687 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M156.834 190.504C155.165 212.389 152.383 234.105 152.383 256.163" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M170.257 192.729C170.227 216.032 169.009 239.434 169.009 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M127.227 203.675C125.215 203.711 123.631 203.17 121.895 202.927" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M164.531 202.629C161.934 203.12 160.138 201.951 158.041 201.631" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M194.64 190.504C194.317 211.918 192.477 233.888 192.477 255.05" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M211.075 192.729C210.357 215.678 210.574 238.717 210.574 261.727" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M234.735 198.294C230.696 217.051 233.372 237.419 230.283 256.163" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M247.257 198.294C247.517 219.421 248.118 240.78 248.922 261.727" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M276.09 198.294C276.696 219.814 273.428 241.434 273.428 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M293.809 199.407C293.414 220.715 294.808 241.656 294.808 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M321 199.407C320.7 220.28 317.879 247.076 319.001 265.066" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M335.889 198.294C335.35 223.471 333.895 248.801 333.895 273.968" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M196.897 203.278C200.248 202.326 202.739 203.495 205.8 203.695" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M233.622 204.357C235.117 204.099 236.593 203.716 238.074 203.36" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M281.475 207.848C282.979 208.035 284.481 207.724 285.926 207.601" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M81.1602 206.21C82.665 206.459 84.1663 206.045 85.6116 205.88" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M324.876 210.348C328.342 210.461 331.54 209.814 334.892 209.597" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-</svg>

diff --git a/assets/parthenon.svg b/assets/parthenon.svg
new file mode 100644 (file)
index 0000000..3be2d40
--- /dev/null
+++ b/assets/parthenon.svg
@@ -0,0 +1,26 @@
+<svg width="400" height="400" viewBox="0 0 400 400" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M66.3377 155.388C65.7708 151.515 66.1155 142.825 71.4265 141.899C79.0689 140.57 79.2956 146.18 84.6566 147.58C96.4535 150.665 174.292 120.705 191.564 116.358C198.101 114.713 198.198 105 210.563 105C216.167 105 212.949 113.528 227.103 117.659C231.821 119.036 321.537 144.755 335.638 153.613C336.375 154.076 342.097 149.711 345.475 149.711C349.585 149.711 348.061 156.318 347.512 158.231" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M76.0438 157.18C104.715 153.671 133.644 159.144 162.337 159.144C180.702 159.144 198.876 159.796 217.155 160.78C232.592 161.607 248.391 161.432 263.851 161.432C268.61 161.432 339.399 162.499 339.992 163.068C341.344 164.376 339.313 175.156 339.313 177.794C339.313 179.238 340.507 188.39 339.992 188.592C312.456 199.24 148.067 185.975 105.484 185.975C100.317 185.975 74.2748 188.841 70.6327 185.319C69.0401 183.779 71.0896 170.186 71.3068 167.649" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M50.2399 286.757C48.2835 274.679 58.8072 280.438 63.1705 276.216C65.5956 273.869 62.1377 268.977 67.2563 267.326C86.9115 260.985 201.221 265.128 226.173 267.326C254.045 269.778 307.073 262.416 331.665 271.936C337.53 274.208 346.898 286.066 349.359 294" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M78.54 192.729C75.2103 217.791 74.8765 243.244 74.8765 268.404" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M95.6602 189.392C95.5489 213.231 94.1778 238.972 96.1587 261.728" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M120.11 189.392C117.82 213.426 116.295 237.66 114.546 261.728" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M133.018 191.617C130.467 214.481 133.489 242.725 131.687 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M156.834 190.504C155.165 212.389 152.383 234.105 152.383 256.163" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M170.257 192.729C170.227 216.032 169.009 239.434 169.009 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M127.227 203.675C125.215 203.711 123.631 203.17 121.895 202.927" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M164.531 202.629C161.934 203.12 160.138 201.951 158.041 201.631" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M194.64 190.504C194.317 211.918 192.477 233.888 192.477 255.05" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M211.075 192.729C210.357 215.678 210.574 238.717 210.574 261.727" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M234.735 198.294C230.696 217.051 233.372 237.419 230.283 256.163" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M247.257 198.294C247.517 219.421 248.118 240.78 248.922 261.727" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M276.09 198.294C276.696 219.814 273.428 241.434 273.428 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M293.809 199.407C293.414 220.715 294.808 241.656 294.808 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M321 199.407C320.7 220.28 317.879 247.076 319.001 265.066" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M335.889 198.294C335.35 223.471 333.895 248.801 333.895 273.968" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M196.897 203.278C200.248 202.326 202.739 203.495 205.8 203.695" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M233.622 204.357C235.117 204.099 236.593 203.716 238.074 203.36" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M281.475 207.848C282.979 208.035 284.481 207.724 285.926 207.601" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M81.1602 206.21C82.665 206.459 84.1663 206.045 85.6116 205.88" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M324.876 210.348C328.342 210.461 331.54 209.814 334.892 209.597" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>

diff --git a/assets/waybacktweets.png b/assets/waybacktweets.png
new file mode 100644 (file)
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 (file)
index 3be2d40..0000000
--- a/docs/_static/parthenon.svg
+++ /dev/null
@@ -1,26 +0,0 @@
-<svg width="400" height="400" viewBox="0 0 400 400" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M66.3377 155.388C65.7708 151.515 66.1155 142.825 71.4265 141.899C79.0689 140.57 79.2956 146.18 84.6566 147.58C96.4535 150.665 174.292 120.705 191.564 116.358C198.101 114.713 198.198 105 210.563 105C216.167 105 212.949 113.528 227.103 117.659C231.821 119.036 321.537 144.755 335.638 153.613C336.375 154.076 342.097 149.711 345.475 149.711C349.585 149.711 348.061 156.318 347.512 158.231" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M76.0438 157.18C104.715 153.671 133.644 159.144 162.337 159.144C180.702 159.144 198.876 159.796 217.155 160.78C232.592 161.607 248.391 161.432 263.851 161.432C268.61 161.432 339.399 162.499 339.992 163.068C341.344 164.376 339.313 175.156 339.313 177.794C339.313 179.238 340.507 188.39 339.992 188.592C312.456 199.24 148.067 185.975 105.484 185.975C100.317 185.975 74.2748 188.841 70.6327 185.319C69.0401 183.779 71.0896 170.186 71.3068 167.649" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M50.2399 286.757C48.2835 274.679 58.8072 280.438 63.1705 276.216C65.5956 273.869 62.1377 268.977 67.2563 267.326C86.9115 260.985 201.221 265.128 226.173 267.326C254.045 269.778 307.073 262.416 331.665 271.936C337.53 274.208 346.898 286.066 349.359 294" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M78.54 192.729C75.2103 217.791 74.8765 243.244 74.8765 268.404" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M95.6602 189.392C95.5489 213.231 94.1778 238.972 96.1587 261.728" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M120.11 189.392C117.82 213.426 116.295 237.66 114.546 261.728" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M133.018 191.617C130.467 214.481 133.489 242.725 131.687 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M156.834 190.504C155.165 212.389 152.383 234.105 152.383 256.163" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M170.257 192.729C170.227 216.032 169.009 239.434 169.009 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M127.227 203.675C125.215 203.711 123.631 203.17 121.895 202.927" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M164.531 202.629C161.934 203.12 160.138 201.951 158.041 201.631" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M194.64 190.504C194.317 211.918 192.477 233.888 192.477 255.05" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M211.075 192.729C210.357 215.678 210.574 238.717 210.574 261.727" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M234.735 198.294C230.696 217.051 233.372 237.419 230.283 256.163" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M247.257 198.294C247.517 219.421 248.118 240.78 248.922 261.727" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M276.09 198.294C276.696 219.814 273.428 241.434 273.428 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M293.809 199.407C293.414 220.715 294.808 241.656 294.808 262.84" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M321 199.407C320.7 220.28 317.879 247.076 319.001 265.066" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M335.889 198.294C335.35 223.471 333.895 248.801 333.895 273.968" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M196.897 203.278C200.248 202.326 202.739 203.495 205.8 203.695" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M233.622 204.357C235.117 204.099 236.593 203.716 238.074 203.36" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M281.475 207.848C282.979 208.035 284.481 207.724 285.926 207.601" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M81.1602 206.21C82.665 206.459 84.1663 206.045 85.6116 205.88" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M324.876 210.348C328.342 210.461 331.54 209.814 334.892 209.597" stroke="black" stroke-opacity="0.9" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
-</svg>

diff --git a/docs/cli.rst b/docs/cli.rst
index f64b299f71f2040e7c00ce1eef3773c3a8a1b20a..0d6b8f32865051b3a32c43a5fd976f8dc9a128b9 100644 (file)
--- 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 <http://crawler.archive.org/articles/user_manual/glossary.html#surt>`_-order format.)

diff --git a/docs/conf.py b/docs/conf.py
index 5debc6e3522911752256b6734ba7c629cfcbaac2..643113f169ad6af0c7f52669ca584ab3c7572025 100644 (file)
--- 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 df486091b9c08a554f1ca8bbe72563b929e72939..c6e5175ae97dff98a7ed012b05223dd14a44a4b0 100644 (file)
--- 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 58d1febfec31e6ea64f9586693b84bee2a30ecff..1dce34299a778cba4d7aa2b490863cc657a7365e 100644 (file)
--- a/docs/todo.rst
+++ b/docs/todo.rst
@@ -5,9 +5,11 @@ TODO
 
     <input type="checkbox">
 
-|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`)