Ignore:
Timestamp:
May 22, 2012, 9:31:15 AM (12 years ago)
Author:
Borja Lopez <borja@…>
Branch:
default
Phase:
public
Message:

Renamed the project to Mailjam

File:
1 edited

Legend:

Unmodified
Added
Removed
  • docs/src/_build/html/install.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Installation instructions &mdash; Postman 0.1.0 documentation</title>
     11    <title>Installation instructions &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
     
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     28    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    2929    <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" />
    3131  </head>
    3232  <body>
     
    4141             accesskey="N">next</a> |</li>
    4242        <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"
    4444             accesskey="P">previous</a> |</li>
    45         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     45        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4646      </ul>
    4747    </div> 
     
    5959<li><a class="reference internal" href="#installation-instructions" id="id3">Installation instructions</a><ul>
    6060<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>
    6262<li><a class="reference internal" href="#installing-using-pip" id="id6">Installing using pip</a></li>
    6363<li><a class="reference internal" href="#installing-using-easy-install" id="id7">Installing using easy_install</a></li>
     
    7070</ul>
    7171</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>
    7474<li><a class="reference internal" href="#running-tests-developers-only" id="id14">Running tests (developers only)</a></li>
    7575</ul>
     
    7979<div class="section" id="first-install-dependencies">
    8080<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
     81<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
    8383<em>2.6.x</em> too.</p>
    8484<p>Please, refer to your operating system package system documentation to learn
    8585more about how to install python.</p>
    8686</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>
    8989<div class="section" id="installing-using-pip">
    9090<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>
     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>
    9393</div>
    9494<div class="admonition note">
    9595<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
    97 it using pip you will have to provide the URL for the public Postman repo.</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
     97it using pip you will have to provide the URL for the public Mailjam repo.</p>
    9898</div>
    9999</div>
    100100<div class="section" id="installing-using-easy-install">
    101101<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
     102<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
    103103it to pypi)</p>
    104104</div>
    105105<div class="section" id="installing-inside-a-virtualenv">
    106106<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>
     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>
    108108<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>
    109109</pre></div>
     
    121121</div>
    122122</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>
    125125</div>
    126126</div>
     
    136136<div class="section" id="from-repository">
    137137<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
     138<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
    139139the latest sources you need <a class="reference external" href="http://mercurial.selenic.com">Mercurial</a>.</p>
    140140<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>
    144144<div class="highlight-python"><pre>python setup.py install</pre>
    145145</div>
     
    157157</div>
    158158</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>
    161161<p>TBW</p>
    162162</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>
    165165<p>TBW</p>
    166166</div>
     
    171171<colgroup><col class="label" /><col /></colgroup>
    172172<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>
    174174</tbody>
    175175</table>
     
    187187<li><a class="reference internal" href="#">Installation instructions</a><ul>
    188188<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>
    190190<li><a class="reference internal" href="#installing-using-pip">Installing using pip</a></li>
    191191<li><a class="reference internal" href="#installing-using-easy-install">Installing using easy_install</a></li>
     
    198198</ul>
    199199</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>
    202202<li><a class="reference internal" href="#running-tests-developers-only">Running tests (developers only)</a></li>
    203203</ul>
     
    207207  <h4>Previous topic</h4>
    208208  <p class="topless"><a href="overview.html"
    209                         title="previous chapter">Overview of postman&#8217;s architecture</a></p>
     209                        title="previous chapter">Overview of mailjam&#8217;s architecture</a></p>
    210210  <h4>Next topic</h4>
    211211  <p class="topless"><a href="configuration.html"
     
    243243             >next</a> |</li>
    244244        <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"
    246246             >previous</a> |</li>
    247         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     247        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    248248      </ul>
    249249    </div>
Note: See TracChangeset for help on using the changeset viewer.