Updated docs to fix verbage and note PEP8 swapover for anyone who misses it

This commit is contained in:
Ryan McGrath 2013-05-04 20:33:11 -04:00
parent 60b2e14bef
commit bd0bd2748c
2 changed files with 6 additions and 9 deletions

View file

@ -1,7 +1,7 @@
Twython Twython
======= =======
```Twython``` is library providing an easy (and up-to-date) way to access Twitter data in Python ```Twython``` is a library providing an easy (and up-to-date) way to access Twitter data in Python. Actively maintained and featuring support for both Python 2.6+ and Python 3, it's been battle tested by companies, educational institutions and individuals alike. Try it today!
Features Features
-------- --------
@ -140,7 +140,6 @@ except TwythonError as e:
```python ```python
from twython import TwythonStreamer from twython import TwythonStreamer
class MyStreamer(TwythonStreamer): class MyStreamer(TwythonStreamer):
def on_success(self, data): def on_success(self, data):
print data print data
@ -157,7 +156,8 @@ stream.statuses.filter(track='twitter')
Notes Notes
----- -----
Twython (as of 2.7.0) is currently in the process of ONLY supporting Twitter v1.1 endpoints and deprecating all v1 endpoints! Please see the **[Twitter v1.1 API Documentation](https://dev.twitter.com/docs/api/1.1)** to help migrate your API calls! - Twython (as of 2.7.0) now supports ONLY Twitter v1.1 endpoints! Please see the **[Twitter v1.1 API Documentation](https://dev.twitter.com/docs/api/1.1)** to help migrate your API calls!
- As of Twython 2.9.1, all method names conform to PEP8 standards. For backwards compatibility, we internally check and catch any calls made using the old (pre 2.9.1) camelCase method syntax. We will continue to support this for the foreseeable future for all old methods (raising a DeprecationWarning where appropriate), but you should update your code if you have the time.
Questions, Comments, etc? Questions, Comments, etc?
------------------------- -------------------------

View file

@ -1,6 +1,6 @@
Twython Twython
======= =======
``Twython`` is library providing an easy (and up-to-date) way to access Twitter data in Python ``Twython`` is a library providing an easy (and up-to-date) way to access Twitter data in Python. Actively maintained and featuring support for both Python 2.6+ and Python 3, it's been battle tested by companies, educational institutions and individuals alike. Try it today!
Features Features
-------- --------
@ -168,11 +168,8 @@ Streaming API
Notes Notes
----- -----
* Twython (as of 2.7.0) is currently in the process of ONLY supporting Twitter v1.1 endpoints and deprecating all v1 endpoints! Please see the `Twitter API Documentation <https://dev.twitter.com/docs/api/1.1>`_ to help migrate your API calls! * Twython (as of 2.7.0) now supports ONLY Twitter v1.1 endpoints! Please see the **[Twitter v1.1 API Documentation](https://dev.twitter.com/docs/api/1.1)** to help migrate your API calls!
* As of Twython 2.9.1, all method names conform to PEP8 standards. For backwards compatibility, we internally check and catch any calls made using the old (pre 2.9.1) camelCase method syntax. We will continue to support this for the foreseeable future for all old methods (raising a DeprecationWarning where appropriate), but you should update your code if you have the time.
Twython && Django
-----------------
If you're using Twython with Django, there's a sample project showcasing OAuth and such **[that can be found here](https://github.com/ryanmcgrath/twython-django)**. Feel free to peruse!
Questions, Comments, etc? Questions, Comments, etc?
------------------------- -------------------------