Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

Download
ActivePython
INSTALL>
pypm install ecl-twitter

How to install ecl_twitter

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install ecl-twitter
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
1.2.0
1.2.2Never BuiltWhy not?
1.2.0 Available View build log
Windows (64-bit)
1.2.0
1.2.2Never BuiltWhy not?
1.2.0 Available View build log
Mac OS X (10.5+)
1.2.1
1.2.2Never BuiltWhy not?
1.2.1 Available View build log
1.2.0 Available View build log
Linux (32-bit)
1.2.1
1.2.2Never BuiltWhy not?
1.2.1 Available View build log
1.2.0 Available View build log
Linux (64-bit)
1.2.1
1.2.2 Failed View build log
1.2.1 Available View build log
1.2.0 Available View build log
 
License
Apache 2.0
Dependencies
Imports
Lastest release
version 1.2.2 on Jan 9th, 2014

ECL Twitter

ECL Twitter is an awesome Twitter library for Python 2.7+. It makes the Twitter API a joy to use, and Django integration is baked in. To find out more, read on!

If you have an issue to report or a feature request, add it to our issue tracker.

Installation

ECL Twitter is on PyPi, so we recommend installing via pip:

$ pip install ecl-twitter
Configuration

If you'd like to use ECL Twitter for a stand alone application (e.g., in a script you're writing to download your tweets), you'll need to set the environment variables TWITTER_KEY, TWITTER_SECRET, and TWITTER_REDIRECT_URL with the values appropriate for your Twitter application.:

export TWITTER_KEY="Gmxb5Rh7gpOpzunQ7SQcOA"
export TWITTER_SECRET="irhZg1W5NO2r7M9IRwhjHKpzKPjJ3HXc6RYCbrM0"
export TWITTER_REDIRECT_URL="http://example.com/oauth/complete"

If you're only interested in integration with Django, read django.

Authentication

We've made authentication very simple. Probably too simple, to be honest.:

>>> from ecl_twitter import Twitter
>>> twitter = Twitter()
>>> url, token, secret = twitter.generate_authorization()
>>> url
https://api.twitter.com/oauth/authorize?oauth_token=XXX

After opening this URL in your browser and allowing the application, you'll be redirected to a page with a PIN. This is your verifier.:

>>> twitter = Twitter(token, secret)
>>> data = twitter.oauth.access_token(oauth_verifier=verifier)
>>> data
<Objectifier#dict oauth_token_secret=unicode user_id=unicode oauth_token=unicode screen_name=unicode>

Congratulations, you have successfully authenticated with Twitter (told you it was easy). data is an Objectifier object which should contain your token, secret, user id, and screen name.

To call the API, use your newly-acquired access token and access token secret:

>>> twitter = Twitter(data.oauth_token, data.oauth_token_secret)
>>> tweets = twitter.statuses.user_timeline()
>>> tweets
<Objectifier#list elements:20>

So, yeah. That's it. Be fruitful and multiply.

Integrating with Django

What we did above is easy. For Django projects, we've made it even easier. In your views file:

from django.contrib.auth import authenticate, login
from django.http import HttpResponseRedirect

from ecl_twitter import twitter_begin, twitter_callback

from .models import User

# ...

@twitter_begin
def oauth_twitter_begin(request):
    pass

@twitter_callback
def oauth_twitter_complete(request, data):
    user, _ = User.objects.get_or_create(screen_name=data.screen_name, defaults={
        'access_token': data.oauth_token,
        'access_token_secret': data.oauth_token_secret })
    user = authenticate(id=user.id)
    login(request, user)
    return HttpResponseRedirect(reverse('home'))

Add these values to your settings.:

# The User model that you'll be using to authenticate with Twitter.
PRIMARY_USER_MODEL = "app.User"

AUTHENTICATION_BACKENDS = (
    # ...
    'ecl_twitter.backends.TwitterAuthBackend',
)

TWITTER_KEY = "Gmxb5Rh7gpOpzunQ7SQcOA"
TWITTER_SECRET = "irhZg1W5NO2r7M9IRwhjHKpzKPjJ3HXc6RYCbrM0"
TWITTER_REDIRECT_URL = "http://example.com/oauth/complete"

Then map the above views in your urls.py:

# ...

urlpatterns = patterns('app.views',
    # ...
    url(r'^oauth/twitter/begin$', 'oauth_twitter_begin'),
    url(r'^oauth/twitter/complete$', 'oauth_twitter_complete'),
)

You're done. Oh, you might also want to add some fields for storing the Twitter-related fields in your user model.

Contributing, feedback, and questions

Indices and tables

  • genindex
  • modindex
  • search

Subscribe to package updates

Last updated Jan 9th, 2014

Download Stats

Last month:2

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.