diff --git a/module_analysis/README.rst b/module_analysis/README.rst index b7defb1fb..f6cf26478 100644 --- a/module_analysis/README.rst +++ b/module_analysis/README.rst @@ -13,11 +13,17 @@ Module Analysis .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 -.. |badge3| image:: https://img.shields.io/badge/github-legalsylvain%2Fserver--tools-lightgray.png?logo=github - :target: https://github.com/legalsylvain/server-tools/tree/12.0-ADD-module_analysis/module_analysis - :alt: legalsylvain/server-tools - -|badge1| |badge2| |badge3| +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/12.0/module_analysis + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-module_analysis + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| This module allows you to know 'how much code' is running on your Odoo instance, group by 'Type' (Odoo Core, OCA, other...) @@ -29,22 +35,22 @@ 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:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/installed_modules_by_types.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/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:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/module_authors.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png * ``ir.module.type``, populated by default with Odoo and OCA values. -.. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/module_types.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png Each installed modules have extra data in the 'Technical Data' tab : -.. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/module_form.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_form.png **Table of contents** @@ -68,13 +74,13 @@ it information. This module comes with default rules. - .. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/default_module_type_rules.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png You can add your custom rules to identify the modules your team have developped for exemple, - .. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/add_module_type_rules.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png to update the data, you have to : @@ -83,7 +89,7 @@ to update the data, you have to : * Check the box 'Analyse Installed modules' - .. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/base_module_update.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png This will update analysis of your installed modules. @@ -118,7 +124,7 @@ Exclude files and directories Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters' 'System Parameters' : - .. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/config_parameters.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.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. @@ -130,18 +136,18 @@ Usage Open the stats to analyse the detail of the code installed - .. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/analysis_pivot.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png - .. image:: https://raw.githubusercontent.com/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/analysis_pie.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pie.png Bug Tracker =========== -Bugs are tracked on `GitHub Issues `_. +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 smashing it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -161,6 +167,16 @@ Contributors Maintainers ~~~~~~~~~~~ -This module is part of the `legalsylvain/server-tools `_ project on GitHub. +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +This module is part of the `OCA/server-tools `_ project on GitHub. -You are welcome to contribute. +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/module_analysis/static/description/index.html b/module_analysis/static/description/index.html new file mode 100644 index 000000000..bfc3ddf4b --- /dev/null +++ b/module_analysis/static/description/index.html @@ -0,0 +1,523 @@ + + + + + + +Module Analysis + + + +
+

Module Analysis

+ + +

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

+

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 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
    • +
+https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/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.
    • +
+https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png +
    +
  • ir.module.type, populated by default with Odoo and OCA values.
    • +
+https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png +

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

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

Table of contents

+ +
+

Installation

+

To use this module, you have to install the pygount python librairy.

+

pip install pygount

+
+
+

Configuration

+
    +
  • Go to Apps / Module Analysis / Modules Types Rules
    • +
+

The Module types Rules are usefull to get the Type of a module, based on +it information.

+

This module comes with default rules.

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

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

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

to update the data, you have to :

+
    +

  • Go to ‘Apps’ / ‘Update Apps List’

    +
    • +

  • Check the box ‘Analyse Installed modules’

    +
    +https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png +
    +
    • +
+

This will update analysis of your installed modules.

+
+

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 :

+
+from odoo import api, fields, models
+
+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):
+      res = super()._get_analyse_settings()
+      if not '.html' in res:
+          res['.html'] = {}
+      res['.html']['documentation'] 'xml_documentation_qty'
+      return res
+
+
+
+

Exclude files and directories

+

Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’ +‘System Parameters’ :

+
+https://raw.githubusercontent.com/OCA/server-tools/12.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.

+
+
+
+

Usage

+
    +
  • Go to ‘Apps’ / ‘Module Analysis’ / ‘Installed module by Types’
    • +
+

Open the stats to analyse the detail of the code installed

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

Bug Tracker

+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • GRAP
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+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.

+

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.

+
+
+
+ +