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

Moving README to Markdown

Browse source
This commit is contained in:
Ryan McGrath 2009-09-17 01:58:23 -04:00
parent a1c4b17c6d
commit d7d099b52d
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.markdown Normal file
View file

@ -0,0 +1,48 @@
Twython - Easy Twitter utilities in Python
=========================================================================================
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
a library that offers more coverage.
This is my first library I've ever written in Python, so there could be some stuff in here that'll
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.
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
Authentication. To override this, specify 'authtype="Basic"' in your twython.setup() call.
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.
Requirements
-----------------------------------------------------------------------------------------------------
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:
> http://pypi.python.org/pypi/simplejson
Example Use
-----------------------------------------------------------------------------------------------------
> import twython
>
> twitter = twython.setup(authtype="Basic", username="example", password="example")
> twitter.updateStatus("See how easy this was?")
Twython 3k
-----------------------------------------------------------------------------------------------------
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,
be aware of this.
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.
Twython is released under an MIT License - see the LICENSE file for more information.