source: mailjam/docs/src/_build/html/install.html@ 13:f1f11159dbed

Last change on this file since 13:f1f11159dbed was 13:f1f11159dbed, checked in by Borja Lopez <borja@…>, 13 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: 14.2 KB
RevLine 
[13]1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10
11 <title>Installation instructions &mdash; Postman 0.1.0 documentation</title>
12
13 <link rel="stylesheet" href="_static/default.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15
16 <script type="text/javascript">
17 var DOCUMENTATION_OPTIONS = {
18 URL_ROOT: '',
19 VERSION: '0.1.0',
20 COLLAPSE_INDEX: false,
21 FILE_SUFFIX: '.html',
22 HAS_SOURCE: true
23 };
24 </script>
25 <script type="text/javascript" src="_static/jquery.js"></script>
26 <script type="text/javascript" src="_static/underscore.js"></script>
27 <script type="text/javascript" src="_static/doctools.js"></script>
28 <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
29 <link rel="next" title="Configuration" href="configuration.html" />
30 <link rel="prev" title="Overview of postman’s architecture" href="overview.html" />
31 </head>
32 <body>
33 <div class="related">
34 <h3>Navigation</h3>
35 <ul>
36 <li class="right" style="margin-right: 10px">
37 <a href="genindex.html" title="General Index"
38 accesskey="I">index</a></li>
39 <li class="right" >
40 <a href="configuration.html" title="Configuration"
41 accesskey="N">next</a> |</li>
42 <li class="right" >
43 <a href="overview.html" title="Overview of postman’s architecture"
44 accesskey="P">previous</a> |</li>
45 <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
46 </ul>
47 </div>
48
49 <div class="document">
50 <div class="documentwrapper">
51 <div class="bodywrapper">
52 <div class="body">
53
54 <div class="section" id="installation-instructions">
55<h1><a class="toc-backref" href="#id3">Installation instructions</a><a class="headerlink" href="#installation-instructions" title="Permalink to this headline"></a></h1>
56<div class="contents topic" id="contents">
57<p class="topic-title first">Contents</p>
58<ul class="simple">
59<li><a class="reference internal" href="#installation-instructions" id="id3">Installation instructions</a><ul>
60<li><a class="reference internal" href="#first-install-dependencies" id="id4">First, install dependencies</a></li>
61<li><a class="reference internal" href="#second-install-postman" id="id5">Second, install Postman</a><ul>
62<li><a class="reference internal" href="#installing-using-pip" id="id6">Installing using pip</a></li>
63<li><a class="reference internal" href="#installing-using-easy-install" id="id7">Installing using easy_install</a></li>
64<li><a class="reference internal" href="#installing-inside-a-virtualenv" id="id8">Installing inside a virtualenv</a></li>
65<li><a class="reference internal" href="#installing-from-sources" id="id9">Installing from sources</a><ul>
66<li><a class="reference internal" href="#releases" id="id10">Releases</a></li>
67<li><a class="reference internal" href="#from-repository" id="id11">From repository</a></li>
68</ul>
69</li>
70</ul>
71</li>
72<li><a class="reference internal" href="#setting-up-postman" id="id12">Setting up Postman</a></li>
73<li><a class="reference internal" href="#running-postman" id="id13">Running Postman</a></li>
74<li><a class="reference internal" href="#running-tests-developers-only" id="id14">Running tests (developers only)</a></li>
75</ul>
76</li>
77</ul>
78</div>
79<div class="section" id="first-install-dependencies">
80<span id="install-dependencies"></span><h2><a class="toc-backref" href="#id4">First, install dependencies</a><a class="headerlink" href="#first-install-dependencies" title="Permalink to this headline"></a></h2>
81<p>So far, the only dependency you will need in order to run postman is <a class="reference external" href="http://python.org">Python</a></p>
82<p>Postman has been tested with python <em>2.7.x</em>, but it should work with versions
83<em>2.6.x</em> too.</p>
84<p>Please, refer to your operating system package system documentation to learn
85more about how to install python.</p>
86</div>
87<div class="section" id="second-install-postman">
88<span id="install-postman"></span><h2><a class="toc-backref" href="#id5">Second, install Postman</a><a class="headerlink" href="#second-install-postman" title="Permalink to this headline"></a></h2>
89<div class="section" id="installing-using-pip">
90<span id="install-with-pip"></span><h3><a class="toc-backref" href="#id6">Installing using pip</a><a class="headerlink" href="#installing-using-pip" title="Permalink to this headline"></a></h3>
91<p>You can install Postman using <a class="reference external" href="http://www.pip-installer.org/en/latest/index.html">pip</a>:</p>
92<div class="highlight-python"><pre>pip install -e https://bitbucket.org/codigo23/postman#egg=postman</pre>
93</div>
94<div class="admonition note">
95<p class="first admonition-title">Note</p>
96<p class="last">Postman has not been recorded/uploaded to <a class="reference external" href="http://pypi.python.org/pypi">pypi</a> yet, so, in order to install
97it using pip you will have to provide the URL for the public Postman repo.</p>
98</div>
99</div>
100<div class="section" id="installing-using-easy-install">
101<span id="install-with-easy-install"></span><h3><a class="toc-backref" href="#id7">Installing using easy_install</a><a class="headerlink" href="#installing-using-easy-install" title="Permalink to this headline"></a></h3>
102<p>You can not install Postman using <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> yet (until we do record/upload
103it to pypi)</p>
104</div>
105<div class="section" id="installing-inside-a-virtualenv">
106<span id="install-inside-virtualenv"></span><h3><a class="toc-backref" href="#id8">Installing inside a virtualenv</a><a class="headerlink" href="#installing-inside-a-virtualenv" title="Permalink to this headline"></a></h3>
107<p>You can install Postman inside a <a class="reference external" href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a>. Just create a virtualenv:</p>
108<div class="highlight-python"><div class="highlight"><pre><span class="n">virtualenv</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">env</span>
109</pre></div>
110</div>
111<p>Then activate it:</p>
112<div class="highlight-python"><div class="highlight"><pre><span class="n">source</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">env</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
113</pre></div>
114</div>
115<div class="admonition note">
116<p class="first admonition-title">Note</p>
117<p>If your shell is <strong>csh</strong>/<strong>tcsh</strong> remember you have to activate the
118environment this way:</p>
119<div class="last highlight-python"><div class="highlight"><pre><span class="n">source</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">env</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span><span class="o">.</span><span class="n">csh</span>
120</pre></div>
121</div>
122</div>
123<p>And, once the environment has been activated, use pip to install Postman:</p>
124<div class="highlight-python"><pre>env$ pip install -e https://bitbucket.org/codigo23/postman#egg=postman</pre>
125</div>
126</div>
127<div class="section" id="installing-from-sources">
128<span id="install-from-sources"></span><h3><a class="toc-backref" href="#id9">Installing from sources</a><a class="headerlink" href="#installing-from-sources" title="Permalink to this headline"></a></h3>
129<p>When installing from sources, you can download one of the official releases
130or you can go with the <em>bleeding edge</em> and get a copy of the official source
131code repository.</p>
132<div class="section" id="releases">
133<span id="install-from-release"></span><h4><a class="toc-backref" href="#id10">Releases</a><a class="headerlink" href="#releases" title="Permalink to this headline"></a></h4>
134<p><strong>There are no releases yet</strong>. You will have to install it from the repository.</p>
135</div>
136<div class="section" id="from-repository">
137<span id="install-from-repository"></span><h4><a class="toc-backref" href="#id11">From repository</a><a class="headerlink" href="#from-repository" title="Permalink to this headline"></a></h4>
138<p>The source code of Postman is hosted in <a class="reference external" href="https://bitbucket.org">bitbucket</a> <a class="footnote-reference" href="#id2" id="id1">[1]</a>. In order to grab
139the latest sources you need <a class="reference external" href="http://mercurial.selenic.com">Mercurial</a>.</p>
140<p>To get a copy of the sources, just <em>clone</em> the repository:</p>
141<div class="highlight-python"><pre>hg clone https://bitbucket.org/codigo23/postman postman-repo</pre>
142</div>
143<p>Then, go inside the <em>postman-repo</em> directory and run:</p>
144<div class="highlight-python"><pre>python setup.py install</pre>
145</div>
146<div class="admonition warning">
147<p class="first admonition-title">Warning</p>
148<p class="last">If you want to install it <em>system-wide</em>, probably you will need <em>root</em>
149privileges (check your OS documentation to learn more about how to get
150<em>root</em> privileges - for example using <a class="reference external" href="http://sudo.ws">sudo</a>)</p>
151</div>
152<div class="admonition note">
153<p class="first admonition-title">Note</p>
154<p class="last">This process will work inside a <a class="reference external" href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a> too.</p>
155</div>
156</div>
157</div>
158</div>
159<div class="section" id="setting-up-postman">
160<span id="install-setting-up-postman"></span><h2><a class="toc-backref" href="#id12">Setting up Postman</a><a class="headerlink" href="#setting-up-postman" title="Permalink to this headline"></a></h2>
161<p>TBW</p>
162</div>
163<div class="section" id="running-postman">
164<span id="install-running-postman"></span><h2><a class="toc-backref" href="#id13">Running Postman</a><a class="headerlink" href="#running-postman" title="Permalink to this headline"></a></h2>
165<p>TBW</p>
166</div>
167<div class="section" id="running-tests-developers-only">
168<span id="install-running-tests"></span><h2><a class="toc-backref" href="#id14">Running tests (developers only)</a><a class="headerlink" href="#running-tests-developers-only" title="Permalink to this headline"></a></h2>
169<p>TBW</p>
170<table class="docutils footnote" frame="void" id="id2" rules="none">
171<colgroup><col class="label" /><col /></colgroup>
172<tbody valign="top">
173<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="https://bitbucket.org/codigo23/postman">https://bitbucket.org/codigo23/postman</a></td></tr>
174</tbody>
175</table>
176</div>
177</div>
178
179
180 </div>
181 </div>
182 </div>
183 <div class="sphinxsidebar">
184 <div class="sphinxsidebarwrapper">
185 <h3><a href="index.html">Table Of Contents</a></h3>
186 <ul>
187<li><a class="reference internal" href="#">Installation instructions</a><ul>
188<li><a class="reference internal" href="#first-install-dependencies">First, install dependencies</a></li>
189<li><a class="reference internal" href="#second-install-postman">Second, install Postman</a><ul>
190<li><a class="reference internal" href="#installing-using-pip">Installing using pip</a></li>
191<li><a class="reference internal" href="#installing-using-easy-install">Installing using easy_install</a></li>
192<li><a class="reference internal" href="#installing-inside-a-virtualenv">Installing inside a virtualenv</a></li>
193<li><a class="reference internal" href="#installing-from-sources">Installing from sources</a><ul>
194<li><a class="reference internal" href="#releases">Releases</a></li>
195<li><a class="reference internal" href="#from-repository">From repository</a></li>
196</ul>
197</li>
198</ul>
199</li>
200<li><a class="reference internal" href="#setting-up-postman">Setting up Postman</a></li>
201<li><a class="reference internal" href="#running-postman">Running Postman</a></li>
202<li><a class="reference internal" href="#running-tests-developers-only">Running tests (developers only)</a></li>
203</ul>
204</li>
205</ul>
206
207 <h4>Previous topic</h4>
208 <p class="topless"><a href="overview.html"
209 title="previous chapter">Overview of postman&#8217;s architecture</a></p>
210 <h4>Next topic</h4>
211 <p class="topless"><a href="configuration.html"
212 title="next chapter">Configuration</a></p>
213 <h3>This Page</h3>
214 <ul class="this-page-menu">
215 <li><a href="_sources/install.txt"
216 rel="nofollow">Show Source</a></li>
217 </ul>
218<div id="searchbox" style="display: none">
219 <h3>Quick search</h3>
220 <form class="search" action="search.html" method="get">
221 <input type="text" name="q" />
222 <input type="submit" value="Go" />
223 <input type="hidden" name="check_keywords" value="yes" />
224 <input type="hidden" name="area" value="default" />
225 </form>
226 <p class="searchtip" style="font-size: 90%">
227 Enter search terms or a module, class or function name.
228 </p>
229</div>
230<script type="text/javascript">$('#searchbox').show(0);</script>
231 </div>
232 </div>
233 <div class="clearer"></div>
234 </div>
235 <div class="related">
236 <h3>Navigation</h3>
237 <ul>
238 <li class="right" style="margin-right: 10px">
239 <a href="genindex.html" title="General Index"
240 >index</a></li>
241 <li class="right" >
242 <a href="configuration.html" title="Configuration"
243 >next</a> |</li>
244 <li class="right" >
245 <a href="overview.html" title="Overview of postman’s architecture"
246 >previous</a> |</li>
247 <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
248 </ul>
249 </div>
250 <div class="footer">
251 &copy; Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
252 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
253 </div>
254 </body>
255</html>
Note: See TracBrowser for help on using the repository browser.