.. _installation: Installation ============ Facepy is best installed with `pip`_:: $ pip install facepy .. _pip: http://www.pip-installer.org/en/latest/ .. _configuration: .. _dependencies: Dependencies ------------ In order to install and use Facepy, you will need five primary pieces of software: * `Python`_ * `Setuptools`_ * `Requests`_ .. _Python: http://python.org/ .. _Setuptools: http://pypi.python.org/pypi/setuptools .. _Requests: http://github.com/kennethreitz/requests .. _development dependencies: Development dependencies ------------------------ If you are interested in contributing to Facepy, you will also need to install some or all of the following packages: * `Nose`_ * `Sphinx`_ For an up-to-date list of exact testing/development requirements, including version numbers, please see the ``requirements.txt`` file included with the source distribution. This file is intended to be used with ``pip``, e.g. ``pip install -r requirements.txt``. .. _Nose: http://readthedocs.org/docs/nose/en/latest/ .. _Sphinx: http://www.pip-installer.org/en/latest/ .. _source-code-checkouts: Source code checkouts --------------------- To follow Facepy's development via Git instead of downloading official releases, please see our `Github mirror`_. .. _Github mirror: http://github.com/jgorset/facepy/