Twython: A Pure Python Wrapper for the Twitter API

Summary

Twython is an actively maintained, pure Python library designed to simplify interaction with the Twitter API. It provides comprehensive support for both normal and streaming Twitter APIs, making it easy to query user data, timelines, direct messages, and handle image uploads. This battle-tested wrapper is a robust solution for integrating Twitter functionalities into Python applications.

Use at your own risk

OSRepos shares public repositories for knowledge and discovery only. Any installation, execution, configuration, or use of code from these repositories is the user's own responsibility. Always review the repository, source code, dependencies, licenses, and security implications before running or installing anything. OSRepos is not responsible for issues, damages, or losses resulting from third-party repositories.

Introduction

Twython is an actively maintained, pure Python wrapper for the Twitter API. It simplifies interaction with Twitter's extensive API, supporting both normal and streaming functionalities. This library is battle-tested by companies, educational institutions, and individuals, providing a robust solution for integrating Twitter features into your Python applications.

Key features include querying user information, Twitter lists, timelines, and direct messages. It also supports image uploading for various purposes, OAuth 2 Application Only (read-only) authentication, and seamless Python 3 compatibility. The project is currently seeking new maintainers, offering a valuable opportunity to contribute to a widely used open-source project.

Installation

Installing Twython is straightforward using pip:

pip install twython

For legacy projects requiring Python 2.7 support, you can install the last compatible version:

pip install twython==3.7.0

Alternatively, to install directly from the GitHub repository:

git clone git://github.com/ryanmcgrath/twython.git
cd twython
python setup.py install

Examples

To get started, you'll need to register an application on the Twitter Developer Platform to obtain your Consumer Key and Consumer Secret.

First, import Twython:

from twython import Twython

APP_KEY = 'YOUR_APP_KEY'
APP_SECRET = 'YOUR_APP_SECRET'
OAUTH_TOKEN = 'YOUR_OAUTH_TOKEN'
OAUTH_TOKEN_SECRET = 'YOUR_OAUTH_TOKEN_SECRET'

twitter = Twython(APP_KEY, APP_SECRET, OAUTH_TOKEN, OAUTH_TOKEN_SECRET)

Fetching the Authenticated User's Home Timeline:

timeline = twitter.get_home_timeline()
for tweet in timeline:
    print(f"{tweet['user']['screen_name']}: {tweet['text']}")

Updating User Status:

twitter.update_status(status='See how easy using Twython is!')

For detailed authentication flows, including OAuth 1 and OAuth 2, refer to the official documentation.

Why Use Twython?

Twython stands out as a reliable choice for Twitter API integration due to several factors:

Pure Python: Built entirely in Python, ensuring compatibility and ease of use within the Python ecosystem.
Active Maintenance: The project is actively maintained, ensuring it keeps up with Twitter API changes and Python advancements.
Comprehensive API Coverage: It supports a wide range of Twitter API endpoints, including the Streaming API, allowing for diverse application functionalities.
Flexibility: Dynamic function arguments map directly to Twitter API parameters, providing flexibility without waiting for library updates.
Battle-Tested: Proven in various real-world scenarios by a diverse user base.