197 lines
6.6 KiB
ReStructuredText
197 lines
6.6 KiB
ReStructuredText
===============
|
|
Module Analysis
|
|
===============
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:42cd3bc713aa055ca4fb7050c76a79505522464ae21344afd3afa412bda15b32
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
|
:target: https://odoo-community.org/page/development-status
|
|
:alt: Beta
|
|
.. |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-OCA%2Fserver--tools-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-tools/tree/16.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-16-0/server-tools-16-0-module_analysis
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|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...)
|
|
|
|
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
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.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/OCA/server-tools/16.0/module_analysis/static/description/module_authors.png
|
|
|
|
* ``ir.module.type``, populated by default with Odoo and OCA values.
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_types.png
|
|
|
|
Each installed modules have extra data in the 'Technical Data' tab :
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_form.png
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
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.
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.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/OCA/server-tools/16.0/module_analysis/static/description/add_module_type_rules.png
|
|
|
|
|
|
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 :
|
|
|
|
.. code-block:: python
|
|
|
|
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' :
|
|
|
|
.. image:: 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.
|
|
|
|
Usage
|
|
=====
|
|
|
|
* Go to 'Apps' / 'Module Analysis' / 'Installed module by Types'
|
|
|
|
Open the stats to analyse the detail of the code installed
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pivot.png
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pie.png
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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 <https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* GRAP
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Sylvain LE GAL (https://twitter.com/legalsylvain)
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
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.
|
|
|
|
.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
|
|
:target: https://github.com/legalsylvain
|
|
:alt: legalsylvain
|
|
|
|
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
|
|
|
|maintainer-legalsylvain|
|
|
|
|
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/module_analysis>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|