server-tools/module_analysis/README.rst

===============
Module Analysis
===============

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

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

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/legalsylvain/server-tools/12.0-ADD-module_analysis/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

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

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

**Table of contents**

.. contents::
   :local:

Installation
============

To use this module, you have to install the application ``cloc``

.. code-block:: shell

    sudo apt-get install cloc

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/legalsylvain/server-tools/12.0-ADD-module_analysis/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


to update the data, you have to :

* Go to 'Apps' / 'Update Apps List'

* 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

This will update analysis of your installed modules.

Usage
=====

* Go to 'Apps' / 'Module Analysis' / 'Installed module by Types'

Open the stats to analyze 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/legalsylvain/server-tools/12.0-ADD-module_analysis/module_analysis/static/description/analysis_pie.png

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/legalsylvain/server-tools/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 <https://github.com/legalsylvain/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2012.0-ADD-module_analysis%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 part of the `legalsylvain/server-tools <https://github.com/legalsylvain/server-tools/tree/12.0-ADD-module_analysis/module_analysis>`_ project on GitHub.

You are welcome to contribute.