Initial commit: OCA Technical packages (595 packages)

odoo-bringout-oca-server-tools-module_analysis/module_analysis/readme/CONFIGURE.rst

@@ -0,0 +1,65 @@
+* 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:: ../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
+
+
+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:: ../static/description/config_parameters.png
+
+The list of folders and filename will be exclude from the analysis.
+You can change the default settings.

odoo-bringout-oca-server-tools-module_analysis/module_analysis/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Sylvain LE GAL (https://twitter.com/legalsylvain)

odoo-bringout-oca-server-tools-module_analysis/module_analysis/readme/DESCRIPTION.rst

@@ -0,0 +1,26 @@
+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:: ../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
+
+* ``ir.module.type``, populated by default with Odoo and OCA values.
+
+.. image:: ../static/description/module_types.png
+
+Each installed modules have extra data in the 'Technical Data' tab :
+
+.. image:: ../static/description/module_form.png

odoo-bringout-oca-server-tools-module_analysis/module_analysis/readme/INSTALL.rst

@@ -0,0 +1,3 @@
+To use this module, you have to install the ``pygount`` python librairy.
+
+``pip install pygount``

odoo-bringout-oca-server-tools-module_analysis/module_analysis/readme/USAGE.rst

@@ -0,0 +1,7 @@
+* Go to 'Apps' / 'Module Analysis' / 'Installed module by Types'
+
+Open the stats to analyse the detail of the code installed
+
+    .. image:: ../static/description/analysis_pivot.png
+
+    .. image:: ../static/description/analysis_pie.png