X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/51e0b8f18c733f6095d76c39ba80e8886f8235a7..faf29edeae327eed4cedd42a78249443d955af5f:/README diff --git a/README b/README index a54c88b..4ce2d1b 100644 --- a/README +++ b/README @@ -14,23 +14,17 @@ For more information, after installing the `twitter` package: * import the `twitter` package and run help() on it * run `twitter -h` for command-line tool help - * run `twitterbot -h` for IRC bot help - * visit http://mike.verdone.ca/twitter for more info - twitter - The Command-Line Tool ------------------------------- -The command-line tool currently supports the following things: +The command-line tool lets you do some awesome things: - * view your friends' recent tweets - * view your recent replies + * view your tweets, recent replies, and tweets in lists * view the public timeline * follow and unfollow (leave) friends - * view tweets from lists * various output formats for tweet information - * read your username and password from a config file The bottom line: type `twitter`, receive tweets. @@ -53,6 +47,13 @@ tweets from a given user in a simple text format. It is useful to get a complete offsite backup of all your tweets. Run `twitter-log` and read the instructions. +twitter-archiver and twitter-follow +----------------------------------- + +twitter-archiver will log all the tweets posted by any user since they +started posting. twitter-follow will print a list of all of all the +followers of a user (or all the users that user follows). + Programming with the Twitter api classes ======================================== @@ -76,30 +77,50 @@ The Twitter API is documented at: Examples:: + + from twitter import * - twitter = Twitter( - auth=OAuth(token, token_key, con_secret, con_secret_key))) + # see "Authentication" section below for tokens and keys + t = Twitter( + auth=OAuth(OAUTH_TOKEN, OAUTH_SECRET, + CONSUMER_KEY, CONSUMER_SECRET) + ) # Get the public timeline - twitter.statuses.public_timeline() + t.statuses.public_timeline() # Get a particular friend's timeline - twitter.statuses.friends_timeline(id="billybob") + t.statuses.friends_timeline(id="billybob") # Also supported (but totally weird) - twitter.statuses.friends_timeline.billybob() + t.statuses.friends_timeline.billybob() + + # Update your status + t.statuses.update( + status="Using @sixohsix's sweet Python Twitter Tools.") # Send a direct message - twitter.direct_messages.new( + t.direct_messages.new( user="billybob", text="I think yer swell!") - # Get the members of a particular list of a particular friend - twitter.user.listname.members(user="billybob", listname="billysbuds") + # Get the members of tamtar's list "Things That Are Rad" + t._("tamtar")._("things-that-are-rad").members() + + # Note how the magic `_` method can be used to insert data + # into the middle of a call. You can also use replacement: + t.user.list.members(user="tamtar", list="things-that-are-rad") + + # An *optional* `_timeout` parameter can also be used for API + # calls which take much more time than normal or twitter stops + # responding for some reasone + t.users.lookup(screen_name=','.join(A_LIST_OF_100_SCREEN_NAMES), _timeout=1) Searching Twitter:: + from twitter import * + twitter_search = Twitter(domain="search.twitter.com") # Find the latest search trends @@ -204,6 +225,8 @@ strings in the file. Not terribly exciting. Finally, you can use the OAuth authenticator to connect to Twitter. In code it all goes like this:: + from twitter import * + MY_TWITTER_CREDS = os.path.expanduser('~/.my_app_credentials') if not os.path.exists(MY_TWITTER_CREDS): oauth_dance("My App Name", CONSUMER_KEY, CONSUMER_SECRET, @@ -212,7 +235,7 @@ code it all goes like this:: oauth_token, oauth_secret = read_token_file(MY_TWITTER_CREDS) twitter = Twitter(auth=OAuth( - oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET)) + oauth_token, oauth_secret, CONSUMER_KEY, CONSUMER_SECRET)) # Now work with Twitter twitter.statuses.update('Hello, world!')