install.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. .. _install:
  2. Installation
  3. ============
  4. This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed. Please read this section carefully, or you may miss out on some nice :ref:`speed enhancements <peed-extensions>`.
  5. .. _installing:
  6. -----------------
  7. Installing Tablib
  8. -----------------
  9. Distribute & Pip
  10. ----------------
  11. Installing Tablib is simple with `pip <http://www.pip-installer.org/>`_::
  12. $ pip install tablib
  13. or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_::
  14. $ easy_install tablib
  15. But, you really `shouldn't do that <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_.
  16. Cheeseshop Mirror
  17. -----------------
  18. If the Cheeseshop is down, you can also install Requests from Kenneth Reitz's personal `Cheeseshop mirror <pip.kreitz.co/>`_::
  19. $ pip install -i http://pip.kreitz.co/simple tablib
  20. -------------------
  21. Download the Source
  22. -------------------
  23. You can also install tablib from source. The latest release (|version|) is available from GitHub.
  24. * tarball_
  25. * zipball_
  26. .. _
  27. Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages easily. ::
  28. $ python setup.py install
  29. To download the full source history from Git, see :ref:`Source Control <scm>`.
  30. .. _tarball: http://github.com/kennethreitz/tablib/tarball/master
  31. .. _zipball: http://github.com/kennethreitz/tablib/zipball/master
  32. .. _speed-extensions:
  33. Speed Extensions
  34. ----------------
  35. .. versionadded:: 0.8.5
  36. Tablib is partially dependent on the **pyyaml**, **simplejson**, and **xlwt** modules. To reduce installation issues, fully integrated versions of all required libraries are included in Tablib.
  37. However, if performance is important to you (and it should be), you can install **pyyaml** with C extensions from PyPi. ::
  38. $ pip install PyYAML
  39. If you're using Python 2.5, you should also install the **simplejson** module (pip will do this for you). If you're using Python 2.6+, the built-in **json** module is already optimized and in use. ::
  40. $ pip install simplejson
  41. .. _updates:
  42. Staying Updated
  43. ---------------
  44. The latest version of Tablib will always be available here:
  45. * PyPi: http://pypi.python.org/pypi/tablib/
  46. * GitHub: http://github.com/kennethreitz/tablib/
  47. When a new version is available, upgrading is simple::
  48. $ pip install tablib --upgrade
  49. Now, go get a :ref:`Quick Start <quickstart>`.