From 72c1d224bc52c526e16ff75a348e60eddd52cfdd Mon Sep 17 00:00:00 2001 From: Claromes Date: Sat, 15 Jun 2024 19:34:33 -0300 Subject: [PATCH] update copy, todo and logo --- app/app.py | 11 ++++++----- {app/assets => assets}/parthenon.svg | 0 assets/waybacktweets.png | Bin 0 -> 5648 bytes docs/_static/parthenon.svg | 26 -------------------------- docs/cli.rst | 4 ++-- docs/conf.py | 11 ++++------- docs/index.rst | 5 ++--- docs/todo.rst | 8 +++++--- 8 files changed, 19 insertions(+), 46 deletions(-) rename {app/assets => assets}/parthenon.svg (100%) create mode 100644 assets/waybacktweets.png delete mode 100644 docs/_static/parthenon.svg 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/assets/parthenon.svg similarity index 100% rename from app/assets/parthenon.svg rename to assets/parthenon.svg diff --git a/assets/waybacktweets.png b/assets/waybacktweets.png new file mode 100644 index 0000000000000000000000000000000000000000..937a666e7ff9e7f71035d891aff09287d35728e0 GIT binary patch literal 5648 zcmeHLRZ|>{lAU4D!5s!CxVr{-cMBdQKyWA65ZocS>m(t#y9G!H?h@P?++FT>U$?#= zu(h>aby`mML-%>?XiaqmOfUot001zR6lJvm0HEYQxd1BYA0HxJbM{XFdT1+10~i0W z1^-i^xhfiY008Lt{{;|`ol61$Ahc_$>dO7o{D1r3q5$w;7x{PgUq}D1lK(1!sD)|! zKL^7-wbgY1+8+9-9F(QI6}TpEv-{m?Gt>irY?U*AS@v%$*_iYT`-#pyKEJb6h`^S< z%0RCawK;0fONP|QDIOUsM~ArmC#TNy>*CBhlS@np9&(KpkSesVTBG~3?FcK%inX5c zZ=5dK0(P5WkRZv#8Vu__S1wJkXcdo`6dx%V1Ct1woL^FcT!fL}jW9l0Dw;rtLqO}_ zkI_XDu6d44nmPthADMV36+&~nTFZCMkgT!Zxx~R~H$w{VAycjTvYvqk-MD1m1+{!3 z>Gq`Ja0}|GPs+c(r_CxR7%6l*o3Y3fr&JOKeQ5Dg{T4%8^8f(g-YdyU>H6j#=lGkb z8C~_vXO$-6y?@U~=>FmB5>v#L=t0$ctGCQ}ABdUjqfw!w43hHm~Pa5an`4?;!nmN!fzup2~ z;M&+V>HiZKMF98Qt6M$H6a8ue9!#^jS*Unw0236#108p8ZBEBnPiccpMB=@OHSP$x zC*G~u6850=8Mx4Oe!tnI@Z;MPsv-~0d0U3oqd!jOhRu9Q1pV}b(|+x_Tkl3<%y1OD zh%jX)tIt^}6+@p{5hn-0>4FY_+=4f+Iehu|@~A3p^3Bnq6PH3Agcj9S)N_8T`;7Z} zk@Ptr05W!kM^D0%aUYi6uw=lVsY@$|X}kJz&_nGWPZ&7kavq56l+ncdz(Photlpt9 z@0^G|KZE=QV>qlCfv*cWw0a7O z*2w5hNuG|iBZN`EpM8G@>Efe56nR$lg^Xu>vq?wlM`a)Ayg)9r5t?qzoWx2I+j8Jh z>>^N(HRFcr^Xe`Ta3vynphVB%$a+gE z+u66`e|Lba!yng|na<1vb>?ox)mxRt#k?wpLd zu8M9q?ZHQW;n87{7f)R#Gl;O@bubZV^0Hk-W6(m`AljyI!9nppXFv>pr&z;fNh`o9 z|7w*>tQt6}tIkIK!pP2M(oB}jIpk}}A^T)m`hvdSpX@?X!;9DQ1`}!p@c$-X?@z_%vr`c_a`@4>Y9)nB> zTb>y$3YVxzfy>r9FRE_TTS>fQu#o^0I3;!RGyB>Wt*(y{(wg<4d|vP3cVH=10`jh?7HgZdw=)|QH zV1>%`k`So4#Q=9}Zy9LEO9vKFkLQ4~wmTE|hpcVQgo1zp%LrrqR3U&{x95~}4sUP8 z-^lU)6Xijt8k{TpsX^mjzQ%pYBeo-T9{qxLUX|k}xY-F*kuO+WB60wdqB1e0`e*uP zUR`DHGJ2YyHCp7%_#1!TN zA*?CJXZh*oXt?0t^jv#3MC;Z2l#iJe*%8s_Myl?8N(voFk<%m@6V|$H$gU%Eq%$K2 zg5cQs>1ErN?R3>1AlbaX$gqs&|CEcU81;;j_a8ibulDbZxCSQO}WXu51QhKzx!Vs@bk= z7doQQYP5SO78rv7kZo4%$z!bZF|;3~44I6-AGz>u1919o5fO(&?kb6QXJ)yCEhCgJ z@^Fk)kk3k)QO!uc*w%;F#HvQklj;`H@%m+cR<1?6rQu+5zEQ z65v#bRvv8+dkH|?=CR=H2yY%vkp_&>Q5?TtxF_Z%u1~^){JMkbnn7r%_TB_6Rbw_i zS4g#oc}_8!?pBPyvvikd%VC3Bj`bWQjZ9>|lW$<|GG; z^ZTG{(}N$kRiM4!xvJALTp3bvJO}!7ylEZRy zPflY51{W)jhim@whv&W;s>N=mLWIk|7hODJI?s}m3a&OK0YYwQcefV==Cz}rIH9pv zg$3+9MOqJ(tb|*T{lLVdy-id%2-XHdW#4vD1^h%nXtBwovU#fb;eqZ*Itml%P69lp)_VW?^;=#|-P|XgUvMbY%K0OE*4+ydK(TF@=N2%g3?UrdzM zex+!^p3=5)qZzeT!3-=l_h7A-9*6QUi`31O=_@)66h$#}XDo7M|%?#>O+FRWY zSwoyS8mP82dmRK8Xiv|ft#C!v{UWh?q84=5cv@x}j9I|~4tWj8D+BU=jpEVv&A~-s z+?@zL+80p__Q&Y#m`f?g8VT(3Z(5qIqy%XqWU^LZNbu&~p)YeKKY$lf2NoD^HI)`h znZ#I3xIH=;fG$>U?Wi1;CM}t251S}J(*5ND^JaJ_>^u-0jA2r;if^$%-yeKb$J)?& zY=^si!Hw*GsnJ7^(jwo><_E&j8*G%|5?@wt<(N@HqwW_tr8D$AW-K7J>A;$}q94oI zNtq7CI(Su1{9@AAgMYK=2GRZi<^VR3q1tI{p0^k@V#-?C#IZ{8SyP_es~cZ10#rfm z*Z5a41Kd<=P`}RPZr^*#_#bQ6r2K<#Cu2=>dTpbl-Ig`7EXv5)-wL^cYn8(el%BNY;C&;9|B0#`TK*=3i#pO`(9AT)xzXp z#_?EZwtWc!48rxgwaIT>_S|b>i+^8)Jr~GnuqWU_K+UIJgX}#!u||kRgO2FSujQc3 z?-_!q()3}l=0BFhxr0y^$1H)_f)m@5o>H75SVtSWsqXJiqVBc-P8n40t>+hyjD*Gp&pyB!bblRFI8`)@>&8+-(7YQ8fs>Jp!CC^_Znf#24pIs zXdu=cIxZW=PonFQpo60PiHWXa<_)`}3ml-1u3e+ZH(f{W2yY__-D5cn^FHGVd!g~n8`swV7IpB5kGw*I+DEEQdQUmDtjG5niZTo!kI7RBLl zQ7U6#hp6R+e{ok4w@`~sL}xg$-s=Qx=D_6{wTEi86IWmIG@>=jDR>MK!w5C zYNOwY!*Z7wh12FArftpTH;Ef}+Pg7AxR{AXO@18zCp=_oI?+|6CgoT*!8fI`ZId(D z`SuoIRCAObLBoTp?sp!aHhRxBpo-~V7wf|4bQpgr>_lj*T{VO-c7~LR=+de~QK zZzJnk1DX1OB%vxe)gfi?y#gbfJ3bRaU5(7}VVdxa3>V^&q?L5Vgr|?Rr~jF#4wJc{ z%{tbVaq^z#eS=r5(dHN-Eaf@Nvi=;j||)s01!Qf5$Y_`ls?KAkucFx*fx1z zGBo96(V_=;uSWmPadFlA@udv6RCqJVGV>FP)^^QE;+k+Y@`kfQ?tv_H(O$NYbJQ@6 z6+K#dsWgrZ*z{4!CTlmcbVDAg4iuvYa+E=)w^fVQzSi{qYSW!Uc!T+s?=Teyk6_7a zzKPYA2PV*c6IR@JuOzfAAhzH`Rh#~9Bjlt-xt?5d_ua@iD9+lKdSn)&t~#OxOzO5$ z?KslRaN^#+aSPlJn6N#o3>23zCy{i!4Kjw)Hz8$EFiUQ~Yzck2?ixUU`)PSeawBLs z!H9ZMMl7GH&9!`3|8fsaTOM<1a^5afu-B~ zXs(bZ)H+uC`GPd{!VEOElyZXBF1P{3z}UO*Fmd&~`y0>%g7&F?goyGHTzhq4TfGzy z!tpP>MFRIqg&F1i4Ap+e$O~y%68rq=>SlhmNAU-X#%~VXpp8DVEsBpV1*IlkiaGxx zU|^LJ@qF;WI>(l0>()9_erOc!`+eQ!x>z*LrmB$J(o5X<>cH}~viKxo&6Vm@RG0Q} zy6UL}mPm2;l&)tL8B+Oxx%u(7v+RP0(gh-%`KoW{E9UKie*Xq#n)thx+s_k~4op20 zAK!+n;%PYlNnN@XWvyC(g?nFQoro4KI{q165P2LGb&=co!VkOa*@LC~@<>29?v2cDB8?yGzb{0}l2Co02Jb zGuqo-j+UYJ^GvMf&G0P}8>l6p(wiM|IeBVAtNZSBE_XBH)3jU{=vZGEMej*!P+62B zd+1bjM}2PHm*+d$u_&O3aBF@($JBF$Pb|3hl@mU{Sp-~rlzw@WS#mv~xaL(D9NPwFa4TSRM_V~qA+Xs-+=OQKf(*Alr*DZU1VbMl)B8g=* zJG=G5t*rnUn2!6ECRIQF>H#(+20SBU*9XhuN}mW0EtS1OXMmCq(^6bdW`Xt_!Aa(( zfChH8PVMs=^L}ITm6ur93zd@t^EKe(zv30$Kgu#WDxF;Bzpp+eId$18X^YSQ0hk?d Ai~s-t literal 0 HcmV?d00001 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`) -- 2.34.1