added "install via pip" and fixed markdown markup

Paul Youlten 2013-06-09 01:56:37 -07:00
parent 2c81694477
commit 4d31bd41a1

17
Home.md

@ -1,4 +1,4 @@
h1. An easy way to access Twitter data with Python. ## An easy way to access Twitter data with Python.
Twython is a Python API wrapper for the Twitter REST API. Twython is a Python API wrapper for the Twitter REST API.
<pre> <pre>
@ -12,16 +12,25 @@ twitter.searchTwitter(q="bert")
</code> </code>
</pre> </pre>
h1. Does the world really need another Twitter API Wrapper? ## Does the world really need another Twitter API Wrapper?
Maybe you're happy with the current crop of Twitter libraries for Python, but I'm honestly a little dissapointed. Other projects seem a bit outdated, or they don't cover the full API. Twython is (hopefully) the one Twitter library for Python that 100% covers the API, and is actively maintained. Maybe you're happy with the current crop of Twitter libraries for Python, but I'm honestly a little dissapointed. Other projects seem a bit outdated, or they don't cover the full API. Twython is (hopefully) the one Twitter library for Python that 100% covers the API, and is actively maintained.
h1. What does Twython require? ## What does Twython require?
Twython requires the "simplejson":http://code.google.com/p/simplejson/ library for parsing Twitter responses, as well as oauth2 for handling OAuth authentication. Twython requires the "simplejson":http://code.google.com/p/simplejson/ library for parsing Twitter responses, as well as oauth2 for handling OAuth authentication.
h1. I have a patch, can I contribute back? ### Install via pip
<pre>
<code>
$ pip install -I twthon
</code>
</pre>
Installs Twython and all its associated dependencies.
## I have a patch, can I contribute back?
Twython is open source, so you can make changes, hack on it, update it, whatever you think works for you. If you make a change that you think might help the community, or you find and fix a bug, hit the project up on Github. Twython is open source, so you can make changes, hack on it, update it, whatever you think works for you. If you make a change that you think might help the community, or you find and fix a bug, hit the project up on Github.
#### Credits
Twython was created, and is maintained, by "Ryan McGrath":http://twitter.com/ryanmcgrath. Twython is released under a BSD style license. Questions, comments? Email "ryan" [at] "venodesigns.net". Twython was created, and is maintained, by "Ryan McGrath":http://twitter.com/ryanmcgrath. Twython is released under a BSD style license. Questions, comments? Email "ryan" [at] "venodesigns.net".