Skip to main content
Odoo Community Association

Module Analysis

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

installed_modules_by_types

For that purpose, it adds new concepts

  • ir.module.author, based on the value author present in the manifest file.

module_authors

  • ir.module.type, populated by default with Odoo and OCA values.

module_types

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

module_form

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.

default_module_type_rules

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

add_module_type_rules

to update the data manually, you have to :

  • Go to ‘Settings’ / ‘Technical’ / ‘Scheduled Actions’

  • Run manually the action : ‘Update Module Analysis’

This will update analysis of your installed modules.

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)

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’ :

config_parameters

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

analysis_pivot

analysis_pie

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

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

Credits

Authors

  • GRAP

Contributors

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.

Current maintainer:

legalsylvain

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.

Release files for odoo-addon-module-analysis 18.0.1.0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-module-analysis 18.0.1.0.0.2
File Interpreter ABI Platform
odoo_addon_module_analysis-18.0.1.0.0.2-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_module_analysis-18.0.1.0.0.2-py3-none-any.whl

Download URL odoo_addon_module_analysis-18.0.1.0.0.2-py3-none-any.whl
Size 253.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
33ce6b8efc0c83b59bbbe10035430038f1210ec004cc6b87a812fe6563ab6150
BLAKE2b-256 checksum
How to use checksums
7cd89e15c682a99b5b0184c314aab349f982cb8ae7f5e548acc56011c4767670
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

18.0.1.0.0.2 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page