Mailjam - installation instructions =================================== .. contents:: First, install dependencies --------------------------- So far, the only dependency you will need in order to run mailjam 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 Mailjam ----------------------- Installing using pip ++++++++++++++++++++ You can install Mailjam using pip [2]_:: pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam .. note:: Mailjam has not been recorded/uploaded to pypi [3]_ 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 [4]_ yet (until we do record/upload it to pypi) Installing inside a virtualenv ++++++++++++++++++++++++++++++ You can install Mailjam inside a virtualenv [5]_. 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 Installing from sources +++++++++++++++++++++++ Releases ******** 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 [6]_. In order to grab the latest sources you need Mercurial [7]_. 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 [8]_) Setting up Mailjam ------------------ TBW Running Mailjam --------------- TBW Running tests (developers only) ------------------------------- TBW .. [1] http://python.org .. [2] http://www.pip-installer.org/en/latest/index.html .. [3] http://pypi.python.org/pypi .. [4] http://peak.telecommunity.com/DevCenter/EasyInstall .. [5] http://www.virtualenv.org/en/latest/index.html .. [6] https://bitbucket.org/codigo23/mailjam .. [7] http://mercurial.selenic.com .. [8] http://sudo.ws