twython/docs/usage/install.rst
Mike Helmick 9f864a341c Updating docs
[ci skip]
2013-06-13 11:05:18 -04:00

59 lines
No EOL
1.3 KiB
ReStructuredText

.. _install:
Installation
============
Information on how to properly install Twython
*******************************************************************************
Pip or Easy Install
-------------------
Install Twython via `pip <http://www.pip-installer.org/>`_
.. code-block:: bash
$ pip install twython
or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_
.. code-block:: bash
$ easy_install twython
But, hey... `that's up to you <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_.
Source Code
-----------
Twython is actively maintained on GitHub
Feel free to clone the repository
.. code-block:: bash
git clone git://github.com/ryanmcgrath/twython.git
`tarball <https://github.com/ryanmcgrath/twython/tarball/master>`_
.. code-block:: bash
$ curl -OL https://github.com/ryanmcgrath/twython/tarball/master
`zipball <https://github.com/ryanmcgrath/twython/tarball/master>`_
.. code-block:: bash
$ curl -OL https://github.com/ryanmcgrath/twython/zipball/master
Now that you have the source code, install it into your site-packages directory
.. code-block:: bash
$ python setup.py install
*******************************************************************************
So Twython is installed! Now, head over to the :ref:`starting out <starting-out>` section.