|
|
<?xml version="1.0" encoding="utf-8" ?><!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" xml:lang="en" lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" /><title>Module Analysis</title><style type="text/css">
/*:Author: David Goodger (goodger@python.org):Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how tocustomize this style sheet.*/
/* used to remove borders from tables and images */.borderless, table.borderless td, table.borderless th { border: 0 }
table.borderless td, table.borderless th { /* Override padding for "table.docutils td" with "! important". The right padding separates the table cells. */ padding: 0 0.5em 0 0 ! important }
.first { /* Override more specific margin styles with "! important". */ margin-top: 0 ! important }
.last, .with-subtitle { margin-bottom: 0 ! important }
.hidden { display: none }
.subscript { vertical-align: sub; font-size: smaller }
.superscript { vertical-align: super; font-size: smaller }
a.toc-backref { text-decoration: none ; color: black }
blockquote.epigraph { margin: 2em 5em ; }
dl.docutils dd { margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { overflow: hidden;}
/* Uncomment (and remove this text!) to get bold-faced definition list termsdl.docutils dt { font-weight: bold }*/
div.abstract { margin: 2em 5em }
div.abstract p.topic-title { font-weight: bold ; text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,div.hint, div.important, div.note, div.tip, div.warning { margin: 2em ; border: medium outset ; padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,div.important p.admonition-title, div.note p.admonition-title,div.tip p.admonition-title { font-weight: bold ; font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,div.danger p.admonition-title, div.error p.admonition-title,div.warning p.admonition-title, .code .error { color: red ; font-weight: bold ; font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in compound paragraphs.div.compound .compound-first, div.compound .compound-middle { margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle { margin-top: 0.5em }*/
div.dedication { margin: 2em 5em ; text-align: center ; font-style: italic }
div.dedication p.topic-title { font-weight: bold ; font-style: normal }
div.figure { margin-left: 2em ; margin-right: 2em }
div.footer, div.header { clear: both; font-size: smaller }
div.line-block { display: block ; margin-top: 1em ; margin-bottom: 1em }
div.line-block div.line-block { margin-top: 0 ; margin-bottom: 0 ; margin-left: 1.5em }
div.sidebar { margin: 0 0 0.5em 1em ; border: medium outset ; padding: 1em ; background-color: #ffffee ; width: 40% ; float: right ; clear: right }
div.sidebar p.rubric { font-family: sans-serif ; font-size: medium }
div.system-messages { margin: 5em }
div.system-messages h1 { color: red }
div.system-message { border: medium outset ; padding: 1em }
div.system-message p.system-message-title { color: red ; font-weight: bold }
div.topic { margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { margin-top: 0.4em }
h1.title { text-align: center }
h2.subtitle { text-align: center }
hr.docutils { width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left { clear: left ; float: left ; margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right { clear: right ; float: right ; margin-left: 1em }
img.align-center, .figure.align-center, object.align-center { display: block; margin-left: auto; margin-right: auto;}
table.align-center { margin-left: auto; margin-right: auto;}
.align-left { text-align: left }
.align-center { clear: both ; text-align: center }
.align-right { text-align: right }
/* reset inner alignment in figures */div.align-right { text-align: inherit }
/* div.align-center * { *//* text-align: left } */
.align-top { vertical-align: top }
.align-middle { vertical-align: middle }
.align-bottom { vertical-align: bottom }
ol.simple, ul.simple { margin-bottom: 1em }
ol.arabic { list-style: decimal }
ol.loweralpha { list-style: lower-alpha }
ol.upperalpha { list-style: upper-alpha }
ol.lowerroman { list-style: lower-roman }
ol.upperroman { list-style: upper-roman }
p.attribution { text-align: right ; margin-left: 50% }
p.caption { font-style: italic }
p.credits { font-style: italic ; font-size: smaller }
p.label { white-space: nowrap }
p.rubric { font-weight: bold ; font-size: larger ; color: maroon ; text-align: center }
p.sidebar-title { font-family: sans-serif ; font-weight: bold ; font-size: larger }
p.sidebar-subtitle { font-family: sans-serif ; font-weight: bold }
p.topic-title { font-weight: bold }
pre.address { margin-bottom: 0 ; margin-top: 0 ; font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code { margin-left: 2em ; margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */pre.code, code { background-color: #eeeeee }pre.code .comment, code .comment { color: #5C6576 }pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }pre.code .literal.string, code .literal.string { color: #0C5404 }pre.code .name.builtin, code .name.builtin { color: #352B84 }pre.code .deleted, code .deleted { background-color: #DEB0A1}pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier { font-family: sans-serif ; font-style: oblique }
span.classifier-delimiter { font-family: sans-serif ; font-weight: bold }
span.interpreted { font-family: sans-serif }
span.option { white-space: nowrap }
span.pre { white-space: pre }
span.problematic { color: red }
span.section-subtitle { /* font-size relative to parent (h1..h6 element) */ font-size: 80% }
table.citation { border-left: solid 1px gray; margin-left: 1px }
table.docinfo { margin: 2em 4em }
table.docutils { margin-top: 0.5em ; margin-bottom: 0.5em }
table.footnote { border-left: solid 1px black; margin-left: 1px }
table.docutils td, table.docutils th,table.docinfo td, table.docinfo th { padding-left: 0.5em ; padding-right: 0.5em ; vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name { font-weight: bold ; text-align: left ; white-space: nowrap ; padding-left: 0 }
/* "booktabs" style (no vertical lines) */table.docutils.booktabs { border: 0px; border-top: 2px solid; border-bottom: 2px solid; border-collapse: collapse;}table.docutils.booktabs * { border: 0px;}table.docutils.booktabs th { border-bottom: thin solid; text-align: left;}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { font-size: 100% }
ul.auto-toc { list-style-type: none }
</style></head><body><div class="document" id="module-analysis"><h1 class="title">Module Analysis</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!!! changes will be overwritten. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --><p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/module_analysis"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-module_analysis"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p><p>This module allows you to know ‘how much code’ is running on your Odooinstance, group by ‘Type’ (Odoo Core, OCA, other…)</p><p>This module can be usefull in the following cases :</p><ul class="simple"><li>To analyse the size of your technical debt, regarding your Custom modules</li><li>To know the ratio between Odoo / OCA and Custom modules</li><li>To evaluate the amount to pay to odoo to upgrade your custom code, or theinduced workload</li></ul><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/installed_modules_by_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/installed_modules_by_types.png" /><p>For that purpose, it adds new concepts</p><ul class="simple"><li><tt class="docutils literal">ir.module.author</tt>, based on the value <tt class="docutils literal">author</tt> present in the manifestfile.</li></ul><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png" /><ul class="simple"><li><tt class="docutils literal">ir.module.type</tt>, populated by default with Odoo and OCA values.</li></ul><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png" /><p>Each installed modules have extra data in the ‘Technical Data’ tab :</p><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_form.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_form.png" /><p><strong>Table of contents</strong></p><div class="contents local topic" id="contents"><ul class="simple"><li><a class="reference internal" href="#installation" id="id1">Installation</a></li><li><a class="reference internal" href="#configuration" id="id2">Configuration</a><ul><li><a class="reference internal" href="#adding-extra-data" id="id3">Adding Extra data</a></li><li><a class="reference internal" href="#exclude-files-and-directories" id="id4">Exclude files and directories</a></li></ul></li><li><a class="reference internal" href="#usage" id="id5">Usage</a></li><li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li><li><a class="reference internal" href="#credits" id="id7">Credits</a><ul><li><a class="reference internal" href="#authors" id="id8">Authors</a></li><li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li><li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li></ul></li></ul></div><div class="section" id="installation"><h1><a class="toc-backref" href="#id1">Installation</a></h1><p>To use this module, you have to install the <tt class="docutils literal">pygount</tt> python librairy.</p><p><tt class="docutils literal">pip install pygount</tt></p></div><div class="section" id="configuration"><h1><a class="toc-backref" href="#id2">Configuration</a></h1><ul class="simple"><li>Go to Apps / Module Analysis / Modules Types Rules</li></ul><p>The Module types Rules are usefull to get the Type of a module, based onit information.</p><p>This module comes with default rules.</p><blockquote><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png" /></blockquote><p>You can add your custom rules to identify the modules your team havedevelopped for exemple,</p><blockquote><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png" /></blockquote><p>to update the data, you have to :</p><ul><li><p class="first">Go to ‘Apps’ / ‘Update Apps List’</p></li><li><p class="first">Check the box ‘Analyse Installed modules’</p><blockquote><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png" /></blockquote></li></ul><p>This will update analysis of your installed modules.</p><div class="section" id="adding-extra-data"><h2><a class="toc-backref" href="#id3">Adding Extra data</a></h2><p>If you want to analyse other data, (for exemple, having the number of HTMLfiles), create a custom modules and overload the module model :</p><pre class="code python literal-block"><span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">api</span><span class="p">,</span> <span class="n">fields</span><span class="p">,</span> <span class="n">models</span>
<span class="k">class</span> <span class="nc">IrModuleModule</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span> <span class="n">_inherit</span> <span class="o">=</span> <span class="s1">'ir.module.module'</span>
<span class="n">xml_documentation_qty</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Integer</span><span class="p">(</span> <span class="n">string</span><span class="o">=</span><span class="s1">'Quantity of Comments in XML Files'</span><span class="p">)</span>
<span class="nd">@api.model</span> <span class="k">def</span> <span class="nf">_get_analyse_settings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="n">res</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_get_analyse_settings</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="s1">'.html'</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span> <span class="n">res</span><span class="p">[</span><span class="s1">'.html'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span> <span class="n">res</span><span class="p">[</span><span class="s1">'.html'</span><span class="p">][</span><span class="s1">'documentation'</span><span class="p">]</span> <span class="s1">'xml_documentation_qty'</span> <span class="k">return</span> <span class="n">res</span></pre></div><div class="section" id="exclude-files-and-directories"><h2><a class="toc-backref" href="#id4">Exclude files and directories</a></h2><p>Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’‘System Parameters’ :</p><blockquote><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/config_parameters.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/config_parameters.png" /></blockquote><p>The list of folders and filename will be exclude from the analysis.You can change the default settings.</p></div></div><div class="section" id="usage"><h1><a class="toc-backref" href="#id5">Usage</a></h1><ul class="simple"><li>Go to ‘Apps’ / ‘Module Analysis’ / ‘Installed module by Types’</li></ul><p>Open the stats to analyse the detail of the code installed</p><blockquote><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png" /><img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pie.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pie.png" /></blockquote></div><div class="section" id="bug-tracker"><h1><a class="toc-backref" href="#id6">Bug Tracker</a></h1><p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/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<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p><p>Do not contact contributors directly about support or help with technical issues.</p></div><div class="section" id="credits"><h1><a class="toc-backref" href="#id7">Credits</a></h1><div class="section" id="authors"><h2><a class="toc-backref" href="#id8">Authors</a></h2><ul class="simple"><li>GRAP</li></ul></div><div class="section" id="contributors"><h2><a class="toc-backref" href="#id9">Contributors</a></h2><ul class="simple"><li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li></ul></div><div class="section" id="maintainers"><h2><a class="toc-backref" href="#id10">Maintainers</a></h2><p>This module is maintained by the OCA.</p><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>OCA, or the Odoo Community Association, is a nonprofit organization whosemission is to support the collaborative development of Odoo features andpromote its widespread use.</p><p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/module_analysis">OCA/server-tools</a> project on GitHub.</p><p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p></div></div></div></body></html>
|
