.. highlight:: shell

============
Installation
============

.. image:: https://img.shields.io/pypi/v/phuzzy.svg
    :target: https://pypi.python.org/pypi/phuzzy

.. image:: https://readthedocs.org/projects/phuzzy/badge/?version=latest
    :target: https://phuzzy.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://travis-ci.org/lepy/phuzzy.svg?branch=master
    :target: https://travis-ci.org/lepy/phuzzy

.. image:: https://coveralls.io/repos/github/lepy/phuzzy/badge.svg
    :target: https://coveralls.io/github/lepy/phuzzy

.. image:: https://pyup.io/repos/github/lepy/phuzzy/shield.svg
    :target: https://pyup.io/repos/github/lepy/phuzzy/
    :alt: Updates

.. image:: https://api.codacy.com/project/badge/Grade/4814372e95c543a69c69004c853b17be
    :target: https://www.codacy.com/app/lepy/phuzzy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=lepy/phuzzy&amp;utm_campaign=Badge_Grade

Stable release
--------------

To install phuzzy, run this command in your terminal:

.. code-block:: console

    $ pip install phuzzy

This is the preferred method to install phuzzy, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for phuzzy can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/lepy/phuzzy

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://github.com/lepy/phuzzy/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/lepy/phuzzy
.. _tarball: https://github.com/lepy/phuzzy/tarball/master
