Changing references to Tango

This commit is contained in:
Ryan McGrath 2009-08-03 00:38:59 -04:00
parent cbfa71c286
commit fb41d4100c

30
README
View file

@ -1,12 +1,6 @@
NOTICE: On 08/01/2009, Tango is going to be renamed to "Twython". In renaming the GitHub repo, most watchers/followers Twython - Easy Twitter utilities in Python
will be lost, so please take note of this date if you wish to continue following development!
There should (hopefully) be no further disruptions after that. Eventually, I'll get around to creating a setup.py file
that works correctly. ;)
Tango - Easy Twitter utilities in Python
----------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------
I wrote Tango because I found that other Python Twitter libraries weren't that up to date. Certain I wrote Twython because I found that other Python Twitter libraries weren't that up to date. Certain
things like the Search API, OAuth, etc, don't seem to be fully covered. This is my attempt at things like the Search API, OAuth, etc, don't seem to be fully covered. This is my attempt at
a library that offers more coverage. a library that offers more coverage.
@ -14,17 +8,17 @@ This is my first library I've ever written in Python, so there could be some stu
make a seasoned Python vet scratch his head, or possibly call me insane. It's open source, though, make a seasoned Python vet scratch his head, or possibly call me insane. It's open source, though,
and I'm open to anything that'll improve the library as a whole. and I'm open to anything that'll improve the library as a whole.
OAuth support is in the works, but every other part of the Twitter API should be covered. Tango OAuth support is in the works, but every other part of the Twitter API should be covered. Twython
handles both Basic (HTTP) Authentication and OAuth, and OAuth is the default method for handles both Basic (HTTP) Authentication and OAuth, and OAuth is the default method for
Authentication. To override this, specify 'authtype="Basic"' in your tango.setup() call. Authentication. To override this, specify 'authtype="Basic"' in your twython.setup() call.
Documentation is forthcoming, but Tango attempts to mirror the Twitter API in a large way. All Documentation is forthcoming, but Twython attempts to mirror the Twitter API in a large way. All
parameters for API calls should translate over as function arguments. parameters for API calls should translate over as function arguments.
Requirements Requirements
----------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------
Tango requires (much like Python-Twitter, because they had the right idea :D) a library called Twython requires (much like Python-Twitter, because they had the right idea :D) a library called
"simplejson". You can grab it at the following link: "simplejson". You can grab it at the following link:
http://pypi.python.org/pypi/simplejson http://pypi.python.org/pypi/simplejson
@ -32,23 +26,23 @@ http://pypi.python.org/pypi/simplejson
Example Use Example Use
----------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------
import tango import twython
twitter = tango.setup(authtype="Basic", username="example", password="example") twitter = twython.setup(authtype="Basic", username="example", password="example")
twitter.updateStatus("See how easy this was?") twitter.updateStatus("See how easy this was?")
Tango 3k Twython 3k
----------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------
There's an experimental version of Tango that's made for Python 3k. This is currently not guaranteed There's an experimental version of Twython that's made for Python 3k. This is currently not guaranteed
to work, but it's provided so that others can grab it and hack on it. If you choose to try it out, to work, 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. be aware of this.
Questions, Comments, etc? Questions, Comments, etc?
----------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------
My hope is that Tango is so simple that you'd never *have* to ask any questions, but if 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 you feel the need to contact me for this (or other) reasons, you can hit me up
at ryan@venodesigns.net. at ryan@venodesigns.net.
Tango is released under an MIT License - see the LICENSE file for more information. Twython is released under an MIT License - see the LICENSE file for more information.