Techsystech
/
server-tools
mirror of https://github.com/OCA/server-tools.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

pull/2608/head
OCA-git-bot 2023-02-14 15:01:44 +00:00 committed by Florian da Costa
parent 65fd04ee12
commit 59bf048729
2 changed files with 41 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
module_analysis/README.rst
View File

@ -14,13 +14,13 @@ Module Analysis
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3 :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/13.0/module_analysis :target: https://github.com/OCA/server-tools/tree/15.0/module_analysis
:alt: OCA/server-tools :alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-module_analysis :target: https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-module_analysis
:alt: Translate me on Weblate :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/13.0 :target: https://runbot.odoo-community.org/runbot/149/15.0
:alt: Try me on Runbot :alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5| |badge1| |badge2| |badge3| |badge4| |badge5|
@ -35,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 * To evaluate the amount to pay to odoo to upgrade your custom code, or the
induced workload induced workload
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/installed_modules_by_types.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/installed_modules_by_types.png
For that purpose, it adds new concepts For that purpose, it adds new concepts
* ``ir.module.author``, based on the value ``author`` present in the manifest * ``ir.module.author``, based on the value ``author`` present in the manifest
file. file.
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_authors.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_authors.png
* ``ir.module.type``, populated by default with Odoo and OCA values. * ``ir.module.type``, populated by default with Odoo and OCA values.
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_types.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_types.png
Each installed modules have extra data in the 'Technical Data' tab : Each installed modules have extra data in the 'Technical Data' tab :
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_form.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_form.png
**Table of contents** **Table of contents**
@ -74,25 +74,31 @@ it information.
This module comes with default rules. This module comes with default rules.
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/default_module_type_rules.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/default_module_type_rules.png
You can add your custom rules to identify the modules your team have You can add your custom rules to identify the modules your team have
developped for exemple, developped for exemple,
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/add_module_type_rules.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/add_module_type_rules.png
to update the data, you have to : to update the data manually, you have to :
* Go to 'Apps' / 'Update Apps List' * Go to 'Apps' / 'Update Apps List'
* Check the box 'Analyse Installed modules' * Check the box 'Analyse Installed modules'
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/base_module_update.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/base_module_update.png
This will update analysis of your installed modules. 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'. (By default, the analysis will be done nightly)
Adding Extra data Adding Extra data
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -124,7 +130,7 @@ Exclude files and directories
Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters' Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters'
'System Parameters' : 'System Parameters' :
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/config_parameters.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/config_parameters.png
The list of folders and filename will be exclude from the analysis. The list of folders and filename will be exclude from the analysis.
You can change the default settings. You can change the default settings.
@ -136,9 +142,9 @@ Usage
Open the stats to analyse the detail of the code installed Open the stats to analyse the detail of the code installed
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/analysis_pivot.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pivot.png
.. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/analysis_pie.png .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pie.png
Bug Tracker Bug Tracker
=========== ===========
@ -146,7 +152,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_. 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. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2015.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. Do not contact contributors directly about support or help with technical issues.
@ -176,6 +182,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/13.0/module_analysis>`_ project on GitHub. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/15.0/module_analysis>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

33
module_analysis/static/description/index.html
View File

@ -367,7 +367,7 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !! !! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !! !! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/13.0/module_analysis"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-module_analysis"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/module_analysis"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-module_analysis"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module allows you to know ‘how much code’ is running on your Odoo <p>This module allows you to know ‘how much code’ is running on your Odoo
instance, group by ‘Type’ (Odoo Core, OCA, other…)</p> instance, group by ‘Type’ (Odoo Core, OCA, other…)</p>
<p>This module can be usefull in the following cases :</p> <p>This module can be usefull in the following cases :</p>
@ -377,19 +377,19 @@ instance, group by ‘Type’ (Odoo Core, OCA, other…)</p>
<li>To evaluate the amount to pay to odoo to upgrade your custom code, or the <li>To evaluate the amount to pay to odoo to upgrade your custom code, or the
induced workload</li> induced workload</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/installed_modules_by_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/installed_modules_by_types.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/installed_modules_by_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/installed_modules_by_types.png" />
<p>For that purpose, it adds new concepts</p> <p>For that purpose, it adds new concepts</p>
<ul class="simple"> <ul class="simple">
<li><tt class="docutils literal">ir.module.author</tt>, based on the value <tt class="docutils literal">author</tt> present in the manifest <li><tt class="docutils literal">ir.module.author</tt>, based on the value <tt class="docutils literal">author</tt> present in the manifest
file.</li> file.</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_authors.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_authors.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_authors.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_authors.png" />
<ul class="simple"> <ul class="simple">
<li><tt class="docutils literal">ir.module.type</tt>, populated by default with Odoo and OCA values.</li> <li><tt class="docutils literal">ir.module.type</tt>, populated by default with Odoo and OCA values.</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_types.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_types.png" />
<p>Each installed modules have extra data in the ‘Technical Data’ tab :</p> <p>Each installed modules have extra data in the ‘Technical Data’ tab :</p>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_form.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/module_form.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_form.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_form.png" />
<p><strong>Table of contents</strong></p> <p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents"> <div class="contents local topic" id="contents">
<ul class="simple"> <ul class="simple">
@ -423,24 +423,29 @@ file.</li>
it information.</p> it information.</p>
<p>This module comes with default rules.</p> <p>This module comes with default rules.</p>
<blockquote> <blockquote>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/default_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/default_module_type_rules.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/default_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/default_module_type_rules.png" />
</blockquote> </blockquote>
<p>You can add your custom rules to identify the modules your team have <p>You can add your custom rules to identify the modules your team have
developped for exemple,</p> developped for exemple,</p>
<blockquote> <blockquote>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/add_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/add_module_type_rules.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/add_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/add_module_type_rules.png" />
</blockquote> </blockquote>
<p>to update the data, you have to :</p> <p>to update the data manually, you have to :</p>
<ul> <ul>
<li><p class="first">Go to ‘Apps’ / ‘Update Apps List’</p> <li><p class="first">Go to ‘Apps’ / ‘Update Apps List’</p>
</li> </li>
<li><p class="first">Check the box ‘Analyse Installed modules’</p> <li><p class="first">Check the box ‘Analyse Installed modules’</p>
<blockquote> <blockquote>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/base_module_update.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/base_module_update.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/base_module_update.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/base_module_update.png" />
</blockquote> </blockquote>
</li> </li>
</ul> </ul>
<p>This will update analysis of your installed modules.</p> <p>This will update analysis of your installed modules.</p>
<p>to update the data automatically, you have to :</p>
<ul class="simple">
<li>Go to ‘Settings’ / ‘Technical’ / ‘Scheduled Actions’</li>
<li>Configure the action ‘Update Module Analysis’. (By default, the analysis will be done nightly)</li>
</ul>
<div class="section" id="adding-extra-data"> <div class="section" id="adding-extra-data">
<h2><a class="toc-backref" href="#id3">Adding Extra data</a></h2> <h2><a class="toc-backref" href="#id3">Adding Extra data</a></h2>
<p>If you want to analyse other data, (for exemple, having the number of HTML <p>If you want to analyse other data, (for exemple, having the number of HTML
@ -468,7 +473,7 @@ files), create a custom modules and overload the module model :</p>
<p>Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’ <p>Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’
‘System Parameters’ :</p> ‘System Parameters’ :</p>
<blockquote> <blockquote>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/config_parameters.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/config_parameters.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/config_parameters.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/config_parameters.png" />
</blockquote> </blockquote>
<p>The list of folders and filename will be exclude from the analysis. <p>The list of folders and filename will be exclude from the analysis.
You can change the default settings.</p> You can change the default settings.</p>
@ -481,8 +486,8 @@ You can change the default settings.</p>
</ul> </ul>
<p>Open the stats to analyse the detail of the code installed</p> <p>Open the stats to analyse the detail of the code installed</p>
<blockquote> <blockquote>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/analysis_pivot.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/analysis_pivot.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pivot.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pivot.png" />
<img alt="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/analysis_pie.png" src="https://raw.githubusercontent.com/OCA/server-tools/13.0/module_analysis/static/description/analysis_pie.png" /> <img alt="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pie.png" src="https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pie.png" />
</blockquote> </blockquote>
</div> </div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
@ -490,7 +495,7 @@ You can change the default settings.</p>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
@ -514,7 +519,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use.</p> promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/13.0/module_analysis">OCA/server-tools</a> project on GitHub.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/module_analysis">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div> </div>
</div> </div>