source: mailjam/docs/src/install.rst@ 13:f1f11159dbed

Last change on this file since 13:f1f11159dbed was 13:f1f11159dbed, checked in by Borja Lopez <borja@…>, 10 years ago

Added first version of the project documentation. Inside docs/src there is
the sphinx [1] project we use to manage the docs. Inside docs/html there is
a copy of the docs in html format.

Fixed some typos in the INSTALL file

Added two new parameters to the postman.conf file (both the example config
file inside conf/ and the one used for testing in postman/tests/). These
parameters do nothing yet (they are related to ssl stuff) but we do talk
about them in the docs.

Added a new method to the XMLRPC list of methods related to members.

[1] http://sphinx.pocoo.org

File size: 3.2 KB

Installation instructions

First, install dependencies

So far, the only dependency you will need in order to run postman is Python

Postman 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 Postman

Installing using pip

You can install Postman using pip:

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

Note

Postman 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 Postman repo.

Installing using easy_install

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

Installing inside a virtualenv

You can install Postman 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 Postman:

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

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.

Releases

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

From repository

The source code of Postman 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/postman postman-repo

Then, go inside the postman-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.

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