<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installing Pyro — Pyro 4.21 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.21',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Pyro 4.21 documentation" href="index.html" />
<link rel="next" title="Tutorial" href="tutorials.html" />
<link rel="prev" title="Intro and Example" href="intro.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="tutorials.html" title="Tutorial"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="intro.html" title="Intro and Example"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Pyro 4.21 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="installing-pyro">
<h1>Installing Pyro<a class="headerlink" href="#installing-pyro" title="Permalink to this headline">¶</a></h1>
<p>This chapter will show how to obtain and install Pyro.</p>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>You need Python 2.6 or newer for Pyro4.
Also see <a class="reference internal" href="upgrading.html#should-i-choose-pyro4"><em>Should I choose Pyro4?</em></a>.</p>
<p>Pyro is written in 100% pure Python. It works on any recent operating system.</p>
<p>It will default to using the <a class="reference external" href="https://pypi.python.org/pypi/serpent">serpent</a> serializer so you
will need to install Serpent as well, unless you configure Pyro to use one of the other serializers.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">When Pyro is configured to use pickle or marshal as its serialization format, it is required to have the same <em>major</em> Python versions
on your clients and your servers. Otherwise the different parties cannot decipher each others serialized data.
This means you cannot let Python 2.x talk to Python 3.x with Pyro. However
it should be fine to have Python 2.6.2 talk to Python 2.7.3 for instance.
Using one of the implementation independent protocols (serpent or json) will avoid this limitation.</p>
</div>
</div>
<div class="section" id="obtaining-and-installing-pyro">
<h2>Obtaining and installing Pyro<a class="headerlink" href="#obtaining-and-installing-pyro" title="Permalink to this headline">¶</a></h2>
<p>Pyro can be found on the Python package index: <a class="reference external" href="http://pypi.python.org/pypi/Pyro4/">http://pypi.python.org/pypi/Pyro4/</a> (package name <tt class="docutils literal"><span class="pre">Pyro4</span></tt>)</p>
<p>You can install it using <strong class="command">pip</strong> or <strong class="command">easy_install</strong>, or download the distribution archive (.tar.gz)
from Pypi and run the <tt class="docutils literal"><span class="pre">setup.py</span></tt> script from that manually.
Pyro installs as the <tt class="docutils literal"><span class="pre">Pyro4</span></tt> package with a couple of sub modules that you usually don’t have to access directly.
The <a class="reference external" href="https://pypi.python.org/pypi/serpent">serpent</a> serialization library is installed as a dependency.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Windows users: use one of the suggested tools to install Pyro.
If you decide to get the distribution archive (.tar.gz) and use that,
one way to extract it is to use the (free) <a class="reference external" href="http://www.7-zip.org">7-zip</a> archive utility.</p>
</div>
<p>If you want you can also obtain the source directly from Github: <a class="reference external" href="https://github.com/irmen/Pyro4">https://github.com/irmen/Pyro4</a></p>
</div>
<div class="section" id="stuff-you-get-in-the-distribution-archive">
<h2>Stuff you get in the distribution archive<a class="headerlink" href="#stuff-you-get-in-the-distribution-archive" title="Permalink to this headline">¶</a></h2>
<p>If you decide to download the distribution (.tar.gz) you have a bunch of extras over installing Pyro directly.
It contains:</p>
<blockquote>
<div><dl class="docutils">
<dt>docs/</dt>
<dd>the Sphinx/RST sources for this manual</dd>
<dt>examples/</dt>
<dd>dozens of examples that demonstrate various Pyro features (highly recommended)</dd>
<dt>tests/</dt>
<dd>all unit tests</dd>
<dt>src/</dt>
<dd>The library source code (only this part is installed if you install the <tt class="docutils literal"><span class="pre">Pyro4</span></tt> package)</dd>
<dt>and a couple of other files:</dt>
<dd>a setup script and other miscellaneous files such as the license (see <a class="reference internal" href="license.html"><em>Software License and Disclaimer</em></a>).</dd>
</dl>
</div></blockquote>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/pyro.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installing Pyro</a><ul>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#obtaining-and-installing-pyro">Obtaining and installing Pyro</a></li>
<li><a class="reference internal" href="#stuff-you-get-in-the-distribution-archive">Stuff you get in the distribution archive</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="intro.html"
title="previous chapter">Intro and Example</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="tutorials.html"
title="next chapter">Tutorial</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="tutorials.html" title="Tutorial"
>next</a> |</li>
<li class="right" >
<a href="intro.html" title="Intro and Example"
>previous</a> |</li>
<li><a href="index.html">Pyro 4.21 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Irmen de Jong.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
