Search 1.9 billion lines of Odoo code on GitHub
runbot_pylint
<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a name="runbot-pylint"></a>
<h2>Runbot pylint</h2>
<p>This module was written to extend the functionality of runbot to support pylint command
and allow you to check fails of lint.</p>
<p>You can select type of error to test, path to test, ignore files... from a git repo with pylint configuration files.</p>
<a name="installation"></a>
<h2>Installation</h2>
<p>To install this module, you need to:</p>
<ul class="simple">
<li>See main root README of this repository.</li>
<li>Install <cite>pylint</cite> package: <cite>pip install pylint</cite></li>
</ul>
<a name="configuration"></a>
<h2>Configuration</h2>
<p>To configure this module, you need to:</p>
<ul class="simple">
<li>Create a new repository git with your pylint conf file.</li>
<li>Create new <cite>runbot.repo</cite> record of your new repository git of pylint conf file.</li>
<li>Set relative path of your pylint conf file in <cite>runbot.repo</cite> in field <cite>pylint_conf</cite> and add in dependency repo your pylint repo.</li>
<li>Create a git repository with your pylint-conf file<ul>
<li><a class="reference external" href="https://github.com/Vauxoo/pylint-conf">repo example</a>.</li>
<li><a class="reference external" href="https://github.com/Vauxoo/pylint-conf/blob/master/conf/pylint_vauxoo_light.cfg">pylint conf file example</a>.</li>
</ul>
</li>
<li>Create a new record in runbot.repo with you pylint-conf repository link.<ul>
<li><a class="reference external" href="https://docs.google.com/file/d/0BwPeHBuUYqNsRS1xZjZzNmpyQlU/edit?usp=drivesdk">runbot.repository with pylint-conf</a>.</li>
</ul>
</li>
<li>Add to you main repo depends pylint-conf repo and add pylint-conf relative path and activate field check_pylint<ul>
<li><a class="reference external" href="https://docs.google.com/file/d/0BwPeHBuUYqNscmxadk8xYndNbjA/edit?usp=drivesdk">main repo configuration example</a>.</li>
</ul>
</li>
</ul>
<a name="usage"></a>
<h2>Usage</h2>
<p>To use this module, you need to:</p>
<ul class="simple">
<li>Wait a new build with previous configuration and review pylint log:<ul>
<li>Yellow example and button <a class="reference external" href="https://docs.google.com/file/d/0BwPeHBuUYqNsWUNzcktERDNRTm8/edit?usp=drivesdk">pylint log build</a>.</li>
</ul>
</li>
<li>Review pylint log txt file:<ul>
<li><a class="reference external" href="https://docs.google.com/file/d/0BwPeHBuUYqNseURZUGVwQUYtQ0U/edit?usp=drivesdk">pylint.log</a>.</li>
</ul>
</li>
<li>Review pylint log record:<ul>
<li><a class="reference external" href="https://docs.google.com/file/d/0BwPeHBuUYqNsX2xWU1BycHJkMlE/edit?usp=drivesdk">pylint log record example</a>.</li>
</ul>
</li>
</ul>
<p>For further information, please visit:</p>
<ul class="simple">
<li><a class="reference external" href="https://www.odoo.com/forum/help-1">https://www.odoo.com/forum/help-1</a></li>
</ul>
<a name="known-issues-roadmap"></a>
<h2>Known issues / Roadmap</h2>
<ul class="simple">
<li>(empty)</li>
</ul>
<a name="bug-tracker"></a>
<h2>Bug Tracker</h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/runbot-addons/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
<a class="reference external" href="https://github.com/OCA/runbot-addons/issues/new?body=module:%20runbot_pylint%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
<a name="credits"></a>
<h2>Credits</h2>
<a name="contributors"></a>
<h3>Contributors</h3>
<ul class="simple">
<li>Moises Lopez <<a class="reference external" href="mailto:moylop260@vauxoo.com">moylop260@vauxoo.com</a>></li>
</ul>
<a name="maintainer"></a>
<h3>Maintainer</h3>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="http://odoo-community.org">http://odoo-community.org</a>.</p>