From 90a8611c2f4ee85ae8647995e3095c0605a97c0e Mon Sep 17 00:00:00 2001 From: Claromes Date: Sun, 16 Jun 2024 22:57:54 -0300 Subject: [PATCH] update file name --- .gitignore | 5 ++++- app/app.py | 6 +++--- docs/api.rst | 8 ++++---- docs/contribute.rst | 5 +++-- docs/todo.rst | 4 +--- waybacktweets/__init__.py | 8 ++++---- waybacktweets/_cli.py | 6 +++--- .../api/{export_tweets.py => export.py} | 2 +- waybacktweets/api/{parse_tweets.py => parse.py} | 13 ------------- .../api/{request_tweets.py => request.py} | 0 .../api/{viz_tweets.py => visualize.py} | 0 .../config/__pycache__/__init__.cpython-311.pyc | Bin 256 -> 0 bytes .../config/__pycache__/config.cpython-311.pyc | Bin 741 -> 0 bytes waybacktweets/config/config.py | 2 +- .../__pycache__/__init__.cpython-311.pyc | Bin 434 -> 0 bytes .../__pycache__/exceptions.cpython-311.pyc | Bin 1541 -> 0 bytes 16 files changed, 24 insertions(+), 35 deletions(-) rename waybacktweets/api/{export_tweets.py => export.py} (98%) rename waybacktweets/api/{parse_tweets.py => parse.py} (95%) rename waybacktweets/api/{request_tweets.py => request.py} (100%) rename waybacktweets/api/{viz_tweets.py => visualize.py} (100%) delete mode 100644 waybacktweets/config/__pycache__/__init__.cpython-311.pyc delete mode 100644 waybacktweets/config/__pycache__/config.cpython-311.pyc delete mode 100644 waybacktweets/exceptions/__pycache__/__init__.cpython-311.pyc delete mode 100644 waybacktweets/exceptions/__pycache__/exceptions.cpython-311.pyc diff --git a/.gitignore b/.gitignore index 26166db..5df8b23 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,12 @@ *.csv *.json *.html + waybacktweets/__pycache__ waybacktweets/api/__pycache__ -waybacktweets/cli/__pycache__ +waybacktweets/config/__pycache__ +waybacktweets/exceptions/__pycache__ waybacktweets/utils/__pycache__ + docs/_build/ notes.md diff --git a/app/app.py b/app/app.py index b1db36b..b0c6f71 100644 --- a/app/app.py +++ b/app/app.py @@ -3,9 +3,9 @@ import datetime import streamlit as st import streamlit.components.v1 as components -from waybacktweets.api.export_tweets import TweetsExporter -from waybacktweets.api.parse_tweets import JsonParser, TweetsParser -from waybacktweets.api.request_tweets import WaybackTweets +from waybacktweets.api.export import TweetsExporter +from waybacktweets.api.parse import JsonParser, TweetsParser +from waybacktweets.api.request import WaybackTweets from waybacktweets.config.config import config from waybacktweets.exceptions.exceptions import ( ConnectionError, diff --git a/docs/api.rst b/docs/api.rst index ee5ad43..7e7ab9f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -32,7 +32,7 @@ Exceptions Export --------- -.. automodule:: waybacktweets.api.export_tweets +.. automodule:: waybacktweets.api.export .. autoclass:: TweetsExporter :members: @@ -41,7 +41,7 @@ Export Parse --------- -.. automodule:: waybacktweets.api.parse_tweets +.. automodule:: waybacktweets.api.parse .. autoclass:: TweetsParser :members: @@ -56,7 +56,7 @@ Parse Request --------- -.. automodule:: waybacktweets.api.request_tweets +.. automodule:: waybacktweets.api.request .. autoclass:: WaybackTweets :members: @@ -80,7 +80,7 @@ Utils Visualizer ----------- -.. automodule:: waybacktweets.api.viz_tweets +.. automodule:: waybacktweets.api.visualize .. autoclass:: HTMLTweetsVisualizer :members: diff --git a/docs/contribute.rst b/docs/contribute.rst index 84ed2cb..0191658 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -27,10 +27,11 @@ Brief explanation about the code under the Wayback Tweets directory: - ``assets``: Title and logo images - ``docs``: Documentation generated with Sphinx - ``waybacktweets/api``: Main package modules -- ``waybacktweets/cli``: Command line Interface module +- ``waybacktweets/config``: Global configuration module +- ``waybacktweets/exceptions``: Wayback Tweets Exceptions - ``waybacktweets/utils``: Helper functions used in the package Sponsoring ------------ +------------ You can also donate to the project's developer and maintainer, `Claromes `_, via `GitHub Sponsor `_ or if you are interested in sponsoring the project you can contact via email at support at claromes dot com. diff --git a/docs/todo.rst b/docs/todo.rst index cda3ea5..eaced03 100644 --- a/docs/todo.rst +++ b/docs/todo.rst @@ -5,9 +5,7 @@ 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 (`Planned for v1.1`) - -|uncheck| Docs: Add tutorial on how to save Tweet via command line (`Planned for v1.1`) +|uncheck| Code: JSON Parser: Create a separate function to handle JSON return, apply JsonParser (``waybacktweets/api/parse.py:111``), and avoid rate limiting (`Planned for v1.1`) |uncheck| Code: Download images when tweet URL has extensions like JPG or PNG (`Planned for v1.2`) diff --git a/waybacktweets/__init__.py b/waybacktweets/__init__.py index 75b5ae4..f8333d8 100644 --- a/waybacktweets/__init__.py +++ b/waybacktweets/__init__.py @@ -1,8 +1,8 @@ # flake8: noqa: F401 -from waybacktweets.api.export_tweets import TweetsExporter -from waybacktweets.api.parse_tweets import JsonParser, TweetsParser, TwitterEmbed -from waybacktweets.api.request_tweets import WaybackTweets -from waybacktweets.api.viz_tweets import HTMLTweetsVisualizer +from waybacktweets.api.export import TweetsExporter +from waybacktweets.api.parse import JsonParser, TweetsParser, TwitterEmbed +from waybacktweets.api.request import WaybackTweets +from waybacktweets.api.visualize import HTMLTweetsVisualizer __version__ = "1.0" diff --git a/waybacktweets/_cli.py b/waybacktweets/_cli.py index 74fb140..6039477 100644 --- a/waybacktweets/_cli.py +++ b/waybacktweets/_cli.py @@ -8,9 +8,9 @@ from typing import Any, Optional import click from rich import print as rprint -from waybacktweets.api.export_tweets import TweetsExporter -from waybacktweets.api.parse_tweets import TweetsParser -from waybacktweets.api.request_tweets import WaybackTweets +from waybacktweets.api.export import TweetsExporter +from waybacktweets.api.parse import TweetsParser +from waybacktweets.api.request import WaybackTweets from waybacktweets.config.config import config diff --git a/waybacktweets/api/export_tweets.py b/waybacktweets/api/export.py similarity index 98% rename from waybacktweets/api/export_tweets.py rename to waybacktweets/api/export.py index a6daf41..7751679 100644 --- a/waybacktweets/api/export_tweets.py +++ b/waybacktweets/api/export.py @@ -9,7 +9,7 @@ from typing import Any, Dict, List, Optional import pandas as pd -from waybacktweets.api.viz_tweets import HTMLTweetsVisualizer +from waybacktweets.api.visualize import HTMLTweetsVisualizer class TweetsExporter: diff --git a/waybacktweets/api/parse_tweets.py b/waybacktweets/api/parse.py similarity index 95% rename from waybacktweets/api/parse_tweets.py rename to waybacktweets/api/parse.py index 0b6c8d5..519696c 100644 --- a/waybacktweets/api/parse_tweets.py +++ b/waybacktweets/api/parse.py @@ -108,7 +108,6 @@ class TwitterEmbed: return None -# TODO: JSON Issue - Create separate function to handle JSON return without hitting rate limiting # noqa: E501 class JsonParser: """ Class responsible for parsing tweets when the mimetype is application/json.\n @@ -236,18 +235,6 @@ class TweetsParser: self._add_field("available_tweet_is_RT", available_tweet_is_RT) self._add_field("available_tweet_info", available_tweet_info) - # TODO: JSON Issue - # parsed_text_json = "" - - # if response[3] == "application/json": - # json_parser = JsonParser(encoded_parsed_archived_tweet) - # text_json = json_parser.parse() - - # if text_json: - # parsed_text_json = semicolon_parser(text_json) - - # self._add_field("parsed_tweet_text_mimetype_json", parsed_text_json) - self._add_field("archived_urlkey", response[0]) self._add_field("archived_timestamp", response[1]) self._add_field("original_tweet_url", encoded_tweet) diff --git a/waybacktweets/api/request_tweets.py b/waybacktweets/api/request.py similarity index 100% rename from waybacktweets/api/request_tweets.py rename to waybacktweets/api/request.py diff --git a/waybacktweets/api/viz_tweets.py b/waybacktweets/api/visualize.py similarity index 100% rename from waybacktweets/api/viz_tweets.py rename to waybacktweets/api/visualize.py diff --git a/waybacktweets/config/__pycache__/__init__.cpython-311.pyc b/waybacktweets/config/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 9b453bccfd1a1f0af21945a66cc5331f6f08b618..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 256 zcmZ3^%ge<81gsPC(_De{V-N=hn4pZ$LO{lJh7^Vr#vF!R#wbQch7_h?22JLdAO)I? zx7d>N^U^ZY{WO_wNtY*9CM70kmz1ZbmK5tjB%o9gGf??ThR+~fzdZFb@^e%5lXDV_ zfON5bN@`hZPJTgdYF>#xiWz7;h>7~~@tJvBjE6n=M-Wmm+dfkFtBR;!>`ONS1nONLDK(o9;8v+gX5$~yN>N=V4yA%hFv zvvx`;`8|cAwSPdxoig>EWV_JPJM_Kpz0>=?r$b+cLmzN`TdV0y0`S8oyX9`l<~5RA z5D)`}QxN0^1ihmG_xN-xCKM#O!{mNff|v^DJ%sMniT{olJe4L$b2Z_4kf>ssrIqGo zri#GGvdoIq1m#StDxImSL@EQmSmasKzBBTZy(|)En{1vTxdjO^!QrUr2`Zf_+TQeH zSGZ{I)qQr-x}DYibEzlF$Yeh?c3W=cHcwlrYjO9W@;{@BA1j<%N```77(LAnL+saaj)-%ZjXI?CQyO z;?b_sM=LW#Si<+C=PP%8u)@8;0^n?CVb3-fd@dQQea7ZWRJr8`jD4(lzCCd#O67Wh zOSnhX2N$*7i2%p_H{1-Ywt2GWCymKa0!dRuRjMq_=l^bPsi)yrPol;wj;ED FzX9`VuF?Pi diff --git a/waybacktweets/config/config.py b/waybacktweets/config/config.py index eb6e6dd..5d1ab67 100644 --- a/waybacktweets/config/config.py +++ b/waybacktweets/config/config.py @@ -10,7 +10,7 @@ class _Config: config = _Config() """ -Configuration settings.. +Configuration settings. .. attribute:: verbose diff --git a/waybacktweets/exceptions/__pycache__/__init__.cpython-311.pyc b/waybacktweets/exceptions/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 8d74104bfdfa2b50fe0f5058797fc1f939a504db..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 434 zcmb`E%SyyB6ozwY>jeh~A3;~$OkP0T$e=D18SAD9r8Y+_HW!kNW1qxF5Vt-~x31h3 zW;ZJns_3}(K)&;zAI_gZUPhyBE4-M#t#9)|BCUt+oM#WUiF;|2+wV?lBvXii0x zMyaTL3safu{;|Nc=4g^-nNSKpc<+YfgM7`Bu2D_hwZVhC|D2bemhW{h$}96;4L6*MX#RYF!sJg8`rVyBGm#DO2c ziTwl6#GlC#^~!}CMdh>;e(ki?k}|2T^Y~4kC-&plZ~CoTwUKP~m(k%bjL=WGnYKb2 zOuoqA1o^0g4787Y{0aF6!(UB=zROFuj-fbHauzc(oT<2iiBdoEC_P0Juygj*c@qW9k!x@{3dd*fSug4bER3Bay|Y+t zEOR%v;>^Q(f5_oT6clA3HYI$V{eD=DWZF5Lyb>;(rUT~s?QX!LL9EkMo8_Evw=0;h zlEtNr#9Buf)&)5-aWc6;Ll}dF^o&hRlPi(2lnjI`(F& zi~X*FUw})C{N7Ehv}?a0T+(mlNxS__JH5HkDexD2ybK-zpxkpgy^~mJ*B(K*q{oeB z(2s}bzn5DJ%`y;@>6h}qBDeyE0ia}ahMmMpyEY8MR;|R#avW7=%j)V^^`s6-WkJn+ zzU0oz5A^r>kYANEz<-1IEn#e8jK_w7tuX?yF}^=WdH6j115f|XsWQe5P-Y>ywgu7# xNK;Nq_duG3Wb-yi_duF*Qn~}uEF|j$q&px@IVs%*X%>>}HIVLtG|Q=6{sWSJV50y4 -- 2.34.1