Changeset 16:cd4170142d87 in mailjam for docs/src/_build/html/install.html
- Timestamp:
- May 22, 2012, 9:31:15 AM (13 years ago)
- Branch:
- default
- Phase:
- public
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
docs/src/_build/html/install.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Installation instructions — Postman0.1.0 documentation</title>11 <title>Installation instructions — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 29 <link rel="next" title="Configuration" href="configuration.html" /> 30 <link rel="prev" title="Overview of postman’s architecture" href="overview.html" />30 <link rel="prev" title="Overview of mailjam’s architecture" href="overview.html" /> 31 31 </head> 32 32 <body> … … 41 41 accesskey="N">next</a> |</li> 42 42 <li class="right" > 43 <a href="overview.html" title="Overview of postman’s architecture"43 <a href="overview.html" title="Overview of mailjam’s architecture" 44 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>45 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 46 46 </ul> 47 47 </div> … … 59 59 <li><a class="reference internal" href="#installation-instructions" id="id3">Installation instructions</a><ul> 60 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>61 <li><a class="reference internal" href="#second-install-mailjam" id="id5">Second, install Mailjam</a><ul> 62 62 <li><a class="reference internal" href="#installing-using-pip" id="id6">Installing using pip</a></li> 63 63 <li><a class="reference internal" href="#installing-using-easy-install" id="id7">Installing using easy_install</a></li> … … 70 70 </ul> 71 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>72 <li><a class="reference internal" href="#setting-up-mailjam" id="id12">Setting up Mailjam</a></li> 73 <li><a class="reference internal" href="#running-mailjam" id="id13">Running Mailjam</a></li> 74 74 <li><a class="reference internal" href="#running-tests-developers-only" id="id14">Running tests (developers only)</a></li> 75 75 </ul> … … 79 79 <div class="section" id="first-install-dependencies"> 80 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 postmanis <a class="reference external" href="http://python.org">Python</a></p>82 <p> Postmanhas been tested with python <em>2.7.x</em>, but it should work with versions81 <p>So far, the only dependency you will need in order to run mailjam is <a class="reference external" href="http://python.org">Python</a></p> 82 <p>Mailjam has been tested with python <em>2.7.x</em>, but it should work with versions 83 83 <em>2.6.x</em> too.</p> 84 84 <p>Please, refer to your operating system package system documentation to learn 85 85 more about how to install python.</p> 86 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>87 <div class="section" id="second-install-mailjam"> 88 <span id="install-mailjam"></span><h2><a class="toc-backref" href="#id5">Second, install Mailjam</a><a class="headerlink" href="#second-install-mailjam" title="Permalink to this headline">¶</a></h2> 89 89 <div class="section" id="installing-using-pip"> 90 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 Postmanusing <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>91 <p>You can install Mailjam 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/mailjam#egg=mailjam</pre> 93 93 </div> 94 94 <div class="admonition note"> 95 95 <p class="first admonition-title">Note</p> 96 <p class="last"> Postmanhas not been recorded/uploaded to <a class="reference external" href="http://pypi.python.org/pypi">pypi</a> yet, so, in order to install97 it using pip you will have to provide the URL for the public Postmanrepo.</p>96 <p class="last">Mailjam has not been recorded/uploaded to <a class="reference external" href="http://pypi.python.org/pypi">pypi</a> yet, so, in order to install 97 it using pip you will have to provide the URL for the public Mailjam repo.</p> 98 98 </div> 99 99 </div> 100 100 <div class="section" id="installing-using-easy-install"> 101 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 Postmanusing <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> yet (until we do record/upload102 <p>You can not install Mailjam using <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> yet (until we do record/upload 103 103 it to pypi)</p> 104 104 </div> 105 105 <div class="section" id="installing-inside-a-virtualenv"> 106 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 Postmaninside a <a class="reference external" href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a>. Just create a virtualenv:</p>107 <p>You can install Mailjam inside a <a class="reference external" href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a>. Just create a virtualenv:</p> 108 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 109 </pre></div> … … 121 121 </div> 122 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>123 <p>And, once the environment has been activated, use pip to install Mailjam:</p> 124 <div class="highlight-python"><pre>env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam</pre> 125 125 </div> 126 126 </div> … … 136 136 <div class="section" id="from-repository"> 137 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 Postmanis 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 grab138 <p>The source code of Mailjam 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 139 139 the latest sources you need <a class="reference external" href="http://mercurial.selenic.com">Mercurial</a>.</p> 140 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>141 <div class="highlight-python"><pre>hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo</pre> 142 </div> 143 <p>Then, go inside the <em>mailjam-repo</em> directory and run:</p> 144 144 <div class="highlight-python"><pre>python setup.py install</pre> 145 145 </div> … … 157 157 </div> 158 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>159 <div class="section" id="setting-up-mailjam"> 160 <span id="install-setting-up-mailjam"></span><h2><a class="toc-backref" href="#id12">Setting up Mailjam</a><a class="headerlink" href="#setting-up-mailjam" title="Permalink to this headline">¶</a></h2> 161 161 <p>TBW</p> 162 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>163 <div class="section" id="running-mailjam"> 164 <span id="install-running-mailjam"></span><h2><a class="toc-backref" href="#id13">Running Mailjam</a><a class="headerlink" href="#running-mailjam" title="Permalink to this headline">¶</a></h2> 165 165 <p>TBW</p> 166 166 </div> … … 171 171 <colgroup><col class="label" /><col /></colgroup> 172 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>173 <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="https://bitbucket.org/codigo23/mailjam">https://bitbucket.org/codigo23/mailjam</a></td></tr> 174 174 </tbody> 175 175 </table> … … 187 187 <li><a class="reference internal" href="#">Installation instructions</a><ul> 188 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>189 <li><a class="reference internal" href="#second-install-mailjam">Second, install Mailjam</a><ul> 190 190 <li><a class="reference internal" href="#installing-using-pip">Installing using pip</a></li> 191 191 <li><a class="reference internal" href="#installing-using-easy-install">Installing using easy_install</a></li> … … 198 198 </ul> 199 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>200 <li><a class="reference internal" href="#setting-up-mailjam">Setting up Mailjam</a></li> 201 <li><a class="reference internal" href="#running-mailjam">Running Mailjam</a></li> 202 202 <li><a class="reference internal" href="#running-tests-developers-only">Running tests (developers only)</a></li> 203 203 </ul> … … 207 207 <h4>Previous topic</h4> 208 208 <p class="topless"><a href="overview.html" 209 title="previous chapter">Overview of postman’s architecture</a></p>209 title="previous chapter">Overview of mailjam’s architecture</a></p> 210 210 <h4>Next topic</h4> 211 211 <p class="topless"><a href="configuration.html" … … 243 243 >next</a> |</li> 244 244 <li class="right" > 245 <a href="overview.html" title="Overview of postman’s architecture"245 <a href="overview.html" title="Overview of mailjam’s architecture" 246 246 >previous</a> |</li> 247 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>247 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 248 248 </ul> 249 249 </div>
Note:
See TracChangeset
for help on using the changeset viewer.