diff --git a/module_analysis/README.rst b/module_analysis/README.rst index 9d30fbe9b..62d23eb1c 100644 --- a/module_analysis/README.rst +++ b/module_analysis/README.rst @@ -2,7 +2,7 @@ Module Analysis =============== -.. +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! @@ -39,27 +39,27 @@ This module can be usefull in the following cases : - To evaluate the amount to pay to odoo to upgrade your custom code, or the induced workload -|image| +|installed_modules_by_types| For that purpose, it adds new concepts - ``ir.module.author``, based on the value ``author`` present in the manifest file. -|image1| +|module_authors| - ``ir.module.type``, populated by default with Odoo and OCA values. -|image2| +|module_types| Each installed modules have extra data in the 'Technical Data' tab : -|image3| +|module_form| -.. |image| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/installed_modules_by_types.png -.. |image1| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_authors.png -.. |image2| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_types.png -.. |image3| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_form.png +.. |installed_modules_by_types| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/installed_modules_by_types.png +.. |module_authors| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_authors.png +.. |module_types| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_types.png +.. |module_form| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_form.png **Table of contents** @@ -83,12 +83,12 @@ it information. This module comes with default rules. - |image4| + |default_module_type_rules| You can add your custom rules to identify the modules your team have developped for exemple, - |image5| + |add_module_type_rules| to update the data manually, you have to : @@ -133,14 +133,14 @@ Exclude files and directories Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters' 'System Parameters' : - |image6| + |config_parameters| The list of folders and filename will be exclude from the analysis. You can change the default settings. -.. |image4| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/default_module_type_rules.png -.. |image5| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/add_module_type_rules.png -.. |image6| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/config_parameters.png +.. |default_module_type_rules| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/default_module_type_rules.png +.. |add_module_type_rules| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/add_module_type_rules.png +.. |config_parameters| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/config_parameters.png Usage ===== @@ -149,12 +149,12 @@ Usage Open the stats to analyse the detail of the code installed - |image7| + |analysis_pivot| - |image8| + |analysis_pie| -.. |image7| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/analysis_pivot.png -.. |image8| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/analysis_pie.png +.. |analysis_pivot| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/analysis_pivot.png +.. |analysis_pie| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/analysis_pie.png Bug Tracker =========== @@ -177,7 +177,8 @@ Authors Contributors ------------ -- Sylvain LE GAL (https://twitter.com/legalsylvain) +- Sylvain LE GAL + (`https://twitter.com/legalsylvain `__) Maintainers ----------- @@ -198,7 +199,7 @@ promote its widespread use. Current `maintainer `__: -|maintainer-legalsylvain| +|maintainer-legalsylvain| This module is part of the `OCA/server-tools `_ project on GitHub. diff --git a/module_analysis/__manifest__.py b/module_analysis/__manifest__.py index b94818f7d..3380b2568 100644 --- a/module_analysis/__manifest__.py +++ b/module_analysis/__manifest__.py @@ -27,7 +27,7 @@ "data/ir_cron.xml", ], "external_dependencies": { - "python": ["pygount"], + "python": ["pygount==1.4.0"], }, "installable": True, } diff --git a/module_analysis/readme/CONFIGURE.md b/module_analysis/readme/CONFIGURE.md index 2c3893e1f..5f3457ec8 100644 --- a/module_analysis/readme/CONFIGURE.md +++ b/module_analysis/readme/CONFIGURE.md @@ -5,12 +5,12 @@ it information. This module comes with default rules. -> ![image](../static/description/default_module_type_rules.png) +> ![default_module_type_rules](../static/description/default_module_type_rules.png) You can add your custom rules to identify the modules your team have developped for exemple, -> ![image](../static/description/add_module_type_rules.png) +> ![add_module_type_rules](../static/description/add_module_type_rules.png) to update the data manually, you have to : @@ -53,7 +53,7 @@ class IrModuleModule(models.Model): Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters' 'System Parameters' : -> ![image](../static/description/config_parameters.png) +> ![config_parameters](../static/description/config_parameters.png) The list of folders and filename will be exclude from the analysis. You can change the default settings. diff --git a/module_analysis/readme/DESCRIPTION.md b/module_analysis/readme/DESCRIPTION.md index b852e9c10..8680a2fef 100644 --- a/module_analysis/readme/DESCRIPTION.md +++ b/module_analysis/readme/DESCRIPTION.md @@ -9,19 +9,19 @@ This module can be usefull in the following cases : - To evaluate the amount to pay to odoo to upgrade your custom code, or the induced workload -![image](../static/description/installed_modules_by_types.png) +![installed_modules_by_types](../static/description/installed_modules_by_types.png) For that purpose, it adds new concepts - `ir.module.author`, based on the value `author` present in the manifest file. -![image](../static/description/module_authors.png) +![module_authors](../static/description/module_authors.png) - `ir.module.type`, populated by default with Odoo and OCA values. -![image](../static/description/module_types.png) +![module_types](../static/description/module_types.png) Each installed modules have extra data in the 'Technical Data' tab : -![image](../static/description/module_form.png) +![module_form](../static/description/module_form.png) diff --git a/module_analysis/readme/USAGE.md b/module_analysis/readme/USAGE.md index 1c41e5269..1cc8428ba 100644 --- a/module_analysis/readme/USAGE.md +++ b/module_analysis/readme/USAGE.md @@ -2,6 +2,6 @@ Open the stats to analyse the detail of the code installed -> ![image](../static/description/analysis_pivot.png) +> ![analysis_pivot](../static/description/analysis_pivot.png) > -> ![image](../static/description/analysis_pie.png) +> ![analysis_pie](../static/description/analysis_pie.png) diff --git a/module_analysis/static/description/index.html b/module_analysis/static/description/index.html index 1ab5e188d..84fc00543 100644 --- a/module_analysis/static/description/index.html +++ b/module_analysis/static/description/index.html @@ -1,4 +1,3 @@ - @@ -9,10 +8,11 @@ /* :Author: David Goodger (goodger@python.org) -:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $ +:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $ :Copyright: This stylesheet has been placed in the public domain. 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 customize this style sheet. @@ -275,7 +275,7 @@ 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 .ln { color: gray; } /* 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 } @@ -301,7 +301,7 @@ span.option { span.pre { white-space: pre } -span.problematic { +span.problematic, pre.problematic { color: red } span.section-subtitle { @@ -367,31 +367,32 @@ ul.auto-toc { !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -!! source digest: sha256:7e9c5ecf5d71e0cfb5e025e0cad0dfd5a91e659e56cfbb0ee1148b4158fb4309 +!! source digest: sha256:d00d83d918ced79270057ca2a185260375834ac2e4526c7c5cb0fa745158aca6 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

+

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

This module allows you to know ‘how much code’ is running on your Odoo instance, group by ‘Type’ (Odoo Core, OCA, other…)

This module can be usefull in the following cases :

    -
  • To analyse the size of your technical debt, regarding your Custom modules
    • +
  • To analyse the size of your technical debt, regarding your Custom +modules
  • To know the ratio between Odoo / OCA and Custom modules
    • -
  • To evaluate the amount to pay to odoo to upgrade your custom code, or the -induced workload
    • +
  • To evaluate the amount to pay to odoo to upgrade your custom code, or +the induced workload
-https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/installed_modules_by_types.png +

installed_modules_by_types

For that purpose, it adds new concepts

    -
  • ir.module.author, based on the value author present in the manifest -file.
    • +
  • ir.module.author, based on the value author present in the +manifest file.
-https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_authors.png +

module_authors

  • ir.module.type, populated by default with Odoo and OCA values.
-https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_types.png +

module_types

Each installed modules have extra data in the ‘Technical Data’ tab :

-https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_form.png +

module_form

Table of contents

    @@ -425,13 +426,11 @@ file. it information.

    This module comes with default rules.

    -https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/default_module_type_rules.png -
    +default_module_type_rules

    You can add your custom rules to identify the modules your team have developped for exemple,

    -https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/add_module_type_rules.png -
    +add_module_type_rules

    to update the data manually, you have to :

    • Go to ‘Settings’ / ‘Technical’ / ‘Scheduled Actions’
      • @@ -441,23 +440,24 @@ developped for exemple,

      to update the data automatically, you have to :

      • Go to ‘Settings’ / ‘Technical’ / ‘Scheduled Actions’
        • -
      • Configure the action ‘Update Module Analysis’ and activate it. (By default, the cron is unactive and no analysis is done)
        • +
      • Configure the action ‘Update Module Analysis’ and activate it. (By +default, the cron is unactive and no analysis is done)

      Adding Extra data

      -

      If you want to analyse other data, (for exemple, having the number of HTML -files), create a custom modules and overload the module model :

      +

      If you want to analyse other data, (for exemple, having the number of +HTML files), create a custom modules and overload the module model :

      -from odoo import api, fields, models
+from odoo import api, fields, models
 
-class IrModuleModule(models.Model):
+class IrModuleModule(models.Model):
    _inherit = 'ir.module.module'
 
    xml_documentation_qty = fields.Integer(
       string='Quantity of Comments in XML Files')
 
   @api.model
-  def _get_analyse_settings(self):
+  def _get_analyse_settings(self):
       res = super()._get_analyse_settings()
       if not '.html' in res:
           res['.html'] = {}
@@ -470,10 +470,9 @@ files), create a custom modules and overload the module model :
      
 
      Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’
 ‘System Parameters’ :
      
 
      
-https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/config_parameters.png
-
      
-
      The list of folders and filename will be exclude from the analysis.
-You can change the default settings.
      
+config_parameters
+
      The list of folders and filename will be exclude from the analysis. You
+can change the default settings.
@@ -483,8 +482,8 @@ You can change the default settings.

Open the stats to analyse the detail of the code installed

-https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pivot.png -https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pie.png +

analysis_pivot

+

analysis_pie

@@ -492,7 +491,7 @@ You can change the default settings.

Bugs are tracked on GitHub Issues. 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 -feedback.

+feedback.

Do not contact contributors directly about support or help with technical issues.

@@ -506,19 +505,22 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

Maintainers

This module is maintained by the OCA.

-Odoo Community Association + +Odoo Community Association +

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.

Current maintainer:

legalsylvain

-

This module is part of the OCA/server-tools project on GitHub.

+

This module is part of the OCA/server-tools project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

diff --git a/requirements.txt b/requirements.txt index 31e37e516..254dc07b8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,5 +4,5 @@ dataclasses mako odoorpc openupgradelib -pygount +pygount==1.4.0 sentry_sdk<=1.9.0