Installation instructions
=========================

.. contents::

.. _install_dependencies:

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

So far, the only dependency you will need in order to run mailjam is Python_

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.

.. _install_mailjam:

Second, install Mailjam
-----------------------

.. _install_with_pip:

Installing using pip
++++++++++++++++++++

You can install Mailjam using pip_::

  pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam

.. note::

   Mailjam has not been recorded/uploaded to pypi_ yet, so, in order to install 
   it using pip you will have to provide the URL for the public Mailjam repo.

.. _install_with_easy_install:

Installing using easy_install
+++++++++++++++++++++++++++++

You can not install Mailjam using easy_install_ yet (until we do record/upload 
it to pypi)

.. _install_inside_virtualenv:

Installing inside a virtualenv
++++++++++++++++++++++++++++++

You can install Mailjam inside a virtualenv_. Just create a virtualenv::

  virtualenv /path/to/your/env

Then activate it::

  source /path/to/your/env/bin/activate

.. note::

   If your shell is **csh**/**tcsh** remember you have to activate the 
   environment this way::

     source /path/to/your/env/bin/activate.csh

And, once the environment has been activated, use pip to install Mailjam::

  env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam

.. _install_from_sources:

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

When installing from sources, you can download one of the official releases
or you can go with the *bleeding edge* and get a copy of the official source
code repository.

.. _install_from_release:

Releases
********

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

.. _install_from_repository:

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

The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab
the latest sources you need Mercurial_.

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

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

Then, go inside the *mailjam-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_)

.. note::

   This process will work inside a virtualenv_ too.

.. _install_setting_up_mailjam:

Setting up Mailjam
------------------

TBW

.. _install_running_mailjam:

Running Mailjam
---------------

TBW

.. _install_running_tests:

Running tests (developers only)
-------------------------------

TBW

.. _Python: http://python.org
.. _pip: http://www.pip-installer.org/en/latest/index.html
.. _pypi: http://pypi.python.org/pypi
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
.. _virtualenv: http://www.virtualenv.org/en/latest/index.html
.. _bitbucket: https://bitbucket.org
.. _Mercurial: http://mercurial.selenic.com
.. _sudo: http://sudo.ws

.. [1] https://bitbucket.org/codigo23/mailjam