Metadata-Version: 2.1
Name: tweetlib
Version: 0.0.2
Summary: A python twitter scraper with no-api keys required.
Home-page: https://github.com/wyattferguson/tweetlib
Author: Wyatt Ferguson
Author-email: wyattf@gmail.com
License: UNKNOWN
Description: # Twitter Scraper
        A python twitter scraper with no-api keys required. This is a refactoring and rewrite Jefferson Henrique's library [GetOldTweets-python](https://github.com/Jefferson-Henrique/GetOldTweets-python)
        
        ## Installation 
            pip3 install tweetlib
        
        
        ## What can it do?
        All these functions can be used in combination with one another. Alternatively you can pass the variables in when you create an new instance of the library.
        
        
        - set_username(str): any valid twitter name you want to scrape
        - set_since("yyyy-mm-dd"): A lower bound date to restrict search.
        - set_until("yyyy-mm-dd"):An upper bound date to restrict search.
        - set_query_search(str): Search string
        - set_top_tweets(bool): Return top tweets
        - set_max_tweets(int): Max number of tweets you want to scrape.
        
        
        ## Tweet Object
        The tweet objects it returns in the list contain the following:
        
            tweet = {
                id (str)
                permalink (str)
                username (str)
                text (str)
                date (date)
                replies (int)
                retweets (int)
                favorites (int)
                mentions (str)
                hashtags (str)
            }
        
        
        ## Examples
        
        ``` python
            import tweetlib
            # Get tweets by username
            ts = tweetlib.TweetLib(username="barackobama")
            tweets = ts.get_tweets()
        
            # or you can use the set method instead
            ts = tweetlib.TweetLib()
            ts.set_username("barackobama")
            tweets = ts.get_tweets()
        
            # Search for tweets
            ts = tweetlib.TweetLib()
            ts.set_query_search("college")
            ts.set_max_tweets(100)
            tweets = ts.get_tweets()
        ```    
        
        
        ## Credit and Contact
        
        Created by Wyatt Ferguson 
        
        For any comments or questions your can reach me on Twitter [@wyattferguson](https://twitter.com/wyattferguson) or visit my little portfolio at [wyattf.dev](https://wyattf.dev)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
