Stamper - installation instructions
===================================

.. contents::

First, install dependencies
---------------------------

So far, the only dependency you will need in order to run stamper is Python [1]_

Mailjam has been tested with python *2.7.x*, but it should work with versions
*2.6.x* too.

Please, refer to your operating system package system documentation to learn
more about how to install python.


Second, install Stamper
-----------------------

Installing using pip/easy_install
+++++++++++++++++++++++++++++++++

You can install Stamper using pip [2]_::

  pip install Stamper

or easy_install [3]_::

  easy_install Stamper

Installing from sources
+++++++++++++++++++++++

Releases
********

There are no releases yet. You will have to install it from the repository.

From repository
***************

The source code of Stamper is hosted in bitbucket [4]_. In order to grab
the latest sources you need Mercurial [5]_.

To get a copy of the sources, just *clone* the repository::

  hg clone https://bitbucket.org/codigo23/stamper stamper-repo

Then, go inside the *stamper-repo* directory and run::

  python setup.py install

.. warning::

   If you want to install it *system-wide*, probably you will need *root*
   privileges (check your OS documentation to learn more about how to get
   *root* privileges - for example using sudo [6]_)

You can also install it in *development mode*, which allow you to test the
software and make changes to the sources, those changes will be available
instantly for using/testing::

  python setup.py develop


.. [1] http://python.org
.. [2] http://www.pip-installer.org/en/latest/index.html
.. [3] http://peak.telecommunity.com/DevCenter/EasyInstall
.. [4] https://bitbucket.org/codigo23/stamper
.. [5] http://mercurial.selenic.com
.. [6] http://sudo.ws