source: mailjam/docs/src/_build/html/_sources/install.txt@ 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
Line 
1Installation instructions
2=========================
3
4.. contents::
5
6.. _install_dependencies:
7
8First, install dependencies
9---------------------------
10
11So far, the only dependency you will need in order to run postman is Python_
12
13Postman has been tested with python *2.7.x*, but it should work with versions
14*2.6.x* too.
15
16Please, refer to your operating system package system documentation to learn
17more about how to install python.
18
19.. _install_postman:
20
21Second, install Postman
22-----------------------
23
24.. _install_with_pip:
25
26Installing using pip
27++++++++++++++++++++
28
29You can install Postman using pip_::
30
31 pip install -e https://bitbucket.org/codigo23/postman#egg=postman
32
33.. note::
34
35 Postman has not been recorded/uploaded to pypi_ yet, so, in order to install
36 it using pip you will have to provide the URL for the public Postman repo.
37
38.. _install_with_easy_install:
39
40Installing using easy_install
41+++++++++++++++++++++++++++++
42
43You can not install Postman using easy_install_ yet (until we do record/upload
44it to pypi)
45
46.. _install_inside_virtualenv:
47
48Installing inside a virtualenv
49++++++++++++++++++++++++++++++
50
51You can install Postman inside a virtualenv_. Just create a virtualenv::
52
53 virtualenv /path/to/your/env
54
55Then activate it::
56
57 source /path/to/your/env/bin/activate
58
59.. note::
60
61 If your shell is **csh**/**tcsh** remember you have to activate the
62 environment this way::
63
64 source /path/to/your/env/bin/activate.csh
65
66And, once the environment has been activated, use pip to install Postman::
67
68 env$ pip install -e https://bitbucket.org/codigo23/postman#egg=postman
69
70.. _install_from_sources:
71
72Installing from sources
73+++++++++++++++++++++++
74
75When installing from sources, you can download one of the official releases
76or you can go with the *bleeding edge* and get a copy of the official source
77code repository.
78
79.. _install_from_release:
80
81Releases
82********
83
84**There are no releases yet**. You will have to install it from the repository.
85
86.. _install_from_repository:
87
88From repository
89***************
90
91The source code of Postman is hosted in bitbucket_ [1]_. In order to grab
92the latest sources you need Mercurial_.
93
94To get a copy of the sources, just *clone* the repository::
95
96 hg clone https://bitbucket.org/codigo23/postman postman-repo
97
98Then, go inside the *postman-repo* directory and run::
99
100 python setup.py install
101
102.. warning::
103
104 If you want to install it *system-wide*, probably you will need *root*
105 privileges (check your OS documentation to learn more about how to get
106 *root* privileges - for example using sudo_)
107
108.. note::
109
110 This process will work inside a virtualenv_ too.
111
112.. _install_setting_up_postman:
113
114Setting up Postman
115------------------
116
117TBW
118
119.. _install_running_postman:
120
121Running Postman
122---------------
123
124TBW
125
126.. _install_running_tests:
127
128Running tests (developers only)
129-------------------------------
130
131TBW
132
133.. _Python: http://python.org
134.. _pip: http://www.pip-installer.org/en/latest/index.html
135.. _pypi: http://pypi.python.org/pypi
136.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
137.. _virtualenv: http://www.virtualenv.org/en/latest/index.html
138.. _bitbucket: https://bitbucket.org
139.. _Mercurial: http://mercurial.selenic.com
140.. _sudo: http://sudo.ws
141
142.. [1] https://bitbucket.org/codigo23/postman
Note: See TracBrowser for help on using the repository browser.