installation
authorKenneth Reitz <me@kennethreitz.com>
Mon, 16 May 2011 01:01:48 +0000 (21:01 -0400)
committerKenneth Reitz <me@kennethreitz.com>
Mon, 16 May 2011 01:01:48 +0000 (21:01 -0400)
docs/user/install.rst

index 1c0b2c4..773f3c5 100644 (file)
@@ -1,15 +1,51 @@
 Installation
 ============
 
+This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed.
+
+
 Distribute & Pip
 ----------------
 
+Installing requests is simple with `pip <http://www.pip-installer.org/>`_::
+
+    $ pip install requests
+
+or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_::
+
+    $ easy_install install requests
+
+But, you really `shouldn't do that <http://www.pip-installer.org/en/latest/index.html#pip-compared-to-easy-install>`_.
+
+
+
+Cheeseshop Mirror
+-----------------
 
-PyPi Mirror
------------
+If the Cheeseshop is down, you can also install Requests from Kenneth Reitz's personal `Cheeseshop mirror <pip.kreitz.co/>`_::
 
+    $ pip install -i http://pip.kreitz.co/simple requests
 
 
 Get the Code
 ------------
 
+Requsts is actively developed on GitHub, where the code is
+`always available <https://github.com/kennethreitz/requests>`_.
+
+You can either clone the public repository::
+
+    git clone git://github.com/kennethreitz/requests.git
+
+Download the `tarball <https://github.com/kennethreitz/requests/tarball/master>`_::
+
+    $ curl -O https://github.com/kennethreitz/requests/tarball/master
+
+Or, download the `zipball <https://github.com/kennethreitz/requests/zipball/master>`_::
+
+    $ curl -O https://github.com/kennethreitz/requests/zipball/master
+
+
+Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages easily::
+
+    $ python setup.py install