code/twython
1
0
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

Merge pull request #241 from ryanmcgrath/dev/cursor

Browse source 
WIP: General cursor (generator) like object for Twython functions, fixes #238
This commit is contained in:
Mike Helmick 2013-07-20 12:01:29 -07:00
commit 52e025a6a2
8 changed files with 181 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/index.rst
View file

@ -29,14 +29,38 @@ Features
Usage
-----
..
I know it isn't necessary to start a new tree for every section,
but I think it looks a bit cleaner that way!
.. toctree::
:maxdepth: 4
usage/install
.. toctree::
:maxdepth: 4
usage/starting_out
.. toctree::
:maxdepth: 4
usage/basic_usage
.. toctree::
:maxdepth: 4
usage/advanced_usage
.. toctree::
:maxdepth: 4
usage/streaming_api
.. toctree::
:maxdepth: 2
usage/special_functions
Twython API Documentation

43
docs/usage/special_functions.rst
View file

@ -7,6 +7,49 @@ This section covers methods to are part of Twython but not necessarily connected
*******************************************************************************
Cursor
------
This function returns a generator for Twitter API endpoints that are able to be pagintated in some way (either by cursor or since_id parameter)
The Old Way
^^^^^^^^^^^
.. code-block:: python
from twython import Twython
twitter = Twython(APP_KEY, APP_SECRET,
OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
results = twitter.search(q='twitter')
if results.get('statuses'):
for result in results['statuses']:
print result['id_str']
The New Way
^^^^^^^^^^^
.. code-block:: python
from twython import Twython
twitter = Twython(APP_KEY, APP_SECRET,
OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
results = twitter.cursor(t.search, q='twitter')
for result in results:
print result['id_str']
Another example:
.. code-block:: python
results = twitter.cursor(t.get_mentions_timeline)
for result in results:
print result['id_str']
HTML for Tweet
--------------