Dump the full documentation into the README and markdownify it.

[z_archive/twitter.git] / twitter / api.py

diff --git a/twitter/api.py b/twitter/api.py
index 2a9f93556cd0bf60c87597752d5fb74547854b04..7611ebb9c82eeaa8159aad228431d9900360e8a0 100644 (file)
--- a/twitter/api.py
+++ b/twitter/api.py
@@ -188,43 +188,43 @@ class Twitter(TwitterCall):
     Get RESTful data by accessing members of this class. The result
     is decoded python objects (lists and dicts).
 
-    The Twitter API is documented here:
+    The Twitter API is documented at:
 
       http://dev.twitter.com/doc
 
 
     Examples::
 
-      twitter = Twitter(
-          auth=OAuth(token, token_key, con_secret, con_secret_key)))
+        twitter = Twitter(
+            auth=OAuth(token, token_key, con_secret, con_secret_key)))
 
-      # Get the public timeline
-      twitter.statuses.public_timeline()
+        # Get the public timeline
+        twitter.statuses.public_timeline()
 
-      # Get a particular friend's timeline
-      twitter.statuses.friends_timeline(id="billybob")
+        # Get a particular friend's timeline
+        twitter.statuses.friends_timeline(id="billybob")
 
-      # Also supported (but totally weird)
-      twitter.statuses.friends_timeline.billybob()
+        # Also supported (but totally weird)
+        twitter.statuses.friends_timeline.billybob()
 
-      # Send a direct message
-      twitter.direct_messages.new(
-          user="billybob",
-          text="I think yer swell!")
+        # Send a direct message
+        twitter.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 a particular list of a particular friend
+        twitter.user.listname.members(user="billybob", listname="billysbuds")
 
 
     Searching Twitter::
 
-      twitter_search = Twitter(domain="search.twitter.com")
+        twitter_search = Twitter(domain="search.twitter.com")
 
-      # Find the latest search trends
-      twitter_search.trends()
+        # Find the latest search trends
+        twitter_search.trends()
 
-      # Search for the latest News on #gaza
-      twitter_search.search(q="#gaza")
+        # Search for the latest News on #gaza
+        twitter_search.search(q="#gaza")
 
 
     Using the data returned
@@ -233,13 +233,13 @@ class Twitter(TwitterCall):
     Twitter API calls return decoded JSON. This is converted into
     a bunch of Python lists, dicts, ints, and strings. For example::
 
-      x = twitter.statuses.public_timeline()
+        x = twitter.statuses.public_timeline()
 
-      # The first 'tweet' in the timeline
-      x[0]
+        # The first 'tweet' in the timeline
+        x[0]
 
-      # The screen name of the user who wrote the first 'tweet'
-      x[0]['user']['screen_name']
+        # The screen name of the user who wrote the first 'tweet'
+        x[0]['user']['screen_name']
 
 
     Getting raw XML data
@@ -248,10 +248,10 @@ class Twitter(TwitterCall):
     If you prefer to get your Twitter data in XML format, pass
     format="xml" to the Twitter object when you instantiate it::
 
-      twitter = Twitter(format="xml")
+        twitter = Twitter(format="xml")
 
-      The output will not be parsed in any way. It will be a raw string
-      of XML.
+    The output will not be parsed in any way. It will be a raw string
+    of XML.
 
     """
     def __init__(