Metadata-Version: 1.1
Name: TwitterSearch
Version: 0.65
Summary: A library to easily iterate tweets found by the Twitter Search API
Home-page: http://github.com/ckoepp/TwitterSearch
Author: Christian Koepp
Author-email: christian.koepp@tum.de
License: MIT
Description: # TwitterSearch
        This library allows you easily create a search through the Twitter Search API without having to know too much about the API details. Based on such a search you can even iterate throughout all tweets reachable via the Twitter Search API. There is an automatic reload of the next pages while using the iteration.
        
        ## Reasons to use TwitterSearch
        Well, because it can be quite annoying to always parse the search url together and a minor spelling mistake is sometimes hard to find. Not to mention the pain of getting the next page of the results. Why not centralize this process and concentrate on the more important parts of the project?
        
        More than that, TwitterSearch is:
         * pretty small (around 300 lines of code currently)
         * pretty easy to use, even for beginners
         * pretty good at giving you ALL available information (including meta information)
         * pretty iterable without any need to manually reload more results from the API
         * pretty wrong values of API arguments are to raise an exception. This is done before the API gets queried and therefore helps to avoid to reach Twitters' limitations by obviously wrong API calls
         * pretty pretty to look at :)
        
        ## Example
        The library is still in an early stage. However, if you would like to use it we prepared a small example about how to play around. 
        
        Everybody knows how much work it is to study at a university. So why not take a small shortcut? So in this example we assume we would like to find out how to copy a doctorate thesis in Germany. Let's have a look what the Twitter users have to say about [Mr Guttenberg](http://www.bbc.co.uk/news/world-europe-12608083).
        
        ```python
        from TwitterSearch import *
        try:
            tso = TwitterSearchOrder() # create a TwitterSearchOrder object
            tso.setKeywords(['Guttenberg', 'Doktorarbeit']) # let's define all words we would like to have a look for
            tso.setLanguage('de') # we want to see German tweets only
            tso.setCount(7) # please dear Mr Twitter, only give us 7 results per page
            tso.setIncludeEntities(False) # and don't give us all those entity information
        
            # it's about time to create a TwitterSearch object with our secret tokens
            ts = TwitterSearch(
                consumer_key = 'aaabbb',
                consumer_secret = 'cccddd',
                access_token = '111222',
                access_token_secret = '333444'
             )
        
            for tweet in ts.searchTweetsIterable(tso): # this is where the fun actually starts :)
                print '@%s tweeted: %s' % (tweet['user']['screen_name'], tweet['text'])
        
        except TwitterSearchException, e: # take care of all those ugly errors if there are some
            print e
        ```
        The result will be a text looking similar to this one. But as you see unfortunately there is no idea hidden in the tweets how to get your doctorate thesis without any work. Damn it!
        ```
        @enricozero tweeted: RT @viehdeo: Archiv: Comedy-Video: Oliver Welke parodiert “Mogelbaron” Dr. Guttenbergs Doktorarbeit (Schummel-cum-laude Pla... http://t. ...
        @schlagworte tweeted: "Erst letztens habe ich in meiner Doktorarbeit Guttenberg zitiert." Blockflöte des Todes: http://t.co/pCzIn429
        @nkoni7 tweeted: Familien sind auch betroffen wenn schlechte Politik gemacht wird. Nicht nur wenn Guttenberg seine Doktorarbeit fälscht ! #absolutemehrheit
        ```
        
        ##Wanna have more details?
        If you'd like to get more information about how TwitterSearch works interally and how to use it with all it's possibilities have a look at the [Wiki](https://github.com/ckoepp/TwitterSearch/wiki).
        
Keywords: twitter api search
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries
