@ -1,4 +1,3 @@
<?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">
<!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" >
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< head >
@ -9,10 +8,11 @@
/*
/*
:Author: David Goodger (goodger@python.org)
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25 Z milde $
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07 Z milde $
:Copyright: This stylesheet has been placed in the public domain.
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
customize this style sheet.
@ -275,7 +275,7 @@ pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-left: 2em ;
margin-right: 2em }
margin-right: 2em }
pre.code .ln { color: gre y; } /* line numbers */
pre.code .ln { color: gra y; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@ -301,7 +301,7 @@ span.option {
span.pre {
span.pre {
white-space: pre }
white-space: pre }
span.problematic {
span.problematic, pre.problematic {
color: red }
color: red }
span.section-subtitle {
span.section-subtitle {
@ -367,31 +367,32 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:7e9c5ecf5d71e0cfb5e025e0cad0dfd5a91e659e56cfbb0ee1148b4158fb4309
!! source digest: sha256:d00d83d918ced79270057ca2a185260375834ac2e4526c7c5cb0fa745158aca6
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
< p > < a class = "reference external image-reference" 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 image-reference" 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 image-reference" href = "https://github.com/OCA/server-tools/tree/1 6 .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 image-reference" href = "https://translation.odoo-community.org/projects/server-tools-1 6-0/server-tools-16 -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 image-reference" href = "https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=1 6 .0"> < img alt = "Try me on Runboat" src = "https://img.shields.io/badge/runboat-Try%20me-875A7B.png" / > < / a > < / p >
< p > < a class = "reference external image-reference" 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 image-reference" 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 image-reference" href = "https://github.com/OCA/server-tools/tree/1 7 .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 image-reference" href = "https://translation.odoo-community.org/projects/server-tools-1 7-0/server-tools-17 -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 image-reference" href = "https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=1 7 .0"> < img alt = "Try me on Runboat" src = "https://img.shields.io/badge/runboat-Try%20me-875A7B.png" / > < / a > < / p >
< p > This module allows you to know ‘ how much code’ is running on your Odoo
< p > This module allows you to know ‘ how much code’ is running on your Odoo
instance, group by ‘ Type’ (Odoo Core, OCA, other…)< / p >
instance, group by ‘ Type’ (Odoo Core, OCA, other…)< / p >
< p > This module can be usefull in the following cases :< / p >
< p > This module can be usefull in the following cases :< / p >
< ul class = "simple" >
< ul class = "simple" >
< li > To analyse the size of your technical debt, regarding your Custom modules< / li >
< 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 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 the
< li > To evaluate the amount to pay to odoo to upgrade your custom code, or
induced workload< / li >
the induced workload< / li >
< / ul >
< / ul >
< img alt = " https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/ installed_modules_by_types.png " src = "https://raw.githubusercontent.com/OCA/server-tools/1 6 .0/module_analysis/static/description/installed_modules_by_types.png" / >
< p > < img alt = " installed_modules_by_types" src = "https://raw.githubusercontent.com/OCA/server-tools/1 7 .0/module_analysis/static/description/installed_modules_by_types.png" / > < / p >
< p > For that purpose, it adds new concepts< / p >
< p > For that purpose, it adds new concepts< / p >
< ul class = "simple" >
< 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 manifest
< li > < tt class = "docutils literal" > ir.module.author< / tt > , based on the value < tt class = "docutils literal" > author< / tt > present in the
file.< / li >
manifest file.< / li >
< / ul >
< / ul >
< img alt = " https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/ module_authors.png " src = "https://raw.githubusercontent.com/OCA/server-tools/1 6 .0/module_analysis/static/description/module_authors.png" / >
< p > < img alt = " module_authors" src = "https://raw.githubusercontent.com/OCA/server-tools/1 7 .0/module_analysis/static/description/module_authors.png" / > < / p >
< ul class = "simple" >
< ul class = "simple" >
< li > < tt class = "docutils literal" > ir.module.type< / tt > , populated by default with Odoo and OCA values.< / li >
< li > < tt class = "docutils literal" > ir.module.type< / tt > , populated by default with Odoo and OCA values.< / li >
< / ul >
< / ul >
< img alt = " https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/ module_types.png " src = "https://raw.githubusercontent.com/OCA/server-tools/1 6 .0/module_analysis/static/description/module_types.png" / >
< p > < img alt = " module_types" src = "https://raw.githubusercontent.com/OCA/server-tools/1 7 .0/module_analysis/static/description/module_types.png" / > < / p >
< p > Each installed modules have extra data in the ‘ Technical Data’ tab :< / p >
< p > Each installed modules have extra data in the ‘ Technical Data’ tab :< / p >
< img alt = " https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/ module_form.png " src = "https://raw.githubusercontent.com/OCA/server-tools/1 6 .0/module_analysis/static/description/module_form.png" / >
< p > < img alt = " module_form" src = "https://raw.githubusercontent.com/OCA/server-tools/1 7 .0/module_analysis/static/description/module_form.png" / > < / p >
< p > < strong > Table of contents< / strong > < / p >
< p > < strong > Table of contents< / strong > < / p >
< div class = "contents local topic" id = "contents" >
< div class = "contents local topic" id = "contents" >
< ul class = "simple" >
< ul class = "simple" >
@ -425,13 +426,11 @@ file.</li>
it information.< / p >
it information.< / p >
< p > This module comes with default rules.< / p >
< p > This module comes with default rules.< / p >
< blockquote >
< blockquote >
< img alt = "https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/default_module_type_rules.png" src = "https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/default_module_type_rules.png" / >
< img alt = "default_module_type_rules" src = "https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/default_module_type_rules.png" / > < / blockquote >
< / blockquote >
< p > You can add your custom rules to identify the modules your team have
< p > You can add your custom rules to identify the modules your team have
developped for exemple,< / p >
developped for exemple,< / p >
< blockquote >
< blockquote >
< img alt = "https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/add_module_type_rules.png" src = "https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/add_module_type_rules.png" / >
< img alt = "add_module_type_rules" src = "https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/add_module_type_rules.png" / > < / blockquote >
< / blockquote >
< p > to update the data manually, you have to :< / p >
< p > to update the data manually, you have to :< / p >
< ul class = "simple" >
< ul class = "simple" >
< li > Go to ‘ Settings’ / ‘ Technical’ / ‘ Scheduled Actions’ < / li >
< li > Go to ‘ Settings’ / ‘ Technical’ / ‘ Scheduled Actions’ < / li >
@ -441,23 +440,24 @@ developped for exemple,</p>
< p > to update the data automatically, you have to :< / p >
< p > to update the data automatically, you have to :< / p >
< ul class = "simple" >
< ul class = "simple" >
< li > Go to ‘ Settings’ / ‘ Technical’ / ‘ Scheduled Actions’ < / li >
< li > Go to ‘ Settings’ / ‘ Technical’ / ‘ Scheduled Actions’ < / li >
< li > Configure the action ‘ Update Module Analysis’ and activate it. (By default, the cron is unactive and no analysis is done)< / li >
< li > Configure the action ‘ Update Module Analysis’ and activate it. (By
default, the cron is unactive and no analysis is done)< / li >
< / ul >
< / ul >
< div class = "section" id = "adding-extra-data" >
< div class = "section" id = "adding-extra-data" >
< h2 > < a class = "toc-backref" href = "#toc-entry-3" > Adding Extra data< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#toc-entry-3" > Adding Extra data< / a > < / h2 >
< p > If you want to analyse other data, (for exemple, having the number of HTML
< p > If you want to analyse other data, (for exemple, having the number of
files), create a custom modules and overload the module model :< / p >
HTML files), create a custom modules and overload the module model :< / p >
< pre class = "code python literal-block" >
< 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 = "w" >
< span class = "kn" > from< / span > < span class = "w" > < / span > < span class = "nn" > odoo< / span > < span class = "w" > < / 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 = "w" >
< / 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 = "w" >
< / span > < span class = "k" > class< / span > < span class = "w" > < / 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 = "w" >
< / span > < span class = "n" > _inherit< / span > < span class = "o" > =< / span > < span class = "s1" > 'ir.module.module'< / span > < span class = "w" >
< / span > < span class = "n" > _inherit< / span > < span class = "o" > =< / span > < span class = "s1" > 'ir.module.module'< / span > < span class = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / span > < span class = "nd" > @ api< / span > < span class = "o" > .< / span > < span class = "n" > model< / span > < span class = "w" >
< / span > < span class = "nd" > @ api< / span > < span class = "o" > .< / span > < span class = "n" > model< / span > < span class = "w" >
< / 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 = "w" >
< / span > < span class = "k" > def< / span > < span class = "w" > < / span > < span class = "nf" > _get_analyse_settings< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span > < span class = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / 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 = "w" >
< / 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 = "w" >
@ -470,10 +470,9 @@ files), create a custom modules and overload the module model :</p>
< p > Two parameters are availaible in ‘ Settings’ / ‘ Technical’ / ‘ Parameters’
< p > Two parameters are availaible in ‘ Settings’ / ‘ Technical’ / ‘ Parameters’
‘ System Parameters’ :< / p >
‘ System Parameters’ :< / p >
< blockquote >
< blockquote >
< img alt = "https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/config_parameters.png" src = "https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/config_parameters.png" / >
< img alt = "config_parameters" src = "https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/config_parameters.png" / > < / blockquote >
< / blockquote >
< p > The list of folders and filename will be exclude from the analysis. You
< p > The list of folders and filename will be exclude from the analysis.
can change the default settings.< / p >
You can change the default settings.< / p >
< / div >
< / div >
< / div >
< / div >
< div class = "section" id = "usage" >
< div class = "section" id = "usage" >
@ -483,8 +482,8 @@ You can change the default settings.</p>
< / ul >
< / ul >
< p > Open the stats to analyse the detail of the code installed< / p >
< p > Open the stats to analyse the detail of the code installed< / p >
< blockquote >
< blockquote >
< img alt = " https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/ analysis_pivot.png " src = "https://raw.githubusercontent.com/OCA/server-tools/1 6 .0/module_analysis/static/description/analysis_pivot.png" / >
< p > < img alt = " analysis_pivot" src = "https://raw.githubusercontent.com/OCA/server-tools/1 7 .0/module_analysis/static/description/analysis_pivot.png" / > < / p >
< img alt = " https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/ analysis_pie.png " src = "https://raw.githubusercontent.com/OCA/server-tools/1 6 .0/module_analysis/static/description/analysis_pie.png" / >
< p > < img alt = " analysis_pie" src = "https://raw.githubusercontent.com/OCA/server-tools/1 7 .0/module_analysis/static/description/analysis_pie.png" / > < / p >
< / blockquote >
< / blockquote >
< / div >
< / div >
< div class = "section" id = "bug-tracker" >
< div class = "section" id = "bug-tracker" >
@ -492,7 +491,7 @@ You can change the default settings.</p>
< p > Bugs are tracked on < a class = "reference external" href = "https://github.com/OCA/server-tools/issues" > GitHub Issues< / a > .
< 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.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
If you spotted it first, help us to smash 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:%201 6 .0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**"> feedback< / a > .< / p >
< a class = "reference external" href = "https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%201 7 .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 >
< p > Do not contact contributors directly about support or help with technical issues.< / p >
< / div >
< / div >
< div class = "section" id = "credits" >
< div class = "section" id = "credits" >
@ -506,19 +505,22 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
< div class = "section" id = "contributors" >
< div class = "section" id = "contributors" >
< h2 > < a class = "toc-backref" href = "#toc-entry-9" > Contributors< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#toc-entry-9" > Contributors< / a > < / h2 >
< ul class = "simple" >
< ul class = "simple" >
< li > Sylvain LE GAL (< a class = "reference external" href = "https://twitter.com/legalsylvain" > https://twitter.com/legalsylvain< / a > )< / li >
< li > Sylvain LE GAL
(< a class = "reference external" href = "https://twitter.com/legalsylvain" > https://twitter.com/legalsylvain< / a > )< / li >
< / ul >
< / ul >
< / div >
< / div >
< div class = "section" id = "maintainers" >
< div class = "section" id = "maintainers" >
< h2 > < a class = "toc-backref" href = "#toc-entry-10" > Maintainers< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#toc-entry-10" > Maintainers< / a > < / h2 >
< p > This module is maintained by the OCA.< / p >
< 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 >
< 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 whose
< p > OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
mission is to support the collaborative development of Odoo features and
promote its widespread use.< / p >
promote its widespread use.< / p >
< p > Current < a class = "reference external" href = "https://odoo-community.org/page/maintainer-role" > maintainer< / a > :< / p >
< p > Current < a class = "reference external" href = "https://odoo-community.org/page/maintainer-role" > maintainer< / a > :< / p >
< p > < a class = "reference external image-reference" href = "https://github.com/legalsylvain" > < img alt = "legalsylvain" src = "https://github.com/legalsylvain.png?size=40px" / > < / a > < / p >
< p > < a class = "reference external image-reference" href = "https://github.com/legalsylvain" > < img alt = "legalsylvain" src = "https://github.com/legalsylvain.png?size=40px" / > < / a > < / p >
< p > This module is part of the < a class = "reference external" href = "https://github.com/OCA/server-tools/tree/1 6 .0/module_analysis"> OCA/server-tools< / a > project on GitHub.< / p >
< p > This module is part of the < a class = "reference external" href = "https://github.com/OCA/server-tools/tree/1 7 .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 >
< 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 >
< / div >