summaryrefslogtreecommitdiff
path: root/docs/install.rst
blob: 365cca890be7b66777d678fce1b559a21aa8413e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.. _install:
Installation
============

This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed.


.. _installing:

-----------------
Installing Tablib
-----------------

Distribute & Pip
----------------

Of course, the recommended way to install Tablib is with `pip <http://www.pip-installer.org/>`_::

    $ pip install tablib


-------------------
Download the Source
-------------------

You can also install tablib from source. The latest release (|version|) is available from GitHub.

* tarball_
* zipball_

.. _
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


To download the full source history from Git, see :ref:`Source Control <scm>`.

.. _tarball: http://github.com/kennethreitz/tablib/tarball/master
.. _zipball: http://github.com/kennethreitz/tablib/zipball/master


.. _speed-extensions:
Speed Extensions
----------------

You can gain some speed improvement by optionally installing the ujson_ library.
Tablib will fallback to the standard `json` module if it doesn't find ``ujson``.

.. _ujson: https://pypi.python.org/pypi/ujson


.. _updates:
Staying Updated
---------------

The latest version of Tablib will always be available here:

* PyPi: http://pypi.python.org/pypi/tablib/
* GitHub: http://github.com/kennethreitz/tablib/

When a new version is available, upgrading is simple::

    $ pip install tablib --upgrade


Now, go get a :ref:`Quick Start <quickstart>`.