<!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>Contributing guide — python-hpilo 2.8 documentation</title>
<link rel="stylesheet" href="_static/cloud.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.8',
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>
<script type="text/javascript" src="_static/jquery.cookie.js"></script>
<script type="text/javascript" src="_static/cloud.js"></script>
<link rel="top" title="python-hpilo 2.8 documentation" href="index.html" />
<link rel="prev" title="Common issues" href="troubleshooting.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<div class="relbar-top">
<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="troubleshooting.html" title="Common issues"
accesskey="P">previous</a> </li>
<li><a href="index.html">python-hpilo 2.8 documentation</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="contributing-guide">
<h1>Contributing guide<a class="headerlink" href="#contributing-guide" title="Permalink to this headline">¶</a></h1>
<p>python-hpilo is maintained by Dennis Kaarsemaker on <a class="reference external" href="https://github.com/seveas/python-hpilo">GitHub</a>. If you have a
problem with the software, that’s the place to file an issue. And if you want
to contribute to the project, that’s the place to go to as well.</p>
<p>Patches can be submitted as pull requests on github or mailed to
<a class="reference external" href="mailto:dennis%40kaarsemaker.net">dennis<span>@</span>kaarsemaker<span>.</span>net</a>. When you submit a patch, please make sure you test it
too. The test tool is built into hpilo.py, read the comments for the _test
function to find the details. When adding new methods, please add tests too.</p>
<div class="section" id="coding-guidelines">
<h2>Coding guidelines<a class="headerlink" href="#coding-guidelines" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>python-hpilo currently supports python 2.4 up to python 3.3. Any new code
needs to be compatible with all these versions. That means no <cite>with</cite>
statement, no <cite>sorted</cite> and using brackets for <cite>print()</cite>.</li>
<li><a class="reference external" href="http://www.python.org/dev/peps/pep-0008/">pep 8</a> is to be followed, except for the maximum line length rule. Be
reasonable with your line lengths though</li>
<li>All methods call into <tt class="xref py py-func docutils literal"><span class="pre">_info_tag()</span></tt> or <tt class="xref py py-func docutils literal"><span class="pre">_control_tag()</span></tt>. Any
new method must do so too, to be able to use it in <tt class="xref py py-meth docutils literal"><span class="pre">call_delayed()</span></tt>.</li>
<li>All new methods must be documented. A docstring is mandatory and will appear
in the docs. For methods that return data, sample output must be added to the
documentation too.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html" title="index">
<img class="logo" src="_static/lightbulb.png" alt="Logo"/>
</a></p><div class="sphinxlocaltoc">
<h3><a href="index.html">Page contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contributing guide</a><ul>
<li><a class="reference internal" href="#coding-guidelines">Coding guidelines</a></li>
</ul>
</li>
</ul>
</div>
<div class="sphinxprev">
<h4>Previous page</h4>
<p class="topless"><a href="troubleshooting.html"
title="Previous page">← Common issues</a></p>
</div>
<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="relbar-bottom">
<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="troubleshooting.html" title="Common issues"
>previous</a> </li>
<li><a href="index.html">python-hpilo 2.8 documentation</a> »</li>
</ul>
</div>
</div>
<div class="footer">
© Copyright 2011-2014, Dennis Kaarsemaker.
</div>
<!-- cloud_sptheme 1.4 -->
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
3a2887037f7441f622f09bf8edf799a4
>
files
>
18
