]>
jfr.im git - z_archive/twitter.git/blob - twitter/oauth.py
2 Visit the Twitter developer page and create a new application:
4 https://dev.twitter.com/apps/new
6 This will get you a CONSUMER_KEY and CONSUMER_SECRET.
8 When users run your application they have to authenticate your app
9 with their Twitter account. A few HTTP calls to twitter are required
10 to do this. Please see the twitter.oauth_dance module to see how this
11 is done. If you are making a command-line app, you can use the
12 oauth_dance() function directly.
14 Performing the "oauth dance" gets you an ouath token and oauth secret
15 that authenticate the user with Twitter. You should save these for
16 later so that the user doesn't have to do the oauth dance again.
18 read_token_file and write_token_file are utility methods to read and
19 write OAuth token and secret key values. The values are stored as
20 strings in the file. Not terribly exciting.
22 Finally, you can use the OAuth authenticator to connect to Twitter. In
23 code it all goes like this::
25 MY_TWITTER_CREDS = os.path.expanduser('~/.my_app_credentials')
26 if not os.path.exists(MY_TWITTER_CREDS):
27 oauth_dance("My App Name", CONSUMER_KEY, CONSUMER_SECRET,
30 oauth_token, oauth_secret = read_token_file(MY_TWITTER_CREDS)
32 twitter = Twitter(auth=OAuth(
33 oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET))
35 # Now work with Twitter
36 twitter.statuses.update(status='Hello, world!')
40 from __future__
import print_function
43 from random
import getrandbits
46 import urllib
.parse
as urllib_parse
47 from urllib
.parse
import urlencode
50 import urllib2
as urllib_parse
51 from urllib
import urlencode
58 from .auth
import Auth
61 def write_token_file(filename
, oauth_token
, oauth_token_secret
):
63 Write a token file to hold the oauth token and oauth token secret.
65 oauth_file
= open(filename
, 'w')
66 print(oauth_token
, file=oauth_file
)
67 print(oauth_token_secret
, file=oauth_file
)
70 def read_token_file(filename
):
72 Read a token file and return the oauth token and oauth token secret.
75 return f
.readline().strip(), f
.readline().strip()
80 An OAuth authenticator.
82 def __init__(self
, token
, token_secret
, consumer_key
, consumer_secret
):
84 Create the authenticator. If you are in the initial stages of
85 the OAuth dance and don't yet have a token or token_secret,
86 pass empty strings for these params.
89 self
.token_secret
= token_secret
90 self
.consumer_key
= consumer_key
91 self
.consumer_secret
= consumer_secret
93 def encode_params(self
, base_url
, method
, params
):
94 params
= params
.copy()
97 params
['oauth_token'] = self
.token
99 params
['oauth_consumer_key'] = self
.consumer_key
100 params
['oauth_signature_method'] = 'HMAC-SHA1'
101 params
['oauth_version'] = '1.0'
102 params
['oauth_timestamp'] = str(int(time()))
103 params
['oauth_nonce'] = str(getrandbits(64))
105 enc_params
= urlencode_noplus(sorted(params
.items()))
107 key
= self
.consumer_secret
+ "&" + urllib_parse
.quote(self
.token_secret
, safe
='~')
110 urllib_parse
.quote(i
, safe
='~') for i
in [method
.upper(), base_url
, enc_params
])
112 signature
= (base64
.b64encode(hmac
.new(
113 key
.encode('ascii'), message
.encode('ascii'), hashlib
.sha1
)
115 return enc_params
+ "&" + "oauth_signature=" + urllib_parse
.quote(signature
, safe
='~')
117 def generate_headers(self
):
120 # apparently contrary to the HTTP RFCs, spaces in arguments must be encoded as
121 # %20 rather than '+' when constructing an OAuth signature (and therefore
122 # also in the request itself.)
123 # So here is a specialized version which does exactly that.
124 def urlencode_noplus(query
):
128 if type(k
) is unicode: k
= k
.encode('utf-8')
129 if type(v
) is unicode: v
= v
.encode('utf-8')
130 new_query
.append((k
, v
))
132 return urlencode(query
).replace("+", "%20")
134 return urlencode(query
, safe
='~').replace("+", "%20")