Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / packaging / sources / reclass / refs/heads/gh-pages / . / install.html
blob: 96f568988df98af8dd680aa99f6a9278ea317280 [file] [log] [blame]
martin f. krafft3cd2a332014-10-28 15:58:23 +0100[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
9 <title>Installation &mdash; reclass 1.4.1 documentation</title>
10
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: './',
17 VERSION: '1.4.1',
18 COLLAPSE_INDEX: false,
19 FILE_SUFFIX: '.html',
20 HAS_SOURCE: true
21 };
22 </script>
23 <script type="text/javascript" src="_static/jquery.js"></script>
24 <script type="text/javascript" src="_static/underscore.js"></script>
25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <link rel="top" title="reclass 1.4.1 documentation" href="index.html" />
27 <link rel="next" title="reclass concepts" href="concepts.html" />
28 <link rel="prev" title="reclass — Recursive external node classification" href="index.html" />
29 </head>
30 <body>
31 <div class="related">
32 <h3>Navigation</h3>
33 <ul>
34 <li class="right" style="margin-right: 10px">
35 <a href="genindex.html" title="General Index"
36 accesskey="I">index</a></li>
37 <li class="right" >
38 <a href="concepts.html" title="reclass concepts"
39 accesskey="N">next</a> |</li>
40 <li class="right" >
41 <a href="index.html" title="reclass — Recursive external node classification"
42 accesskey="P">previous</a> |</li>
43 <li><a href="index.html">reclass</a> &raquo;</li>
44 </ul>
45 </div>
46
47 <div class="document">
48 <div class="documentwrapper">
49 <div class="bodywrapper">
50 <div class="body">
51
52 <div class="section" id="installation">
53<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
54<div class="section" id="for-debian-users-including-ubuntu">
55<h2>For Debian users (including Ubuntu)<a class="headerlink" href="#for-debian-users-including-ubuntu" title="Permalink to this headline"></a></h2>
56<p><strong>reclass</strong> has been <a class="reference external" href="http://packages.debian.org/search?keywords=reclass">packaged for Debian</a>. To use it, just install it with
57APT:</p>
58<div class="highlight-python"><div class="highlight"><pre>$ apt-get install reclass [reclass-doc]
59</pre></div>
60</div>
61</div>
62<div class="section" id="for-archlinux-users">
63<h2>For ArchLinux users<a class="headerlink" href="#for-archlinux-users" title="Permalink to this headline"></a></h2>
64<p><strong>reclass</strong> is <a class="reference external" href="https://aur.archlinux.org/packages/reclass-git/">available for ArchLinux</a>, thanks to Niels Abspoel.
65Dowload the <a class="reference external" href="https://aur.archlinux.org/packages/re/reclass-git/reclass-git.tar.gz">tarball</a> from <tt class="docutils literal"><span class="pre">aur</span></tt> or <tt class="docutils literal"><span class="pre">yaourt</span></tt>:</p>
66<div class="highlight-python"><div class="highlight"><pre>$ yaourt -S reclass
67</pre></div>
68</div>
69<p>or:</p>
70<div class="highlight-python"><div class="highlight"><pre>$ tar xvzf reclass-git.tar.gz
71$ cd reclass-git; makepkg
72$ sudo pacman -U reclass-git-&lt;git-commit-hash&gt;.tar.gz
73</pre></div>
74</div>
75</div>
76<div class="section" id="other-distributions">
77<h2>Other distributions<a class="headerlink" href="#other-distributions" title="Permalink to this headline"></a></h2>
78<p>Developers of other distributions are cordially invited to package <strong>reclass</strong>
79themselves and <a class="reference external" href="mailto:reclass&#37;&#52;&#48;pantsfullofunix&#46;net">write to the mailing list</a> to have details included here. Or send
80a patch!</p>
81</div>
82<div class="section" id="from-source">
83<h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline"></a></h2>
84<p><strong>reclass</strong> is currently maintained <a class="reference external" href="http://github.com/madduck/reclass">on Github</a>, so to obtain the source, run:</p>
85<div class="highlight-python"><div class="highlight"><pre>$ git clone https://github.com/madduck/reclass.git
86</pre></div>
87</div>
88<p>or:</p>
89<div class="highlight-python"><div class="highlight"><pre>$ git clone ssh://git@github.com:madduck/reclass.git
90</pre></div>
91</div>
92<p>If you want a tarball, please <a class="reference external" href="http://http.debian.net/debian/pool/main/r/reclass/">obtain it from the Debian archive</a>.</p>
93<p>Before you can use <strong>reclass</strong>, you need to install it into a place where Python
94can find it. The following step should install the package to <tt class="docutils literal"><span class="pre">/usr/local</span></tt>:</p>
95<div class="highlight-python"><div class="highlight"><pre>$ python setup.py install
96</pre></div>
97</div>
98<p>If you want to install to a different location, use &#8211;prefix like so:</p>
99<div class="highlight-python"><div class="highlight"><pre>$ python setup.py install --prefix=/opt/local
100</pre></div>
101</div>
102<p>Just make sure that the destination is in the Python module search path, which
103you can check like this:</p>
104<div class="highlight-python"><div class="highlight"><pre>$ python -c &#39;import sys; print sys.path&#39;
105</pre></div>
106</div>
107<p>More options can be found in the output of</p>
108<div class="highlight-python"><div class="highlight"><pre>$ python setup.py install --help
109$ python setup.py --help
110$ python setup.py --help-commands
111$ python setup.py --help [cmd]
112</pre></div>
113</div>
114<p>If you just want to run <strong>reclass</strong> from source, e.g. because you are going to be
115making and testing changes, install it in &#8220;development mode&#8221;:</p>
116<div class="highlight-python"><div class="highlight"><pre>$ python setup.py develop
117</pre></div>
118</div>
119<p>To uninstall (the rm call is necessary due to <a class="reference external" href="http://bugs.debian.org/714960">a bug in setuptools</a>):</p>
120<div class="highlight-python"><div class="highlight"><pre>$ python setup.py develop --uninstall
121$ rm /usr/local/bin/reclass*
122</pre></div>
123</div>
124<p><a class="reference external" href="http://bugs.python.org/issue4673">Uninstallation currently isn&#8217;t possible</a> for packages installed to
125/usr/local as per the above method, unfortunately. The following should do:</p>
126<div class="highlight-python"><div class="highlight"><pre>$ rm -r /usr/local/lib/python*/dist-packages/reclass* /usr/local/bin/reclass*
127</pre></div>
128</div>
129</div>
130</div>
131
132
133 </div>
134 </div>
135 </div>
136 <div class="sphinxsidebar">
137 <div class="sphinxsidebarwrapper">
138 <h3><a href="index.html">Table Of Contents</a></h3>
139 <ul>
140<li><a class="reference internal" href="#">Installation</a><ul>
141<li><a class="reference internal" href="#for-debian-users-including-ubuntu">For Debian users (including Ubuntu)</a></li>
142<li><a class="reference internal" href="#for-archlinux-users">For ArchLinux users</a></li>
143<li><a class="reference internal" href="#other-distributions">Other distributions</a></li>
144<li><a class="reference internal" href="#from-source">From source</a></li>
145</ul>
146</li>
147</ul>
148
149 <h4>Previous topic</h4>
150 <p class="topless"><a href="index.html"
151 title="previous chapter">reclass — Recursive external node classification</a></p>
152 <h4>Next topic</h4>
153 <p class="topless"><a href="concepts.html"
154 title="next chapter">reclass concepts</a></p>
155<div id="searchbox" style="display: none">
156 <h3>Quick search</h3>
157 <form class="search" action="search.html" method="get">
158 <input type="text" name="q" />
159 <input type="submit" value="Go" />
160 <input type="hidden" name="check_keywords" value="yes" />
161 <input type="hidden" name="area" value="default" />
162 </form>
163 <p class="searchtip" style="font-size: 90%">
164 Enter search terms or a module, class or function name.
165 </p>
166</div>
167<script type="text/javascript">$('#searchbox').show(0);</script>
168 </div>
169 </div>
170 <div class="clearer"></div>
171 </div>
172 <div class="related">
173 <h3>Navigation</h3>
174 <ul>
175 <li class="right" style="margin-right: 10px">
176 <a href="genindex.html" title="General Index"
177 >index</a></li>
178 <li class="right" >
179 <a href="concepts.html" title="reclass concepts"
180 >next</a> |</li>
181 <li class="right" >
182 <a href="index.html" title="reclass — Recursive external node classification"
183 >previous</a> |</li>
184 <li><a href="index.html">reclass</a> &raquo;</li>
185 </ul>
186 </div>
187 <div class="footer">
188 &copy; Copyright 2013, martin f. krafft.
189 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
190 </div>
191 </body>
192</html>