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

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

To install averell, run this command in your terminal::

    pip install averell

This is the preferred method to install averell, 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 SpaCy Affixes can be downloaded from the `Github repo`_.

You can either clone the public repository::

    git clone git://github.com/linhd-postdata/averell

Or download the `tarball`_::

    curl  -OL https://github.com/linhd-postdata/averell/tarball/master

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

    python setup.py install


.. _Github repo: https://github.com/linhd-postdata/averell
.. _tarball: https://github.com/linhd-postdata/averell/tarball/master