diff --git a/MANIFEST.in b/MANIFEST.in index 0878b48..948c10c 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include LICENSE README.markdown README.txt +include LICENSE README.markdown README.rst recursive-include examples * recursive-exclude examples *.pyc diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..9753f59 --- /dev/null +++ b/README.rst @@ -0,0 +1,196 @@ +Twython +======= + +``Twython`` is library providing an easy (and up-to-date) way to access Twitter data in Python + +Features +-------- + +* Query data for: + - User information + - Twitter lists + - Timelines + - User avatar URL + - and anything found in `the docs `_ +* Image Uploading! + - **Update user status with an image** + - Change user avatar + - Change user background image + +Installation +------------ +:: + + pip install twython + +...or, you can clone the repo and install it the old fashioned way. + +:: + + git clone git://github.com/ryanmcgrath/twython.git + cd twython + sudo python setup.py install + + +Usage +----- + +Authorization URL +~~~~~~~~~~~~~~~~~ +:: + + t = Twython(app_key=app_key, + app_secret=app_secret, + callback_url='http://google.com/') + + auth_props = t.get_authentication_tokens() + + oauth_token = auth_props['oauth_token'] + oauth_token_secret = auth_props['oauth_token_secret'] + + print 'Connect to Twitter via: %s' % auth_props['auth_url'] + +Be sure you have a URL set up to handle the callback after the user has allowed your app to access their data, the callback can be used for storing their final OAuth Token and OAuth Token Secret in a database for use at a later date. + +Handling the callback +~~~~~~~~~~~~~~~~~~~~~ +:: + + ''' + oauth_token and oauth_token_secret come from the previous step + if needed, store those in a session variable or something + ''' + + t = Twython(app_key=app_key, + app_secret=app_secret, + oauth_token=oauth_token, + oauth_token_secret=oauth_token_secret) + + auth_tokens = t.get_authorized_tokens() + print auth_tokens + +*Function definitions (i.e. getHomeTimeline()) can be found by reading over twython/twitter_endpoints.py* + +Getting a user home timeline +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + ''' + oauth_token and oauth_token_secret are the final tokens produced + from the `Handling the callback` step + ''' + + t = Twython(app_key=app_key, + app_secret=app_secret, + oauth_token=oauth_token, + oauth_token_secret=oauth_token_secret) + + # Returns an dict of the user home timeline + print t.getHomeTimeline() + +Get a user avatar url (no authentication needed) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + t = Twython() + print t.getProfileImageUrl('ryanmcgrath', size='bigger') + print t.getProfileImageUrl('mikehelmick') + +Search Twitter (no authentication needed) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + t = Twython() + print t.search(q='python') + +Streaming API +~~~~~~~~~~~~~ +*Usage is as follows; it's designed to be open-ended enough that you can adapt it to higher-level (read: Twitter must give you access) +streams.* + +:: + + def on_results(results): + """A callback to handle passed results. Wheeee. + """ + + print results + + Twython.stream({ + 'username': 'your_username', + 'password': 'your_password', + 'track': 'python' + }, on_results) + + +Notes +----- +As of Twython 2.0.0, we have changed routes for functions to abide by the `Twitter Spring 2012 clean up `_ Please make changes to your code accordingly. + + +A note about the development of Twython (specifically, 1.3) +----------------------------------------------------------- +As of version 1.3, Twython has been extensively overhauled. Most API endpoint definitions are stored +in a separate Python file, and the class itself catches calls to methods that match up in said table. + +Certain functions require a bit more legwork, and get to stay in the main file, but for the most part +it's all abstracted out. + +As of Twython 1.3, the syntax has changed a bit as well. Instead of Twython.core, there's a main +Twython class to import and use. If you need to catch exceptions, import those from twython as well. + +Arguments to functions are now exact keyword matches for the Twitter API documentation - that means that +whatever query parameter arguments you read on Twitter's documentation (http://dev.twitter.com/doc) gets mapped +as a named argument to any Twitter function. + +For example: the search API looks for arguments under the name "q", so you pass q="query_here" to search(). + +Doing this allows us to be incredibly flexible in querying the Twitter API, so changes to the API aren't held up +from you using them by this library. + +Twython 3k +---------- +There's an experimental version of Twython that's made for Python 3k. This is currently not guaranteed to +work in all situations, but it's provided so that others can grab it and hack on it. +If you choose to try it out, be aware of this. + +**OAuth is now working thanks to updates from [Hades](https://github.com/hades). You'll need to grab +his [Python 3 branch for python-oauth2](https://github.com/hades/python-oauth2/tree/python3) to have it work, though.** + +Questions, Comments, etc? +------------------------- +My hope is that Twython is so simple that you'd never *have* to ask any questions, but if you feel the need to contact me for this (or other) reasons, you can hit me up at ryan@venodesigns.net. + +You can also follow me on Twitter - `@ryanmcgrath `_ + +*Twython is released under an MIT License - see the LICENSE file for more information.* + +Want to help? +------------- +Twython is useful, but ultimately only as useful as the people using it (say that ten times fast!). If you'd like to help, write example code, contribute patches, document things on the wiki, tweet about it. Your help is always appreciated! + + +Special Thanks to... +-------------------- +This is a list of all those who have contributed code to Twython in some way, shape, or form. I think it's +exhaustive, but I could be wrong - if you think your name should be here and it's not, please contact +me and let me know (or just issue a pull request on GitHub, and leave a note about it so I can just accept it ;)). + +- `Mike Helmick (michaelhelmick) `_, multiple fixes and proper ``requests`` integration. +- `kracekumar `_, early ``requests`` work and various fixes. +- `Erik Scheffers (eriks5) `_, various fixes regarding OAuth callback URLs. +- `Jordan Bouvier (jbouvier) `_, various fixes regarding OAuth callback URLs. +- `Dick Brouwer (dikbrouwer) `_, fixes for OAuth Verifier in ``get_authorized_tokens``. +- `hades `_, Fixes to various initial OAuth issues and updates to ``Twython3k`` to stay current. +- `Alex Sutton (alexdsutton) `_, fix for parameter substitution regular expression (catch underscores!). +- `Levgen Pyvovarov (bsn) `_, Various argument fixes, cyrillic text support. +- `Mark Liu (mliu7) `_, Missing parameter fix for ``addListMember``. +- `Randall Degges (rdegges) `_, PEP-8 fixes, MANIFEST.in, installer fixes. +- `Idris Mokhtarzada (idris) `_, Fixes for various example code pieces. +- `Jonathan Elsas (jelsas) `_, Fix for original Streaming API stub causing import errors. +- `LuqueDaniel `_, Extended example code where necessary. +- `Mesar Hameed (mhameed) `_, Commit to swap ``__getattr__`` trick for a more debuggable solution. +- `Remy DeCausemaker (decause) `_, PEP-8 contributions. +- `[mckellister](https://github.com/mckellister) `_, Fixes to ``Exception`` raised by Twython (Rate Limits, etc). +- `tatz_tsuchiya `_, Fix for ``lambda`` scoping in key injection phase. +- `Voulnet (Mohammed ALDOUB) `_, Fixes for ``http/https`` access endpoints diff --git a/README.txt b/README.txt deleted file mode 100644 index 6efbb77..0000000 --- a/README.txt +++ /dev/null @@ -1,136 +0,0 @@ -Twython - Easy Twitter utilities in Python -========================================================================================= -Ah, Twitter, your API used to be so awesome, before you went and implemented the crap known -as OAuth 1.0. However, since you decided to force your entire development community over a barrel -about it, I suppose Twython has to support this. So, that said... - -Does Twython handle OAuth? -========================================================================================================= -Yes, in a sense. There's a variety of builtin-methods that you can use to handle the authentication ritual. -There's an **[example Django application](https://github.com/ryanmcgrath/twython-django)** that showcases -this - feel free to peruse and use! - -Installation ------------------------------------------------------------------------------------------------------ -Installing Twython is fairly easy. You can... - - (pip install | easy_install) twython - -...or, you can clone the repo and install it the old fashioned way. - - git clone git://github.com/ryanmcgrath/twython.git - cd twython - sudo python setup.py install - -Please note: ------------------------------------------------------------------------------------------------------ -As of Twython 2.0.0, we have changed routes for functions to abide by the **[Twitter Spring 2012 clean up](https://dev.twitter.com/docs/deprecations/spring-2012)**. -Please make changes to your code accordingly. - -Example Use ------------------------------------------------------------------------------------------------------ -``` python -from twython import Twython - -twitter = Twython() -results = twitter.search(q = "bert") - -# More function definitions can be found by reading over twython/twitter_endpoints.py, as well -# as skimming the source file. Both are kept human-readable, and are pretty well documented or -# very self documenting. -``` - -Streaming API ----------------------------------------------------------------------------------------------------- -Twython, as of v1.5.0, now includes an experimental **[Twitter Streaming API](https://dev.twitter.com/docs/streaming-api)** handler. -Usage is as follows; it's designed to be open-ended enough that you can adapt it to higher-level (read: Twitter must give you access) -streams. This also exists in large part (read: pretty much in full) thanks to the excellent **[python-requests](http://docs.python-requests.org/en/latest/)** library by -Kenneth Reitz. - -``` python -import json -from twython import Twython - -def on_results(results): - """ - A callback to handle passed results. Wheeee. - """ - print json.dumps(results) - -Twython.stream({ - 'username': 'your_username', - 'password': 'your_password', - 'track': 'python' -}, on_results) -``` - -A note about the development of Twython (specifically, 1.3) ----------------------------------------------------------------------------------------------------- -As of version 1.3, Twython has been extensively overhauled. Most API endpoint definitions are stored -in a separate Python file, and the class itself catches calls to methods that match up in said table. - -Certain functions require a bit more legwork, and get to stay in the main file, but for the most part -it's all abstracted out. - -As of Twython 1.3, the syntax has changed a bit as well. Instead of Twython.core, there's a main -Twython class to import and use. If you need to catch exceptions, import those from twython as well. - -Arguments to functions are now exact keyword matches for the Twitter API documentation - that means that -whatever query parameter arguments you read on Twitter's documentation (http://dev.twitter.com/doc) gets mapped -as a named argument to any Twitter function. - -For example: the search API looks for arguments under the name "q", so you pass q="query_here" to search(). - -Doing this allows us to be incredibly flexible in querying the Twitter API, so changes to the API aren't held up -from you using them by this library. - -Twython 3k ------------------------------------------------------------------------------------------------------ -There's an experimental version of Twython that's made for Python 3k. This is currently not guaranteed to -work in all situations, but it's provided so that others can grab it and hack on it. -If you choose to try it out, be aware of this. - -**OAuth is now working thanks to updates from [Hades](https://github.com/hades). You'll need to grab -his [Python 3 branch for python-oauth2](https://github.com/hades/python-oauth2/tree/python3) to have it work, though.** - -Questions, Comments, etc? ------------------------------------------------------------------------------------------------------ -My hope is that Twython is so simple that you'd never *have* to ask any questions, but if -you feel the need to contact me for this (or other) reasons, you can hit me up -at ryan@venodesigns.net. - -You can also follow me on Twitter - **[@ryanmcgrath](http://twitter.com/ryanmcgrath)**. - -Twython is released under an MIT License - see the LICENSE file for more information. - -Want to help? ------------------------------------------------------------------------------------------------------ -Twython is useful, but ultimately only as useful as the people using it (say that ten times fast!). If you'd -like to help, write example code, contribute patches, document things on the wiki, tweet about it. Your help -is always appreciated! - - -Special Thanks to... ------------------------------------------------------------------------------------------------------ -This is a list of all those who have contributed code to Twython in some way, shape, or form. I think it's -exhaustive, but I could be wrong - if you think your name should be here and it's not, please contact -me and let me know (or just issue a pull request on GitHub, and leave a note about it so I can just accept it ;)). - -- **[Mike Helmick (michaelhelmick)](https://github.com/michaelhelmick)**, multiple fixes and proper `requests` integration. -- **[kracekumar](https://github.com/kracekumar)**, early `requests` work and various fixes. -- **[Erik Scheffers (eriks5)](https://github.com/eriks5)**, various fixes regarding OAuth callback URLs. -- **[Jordan Bouvier (jbouvier)](https://github.com/jbouvier)**, various fixes regarding OAuth callback URLs. -- **[Dick Brouwer (dikbrouwer)](https://github.com/dikbrouwer)**, fixes for OAuth Verifier in `get_authorized_tokens`. -- **[hades](https://github.com/hades)**, Fixes to various initial OAuth issues and updates to `Twython3k` to stay current. -- **[Alex Sutton (alexdsutton)](https://github.com/alexsdutton/twython/)**, fix for parameter substitution regular expression (catch underscores!). -- **[Levgen Pyvovarov (bsn)](https://github.com/bsn)**, Various argument fixes, cyrillic text support. -- **[Mark Liu (mliu7)](https://github.com/mliu7)**, Missing parameter fix for `addListMember`. -- **[Randall Degges (rdegges)](https://github.com/rdegges)**, PEP-8 fixes, MANIFEST.in, installer fixes. -- **[Idris Mokhtarzada (idris)](https://github.com/idris)**, Fixes for various example code pieces. -- **[Jonathan Elsas (jelsas)](https://github.com/jelsas)**, Fix for original Streaming API stub causing import errors. -- **[LuqueDaniel](https://github.com/LuqueDaniel)**, Extended example code where necessary. -- **[Mesar Hameed (mhameed)](https://github.com/mhameed)**, Commit to swap `__getattr__` trick for a more debuggable solution. -- **[Remy DeCausemaker (decause)](https://github.com/decause)**, PEP-8 contributions. -- **[mckellister](https://github.com/mckellister)**, Fixes to `Exception`s raised by Twython (Rate Limits, etc). -- **[tatz_tsuchiya](http://d.hatena.ne.jp/tatz_tsuchiya/20120115/1326623451)**, Fix for `lambda` scoping in key injection phase. -- **[Voulnet (Mohammed ALDOUB)](https://github.com/Voulnet)**, Fixes for `http`/`https` access endpoints diff --git a/setup.py b/setup.py index 0b4a63d..b4786df 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ from setuptools import setup from setuptools import find_packages __author__ = 'Ryan McGrath ' -__version__ = '2.0.0' +__version__ = '2.1.0' setup( # Basic package information. @@ -16,7 +16,7 @@ setup( include_package_data=True, # Package dependencies. - install_requires=['simplejson', 'oauth2', 'requests'], + install_requires=['simplejson', 'requests'], # Metadata for PyPI. author='Ryan McGrath', @@ -25,7 +25,7 @@ setup( url='http://github.com/ryanmcgrath/twython/tree/master', keywords='twitter search api tweet twython', description='An easy (and up to date) way to access Twitter data with Python.', - long_description=open('README.markdown').read(), + long_description=open('README.rst').read(), classifiers=[ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers',