source: mailjam/INSTALL@ 12:dcc1da2dfa90

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

Added an initial version of the INSTALL file

File size: 2.7 KB
Line 
1Postman - installation instructions
2===================================
3
4.. contents::
5
6First, install dependencies
7---------------------------
8
9So far, the only dependency you will need in order to run postman is Python [1]_
10
11Postman has been tested with python *2.7.x*, but it should work with versions
122.6.x too.
13
14Please, refer to your operating system package system documentation to learn
15more about how to install python.
16
17Second, install Postman
18-----------------------
19
20Installing using pip
21++++++++++++++++++++
22
23You can install Postman using pip [2]_::
24
25 pip install -e https://bitbucket.org/codigo23/postman#egg=postman
26
27.. note::
28
29 Postman has not been recorded/uploaded to pypi [3]_ yet, so, in order
30 to install it using pip you will have to provide the URL for the public
31 Postman repo.
32
33Installing using easy_install
34+++++++++++++++++++++++++++++
35
36You can not install Postman using easy_install [4]_ yet (until we do
37record/upload it to pypi)
38
39Installing inside a virtualenv
40++++++++++++++++++++++++++++++
41
42You can install Postman inside a virtualenv [5]_. Just create a virtualenv::
43
44 virtualenv /path/to/your/env
45
46Then activate it::
47
48 source /path/to/your/env/bin/activate
49
50.. note::
51
52 If your shell is **csh**/**tcsh** remember you have to activate the
53 environment this way::
54
55 source /path/to/your/env/bin/activate.csh
56
57And, once the environment has been activated, using pip to install Postman::
58
59 env$ pip install -e https://bitbucket.org/codigo23/postman#egg=postman
60
61Installing from sources
62+++++++++++++++++++++++
63
64Releases
65********
66
67There are no releases yet. You will have to install it from the repository.
68
69From repository
70***************
71
72The source code of Postman is hosted in bitbucket [6]_. In order to grab
73the latest sources you need Mercurial [7]_.
74
75To get a copy of the sources, just *clone* the repository::
76
77 hg clone https://bitbucket.org/codigo23/postman postman-repo
78
79Then, go inside the *postman-repo* directory and run::
80
81 python setup.py install
82
83.. warning::
84
85 If you want to install it *system-wide*, probably you will need *root*
86 privileges (check your OS documentation to learn more about how to get
87 *root* privileges - for example using sudo [8]_)
88
89Setting up Postman
90------------------
91
92TBW
93
94Running Postman
95---------------
96
97TBW
98
99Running tests (developers only)
100-------------------------------
101
102TBW
103
104.. [1] http://python.org
105.. [2] http://www.pip-installer.org/en/latest/index.html
106.. [3] http://pypi.python.org/pypi
107.. [4] http://peak.telecommunity.com/DevCenter/EasyInstall
108.. [5] http://www.virtualenv.org/en/latest/index.html
109.. [6] https://bitbucket.org/codigo23/postman
110.. [7] http://mercurial.selenic.com
111.. [8] http://sudo.ws
Note: See TracBrowser for help on using the repository browser.