Skip to content

Twitter News Bot Class

TwitterNewsBot

API Object to connect the NewsFinder and Tweeter classes to build a pipeline to automate finding, scraping and tweeting news.

ATTRIBUTE DESCRIPTION
news_finder

The NewsFinder object to use to find and scrape news articles

TYPE: NewsFinder

tweeter_obj

The Tweeter object to use to tweet the news articles

TYPE: Tweeter

topic

The topic to search for news articles

TYPE: str

no_of_articles

The number of articles to find and scrape, by default 5

TYPE: int

Source code in twitternewsbot/twitternewsbot.py 
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
class TwitterNewsBot():
    """
    API Object to connect the NewsFinder and Tweeter classes to build a pipeline to automate finding, scraping and tweeting news.

    Attributes
    ----------
    news_finder : NewsFinder
        The NewsFinder object to use to find and scrape news articles
    tweeter_obj : Tweeter
        The Tweeter object to use to tweet the news articles
    topic : str
        The topic to search for news articles
    no_of_articles : int
        The number of articles to find and scrape, by default 5    
    """

    #####################################
    # Initialization
    #####################################

    def __init__(self, news_finder: NewsFinder, tweeter_obj: Tweeter, topic: str, no_of_articles: int = 5):
        """Initialize the Bot class

        Parameters
        ----------
        news_finder : NewsFinder
            The NewsFinder object to use to find and scrape news articles
        tweeter_obj : Tweeter
            The Tweeter object to use to tweet the news articles
        topic : str
            The topic to search for news articles
        no_of_articles : int, optional
            The number of articles to find and scrape, by default 5

        Returns
        -------
        None

        Raises
        ------
        TypeError
            If news_finder is not a NewsFinder object
            If tweeter_obj is not a Tweeter object
            If topic is not a string
            If no_of_articles is not an integer
        """

        # Check if news_finder is a NewsFinder object
        if not isinstance(news_finder, NewsFinder):
            raise TypeError("news_finder must be a NewsFinder object")

        # Check if tweeter_obj is a Tweeter object
        if not isinstance(tweeter_obj, Tweeter):
            raise TypeError("tweeter_obj must be a Tweeter object")

        # Check if topic is a string
        if not isinstance(topic, str):
            raise TypeError("topic must be a string")

        # Check if no_of_articles is an integer
        if not isinstance(no_of_articles, int):
            raise TypeError("no_of_articles must be an integer")

        # Set the attributes
        self.news_finder = news_finder
        self.tweeter_obj = tweeter_obj
        self.__topic = topic
        self.__no_of_articles = no_of_articles

    #####################################
    # Private Methods
    #####################################

    def __build_pipeline(self, **kwargs) -> dict:
        """Private: Build the pipeline to find, scrape and tweet news articles

        Parameters
        ----------
        **kwargs : dict
            Arguments for Tweeter.tweet function excluding articles_list. See Tweeter.tweet for more details on the args. 

        Returns
        -------
        dict
            A dictionary containing the total character count, the number of tweets posted, and the id of the parent tweet when run
        """

        # Build the pipeline
        articles = self.news_finder.get_news_articles(topic=self.__topic,number_of_articles=self.__no_of_articles, article_text=True)
        return self.tweeter_obj.tweet(articles_list=articles, **kwargs)

    ###############################
    # Public Methods - API Methods
    ###############################

    @property
    def topic(self) -> str:
        """Returns the topic to search for news articles

        Returns
        -------
        str
            The topic to search for news articles

        Examples
        --------
        >>> from twitternewsbot.twitternewsbot import TwitterNewsBot
        >>> from twitternewsbot.newsfinder import NewsFinder
        >>> from twitternewsbot.tweeter import Tweeter
        >>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
        >>> bot.topic
        "Python"
        """
        return self.__topic

    @topic.setter
    def topic(self, topic: str) -> None:
        """Sets the topic to search for news articles

        Parameters
        ----------
        topic : str
            The topic to search for news articles

        Raises
        ------
        TypeError
            If topic is not a string

        Examples
        --------
        >>> from twitternewsbot.twitternewsbot import TwitterNewsBot
        >>> from twitternewsbot.newsfinder import NewsFinder
        >>> from twitternewsbot.tweeter import Tweeter
        >>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
        >>> bot.topic = "HTML"
        """
        # Check if topic is a string
        if not isinstance(topic, str):
            raise TypeError("topic must be a string")

        self.__topic = topic
        return self.__topic

    @property
    def no_of_articles(self) -> int:
        """Returns the number of articles to find and scrape

        Returns
        -------
        int
            The number of articles to find and scrape

        Examples
        --------
        >>> from twitternewsbot.twitternewsbot import TwitterNewsBot
        >>> from twitternewsbot.newsfinder import NewsFinder
        >>> from twitternewsbot.tweeter import Tweeter
        >>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
        >>> bot.no_of_articles
        5
        """
        return self.__no_of_articles

    @no_of_articles.setter
    def no_of_articles(self, no_of_articles: int) -> None:
        """Sets the number of articles to find and scrape

        Parameters
        ----------
        no_of_articles : int
            The number of articles to find and scrape

        Returns
        -------
        None

        Raises
        ------
        TypeError
            If no_of_articles is not an integer

        Examples
        --------
        >>> from twitternewsbot.twitternewsbot import TwitterNewsBot
        >>> from twitternewsbot.newsfinder import NewsFinder
        >>> from twitternewsbot.tweeter import Tweeter
        >>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
        >>> bot.no_of_articles = 10
        """
        # Check if no_of_articles is an integer
        if not isinstance(no_of_articles, int):
            raise TypeError("no_of_articles must be an integer")

        self.__no_of_articles = no_of_articles

    def run(self, **kwargs) -> dict:
        """
        Build article list, scrape articles and tweet summarized tweet for the given topic.

        Parameters
        ----------
        **kwargs : dict
            Arguments for Tweeter.tweet function excluding articles_list. See Tweeter.tweet for more details on the args.

        Returns
        -------
        dict
            A dictionary containing the total character count, the number of tweets posted, and the id of the parent tweet when run

        Examples
        --------

        Creating a basic pipeline to find, scrape and tweet news articles:

        >>> from twitternewsbot.twitternewsbot import TwitterNewsBot
        >>> from twitternewsbot.newsfinder import NewsFinder
        >>> from twitternewsbot.tweeter import Tweeter
        >>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
        >>> bot.run()
        """

        # Run the pipeline
        return self.__build_pipeline(**kwargs)

topic property writable 

topic: str

Returns the topic to search for news articles

RETURNS DESCRIPTION
str

The topic to search for news articles

Examples:

>>> from twitternewsbot.twitternewsbot import TwitterNewsBot
>>> from twitternewsbot.newsfinder import NewsFinder
>>> from twitternewsbot.tweeter import Tweeter
>>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
>>> bot.topic
"Python"

no_of_articles property writable 

no_of_articles: int

Returns the number of articles to find and scrape

RETURNS DESCRIPTION
int

The number of articles to find and scrape

Examples:

>>> from twitternewsbot.twitternewsbot import TwitterNewsBot
>>> from twitternewsbot.newsfinder import NewsFinder
>>> from twitternewsbot.tweeter import Tweeter
>>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
>>> bot.no_of_articles
5

run 

run(**kwargs)

Build article list, scrape articles and tweet summarized tweet for the given topic.

PARAMETER DESCRIPTION
**kwargs

Arguments for Tweeter.tweet function excluding articles_list. See Tweeter.tweet for more details on the args.

TYPE: dict DEFAULT: {}

RETURNS DESCRIPTION
dict

A dictionary containing the total character count, the number of tweets posted, and the id of the parent tweet when run

Examples:

Creating a basic pipeline to find, scrape and tweet news articles:

>>> from twitternewsbot.twitternewsbot import TwitterNewsBot
>>> from twitternewsbot.newsfinder import NewsFinder
>>> from twitternewsbot.tweeter import Tweeter
>>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
>>> bot.run()
Source code in twitternewsbot/twitternewsbot.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
def run(self, **kwargs) -> dict:
    """
    Build article list, scrape articles and tweet summarized tweet for the given topic.

    Parameters
    ----------
    **kwargs : dict
        Arguments for Tweeter.tweet function excluding articles_list. See Tweeter.tweet for more details on the args.

    Returns
    -------
    dict
        A dictionary containing the total character count, the number of tweets posted, and the id of the parent tweet when run

    Examples
    --------

    Creating a basic pipeline to find, scrape and tweet news articles:

    >>> from twitternewsbot.twitternewsbot import TwitterNewsBot
    >>> from twitternewsbot.newsfinder import NewsFinder
    >>> from twitternewsbot.tweeter import Tweeter
    >>> bot = TwitterNewsBot(NewsFinder(), Tweeter(), "Python")
    >>> bot.run()
    """

    # Run the pipeline
    return self.__build_pipeline(**kwargs)