TwitterSearch

TwitterSearch was developed as part of a project about social media at the Carl von Linde-Akademie which is part of the Technische Universität München. Thus, it is a data collecting toolkit and not implementing the whole Twitter API but the Search API and the User Timeline API.

The library is fully accessible through the official repository at github and maintained by Christian Koepp.

It’s using the REST API in version 1.1 only. In its recent version it directly uses IDs of tweets to navigate throughout the available tweets instead of pages, which is way more comfortable to use and more convenient for really getting all possible tweets. Also, TwitterSearch is build to be highly flexible in its usage making it usable even within exotic use-cases. Details about non-default use-cases can be found in the Advanced usage sections within the class articles.

All classes and functionality is tested against the latest Python 2 and Python 3 versions automatically. The current state of all branches is visible through Travis CI. Additionally, you should note that with version 1.0 and upwards PEP-8 compatibility is enforced. Checks are done by running the pep8 toolkit.

The history of changes can be either accessed by using the official github repository or by looking at summary outlined as in the CHANGELOG.rst file within the package.

Warning

If you’re upgrading from a version < 1.0.0 be aware that the API changed! To support PEP-8 completely, former methods named someMethod() are now accessible as some_method(). Apart from this issue, four other API changes were introduced with version 1.0.0:

• simplified proxy functionality (no usage of dicts but plain strings as only HTTPS proxies can be supported)
• simplified geo-code parameter (TwitterSearchOrder.set_geocode(...,metric=True) renamed to set_geocode(...,imperial_metric=True))
• simplified TwitterSearch.get_statistics() from dict to tuple style ({'queries':<int>, 'tweets':<int>} to (<int>,<int>))
• additional feature: timelines of users can now be accessed using the new class TwitterUserOrder

In total those changes can be done quickly without browsing this documentation. If you are not able to do those changes just keep using the versions < 1.0.0. Those will stay available through pypi and therefore will be installable in the future using the common installation methods.

Table of contents

• Basic usage
  • Accessible information
  • Architecture
• TwitterSearch
  • TwitterSearch package
• Advanced usage: The TwitterSearch class
  • Constructor of TwitterSearch
  • Authentication and verification
  • Proxy usage
  • Returned tweets
  • Access meta data
  • TwitterSearch without automatic iteration
  • On-the-fly loading of supported languages
• Advanced usage: The TwitterSearchException class
  • List of exceptions
  • Advanced exception usage
• Advanced usage: The TwitterSearchOrder class
  • Advanced usage examples
• Advanced usage: The TwitterUserOrder class
  • Advanced usage examples

Indices and tables

• Index
• Module Index
• Search Page

Contribution

Feel free to open issues, submit code or fork.