source: mailjam/docs/src/install.rst@ 16:cd4170142d87

Last change on this file since 16:cd4170142d87 was 16:cd4170142d87, checked in by Borja Lopez <borja@…>, 12 years ago

Renamed the project to Mailjam

File size: 3.2 KB

Installation instructions

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.

Second, install Mailjam

Installing using pip

You can install Mailjam using pip:

pip install -e


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.

Installing using easy_install

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

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


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

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.


There are no releases yet. You will have to install it from the 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 mailjam-repo

Then, go inside the mailjam-repo directory and run:

python install


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)


This process will work inside a virtualenv too.

Note: See TracBrowser for help on using the repository browser.