You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

523 lines
19 KiB

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
  7. <title>Module Analysis</title>
  8. <style type="text/css">
  9. /*
  10. :Author: David Goodger (goodger@python.org)
  11. :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
  12. :Copyright: This stylesheet has been placed in the public domain.
  13. Default cascading style sheet for the HTML output of Docutils.
  14. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  15. customize this style sheet.
  16. */
  17. /* used to remove borders from tables and images */
  18. .borderless, table.borderless td, table.borderless th {
  19. border: 0 }
  20. table.borderless td, table.borderless th {
  21. /* Override padding for "table.docutils td" with "! important".
  22. The right padding separates the table cells. */
  23. padding: 0 0.5em 0 0 ! important }
  24. .first {
  25. /* Override more specific margin styles with "! important". */
  26. margin-top: 0 ! important }
  27. .last, .with-subtitle {
  28. margin-bottom: 0 ! important }
  29. .hidden {
  30. display: none }
  31. .subscript {
  32. vertical-align: sub;
  33. font-size: smaller }
  34. .superscript {
  35. vertical-align: super;
  36. font-size: smaller }
  37. a.toc-backref {
  38. text-decoration: none ;
  39. color: black }
  40. blockquote.epigraph {
  41. margin: 2em 5em ; }
  42. dl.docutils dd {
  43. margin-bottom: 0.5em }
  44. object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  45. overflow: hidden;
  46. }
  47. /* Uncomment (and remove this text!) to get bold-faced definition list terms
  48. dl.docutils dt {
  49. font-weight: bold }
  50. */
  51. div.abstract {
  52. margin: 2em 5em }
  53. div.abstract p.topic-title {
  54. font-weight: bold ;
  55. text-align: center }
  56. div.admonition, div.attention, div.caution, div.danger, div.error,
  57. div.hint, div.important, div.note, div.tip, div.warning {
  58. margin: 2em ;
  59. border: medium outset ;
  60. padding: 1em }
  61. div.admonition p.admonition-title, div.hint p.admonition-title,
  62. div.important p.admonition-title, div.note p.admonition-title,
  63. div.tip p.admonition-title {
  64. font-weight: bold ;
  65. font-family: sans-serif }
  66. div.attention p.admonition-title, div.caution p.admonition-title,
  67. div.danger p.admonition-title, div.error p.admonition-title,
  68. div.warning p.admonition-title, .code .error {
  69. color: red ;
  70. font-weight: bold ;
  71. font-family: sans-serif }
  72. /* Uncomment (and remove this text!) to get reduced vertical space in
  73. compound paragraphs.
  74. div.compound .compound-first, div.compound .compound-middle {
  75. margin-bottom: 0.5em }
  76. div.compound .compound-last, div.compound .compound-middle {
  77. margin-top: 0.5em }
  78. */
  79. div.dedication {
  80. margin: 2em 5em ;
  81. text-align: center ;
  82. font-style: italic }
  83. div.dedication p.topic-title {
  84. font-weight: bold ;
  85. font-style: normal }
  86. div.figure {
  87. margin-left: 2em ;
  88. margin-right: 2em }
  89. div.footer, div.header {
  90. clear: both;
  91. font-size: smaller }
  92. div.line-block {
  93. display: block ;
  94. margin-top: 1em ;
  95. margin-bottom: 1em }
  96. div.line-block div.line-block {
  97. margin-top: 0 ;
  98. margin-bottom: 0 ;
  99. margin-left: 1.5em }
  100. div.sidebar {
  101. margin: 0 0 0.5em 1em ;
  102. border: medium outset ;
  103. padding: 1em ;
  104. background-color: #ffffee ;
  105. width: 40% ;
  106. float: right ;
  107. clear: right }
  108. div.sidebar p.rubric {
  109. font-family: sans-serif ;
  110. font-size: medium }
  111. div.system-messages {
  112. margin: 5em }
  113. div.system-messages h1 {
  114. color: red }
  115. div.system-message {
  116. border: medium outset ;
  117. padding: 1em }
  118. div.system-message p.system-message-title {
  119. color: red ;
  120. font-weight: bold }
  121. div.topic {
  122. margin: 2em }
  123. h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  124. h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  125. margin-top: 0.4em }
  126. h1.title {
  127. text-align: center }
  128. h2.subtitle {
  129. text-align: center }
  130. hr.docutils {
  131. width: 75% }
  132. img.align-left, .figure.align-left, object.align-left, table.align-left {
  133. clear: left ;
  134. float: left ;
  135. margin-right: 1em }
  136. img.align-right, .figure.align-right, object.align-right, table.align-right {
  137. clear: right ;
  138. float: right ;
  139. margin-left: 1em }
  140. img.align-center, .figure.align-center, object.align-center {
  141. display: block;
  142. margin-left: auto;
  143. margin-right: auto;
  144. }
  145. table.align-center {
  146. margin-left: auto;
  147. margin-right: auto;
  148. }
  149. .align-left {
  150. text-align: left }
  151. .align-center {
  152. clear: both ;
  153. text-align: center }
  154. .align-right {
  155. text-align: right }
  156. /* reset inner alignment in figures */
  157. div.align-right {
  158. text-align: inherit }
  159. /* div.align-center * { */
  160. /* text-align: left } */
  161. .align-top {
  162. vertical-align: top }
  163. .align-middle {
  164. vertical-align: middle }
  165. .align-bottom {
  166. vertical-align: bottom }
  167. ol.simple, ul.simple {
  168. margin-bottom: 1em }
  169. ol.arabic {
  170. list-style: decimal }
  171. ol.loweralpha {
  172. list-style: lower-alpha }
  173. ol.upperalpha {
  174. list-style: upper-alpha }
  175. ol.lowerroman {
  176. list-style: lower-roman }
  177. ol.upperroman {
  178. list-style: upper-roman }
  179. p.attribution {
  180. text-align: right ;
  181. margin-left: 50% }
  182. p.caption {
  183. font-style: italic }
  184. p.credits {
  185. font-style: italic ;
  186. font-size: smaller }
  187. p.label {
  188. white-space: nowrap }
  189. p.rubric {
  190. font-weight: bold ;
  191. font-size: larger ;
  192. color: maroon ;
  193. text-align: center }
  194. p.sidebar-title {
  195. font-family: sans-serif ;
  196. font-weight: bold ;
  197. font-size: larger }
  198. p.sidebar-subtitle {
  199. font-family: sans-serif ;
  200. font-weight: bold }
  201. p.topic-title {
  202. font-weight: bold }
  203. pre.address {
  204. margin-bottom: 0 ;
  205. margin-top: 0 ;
  206. font: inherit }
  207. pre.literal-block, pre.doctest-block, pre.math, pre.code {
  208. margin-left: 2em ;
  209. margin-right: 2em }
  210. pre.code .ln { color: grey; } /* line numbers */
  211. pre.code, code { background-color: #eeeeee }
  212. pre.code .comment, code .comment { color: #5C6576 }
  213. pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  214. pre.code .literal.string, code .literal.string { color: #0C5404 }
  215. pre.code .name.builtin, code .name.builtin { color: #352B84 }
  216. pre.code .deleted, code .deleted { background-color: #DEB0A1}
  217. pre.code .inserted, code .inserted { background-color: #A3D289}
  218. span.classifier {
  219. font-family: sans-serif ;
  220. font-style: oblique }
  221. span.classifier-delimiter {
  222. font-family: sans-serif ;
  223. font-weight: bold }
  224. span.interpreted {
  225. font-family: sans-serif }
  226. span.option {
  227. white-space: nowrap }
  228. span.pre {
  229. white-space: pre }
  230. span.problematic {
  231. color: red }
  232. span.section-subtitle {
  233. /* font-size relative to parent (h1..h6 element) */
  234. font-size: 80% }
  235. table.citation {
  236. border-left: solid 1px gray;
  237. margin-left: 1px }
  238. table.docinfo {
  239. margin: 2em 4em }
  240. table.docutils {
  241. margin-top: 0.5em ;
  242. margin-bottom: 0.5em }
  243. table.footnote {
  244. border-left: solid 1px black;
  245. margin-left: 1px }
  246. table.docutils td, table.docutils th,
  247. table.docinfo td, table.docinfo th {
  248. padding-left: 0.5em ;
  249. padding-right: 0.5em ;
  250. vertical-align: top }
  251. table.docutils th.field-name, table.docinfo th.docinfo-name {
  252. font-weight: bold ;
  253. text-align: left ;
  254. white-space: nowrap ;
  255. padding-left: 0 }
  256. /* "booktabs" style (no vertical lines) */
  257. table.docutils.booktabs {
  258. border: 0px;
  259. border-top: 2px solid;
  260. border-bottom: 2px solid;
  261. border-collapse: collapse;
  262. }
  263. table.docutils.booktabs * {
  264. border: 0px;
  265. }
  266. table.docutils.booktabs th {
  267. border-bottom: thin solid;
  268. text-align: left;
  269. }
  270. h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  271. h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  272. font-size: 100% }
  273. ul.auto-toc {
  274. list-style-type: none }
  275. </style>
  276. </head>
  277. <body>
  278. <div class="document" id="module-analysis">
  279. <h1 class="title">Module Analysis</h1>
  280. <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  281. !! This file is generated by oca-gen-addon-readme !!
  282. !! changes will be overwritten. !!
  283. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
  284. <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/12.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-12-0/server-tools-12-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/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
  285. <p>This module allows you to know ‘how much code’ is running on your Odoo
  286. instance, group by ‘Type’ (Odoo Core, OCA, other…)</p>
  287. <p>This module can be usefull in the following cases :</p>
  288. <ul class="simple">
  289. <li>To analyse the size of your technical debt, regarding your Custom modules</li>
  290. <li>To know the ratio between Odoo / OCA and Custom modules</li>
  291. <li>To evaluate the amount to pay to odoo to upgrade your custom code, or the
  292. induced workload</li>
  293. </ul>
  294. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/installed_modules_by_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/installed_modules_by_types.png" />
  295. <p>For that purpose, it adds new concepts</p>
  296. <ul class="simple">
  297. <li><tt class="docutils literal">ir.module.author</tt>, based on the value <tt class="docutils literal">author</tt> present in the manifest
  298. file.</li>
  299. </ul>
  300. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png" />
  301. <ul class="simple">
  302. <li><tt class="docutils literal">ir.module.type</tt>, populated by default with Odoo and OCA values.</li>
  303. </ul>
  304. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png" />
  305. <p>Each installed modules have extra data in the ‘Technical Data’ tab :</p>
  306. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_form.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_form.png" />
  307. <p><strong>Table of contents</strong></p>
  308. <div class="contents local topic" id="contents">
  309. <ul class="simple">
  310. <li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
  311. <li><a class="reference internal" href="#configuration" id="id2">Configuration</a><ul>
  312. <li><a class="reference internal" href="#adding-extra-data" id="id3">Adding Extra data</a></li>
  313. <li><a class="reference internal" href="#exclude-files-and-directories" id="id4">Exclude files and directories</a></li>
  314. </ul>
  315. </li>
  316. <li><a class="reference internal" href="#usage" id="id5">Usage</a></li>
  317. <li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
  318. <li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
  319. <li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
  320. <li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
  321. <li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
  322. </ul>
  323. </li>
  324. </ul>
  325. </div>
  326. <div class="section" id="installation">
  327. <h1><a class="toc-backref" href="#id1">Installation</a></h1>
  328. <p>To use this module, you have to install the <tt class="docutils literal">pygount</tt> python librairy.</p>
  329. <p><tt class="docutils literal">pip install pygount</tt></p>
  330. </div>
  331. <div class="section" id="configuration">
  332. <h1><a class="toc-backref" href="#id2">Configuration</a></h1>
  333. <ul class="simple">
  334. <li>Go to Apps / Module Analysis / Modules Types Rules</li>
  335. </ul>
  336. <p>The Module types Rules are usefull to get the Type of a module, based on
  337. it information.</p>
  338. <p>This module comes with default rules.</p>
  339. <blockquote>
  340. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png" />
  341. </blockquote>
  342. <p>You can add your custom rules to identify the modules your team have
  343. developped for exemple,</p>
  344. <blockquote>
  345. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png" />
  346. </blockquote>
  347. <p>to update the data, you have to :</p>
  348. <ul>
  349. <li><p class="first">Go to ‘Apps’ / ‘Update Apps List’</p>
  350. </li>
  351. <li><p class="first">Check the box ‘Analyse Installed modules’</p>
  352. <blockquote>
  353. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png" />
  354. </blockquote>
  355. </li>
  356. </ul>
  357. <p>This will update analysis of your installed modules.</p>
  358. <div class="section" id="adding-extra-data">
  359. <h2><a class="toc-backref" href="#id3">Adding Extra data</a></h2>
  360. <p>If you want to analyse other data, (for exemple, having the number of HTML
  361. files), create a custom modules and overload the module model :</p>
  362. <pre class="code python literal-block">
  363. <span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">api</span><span class="p">,</span> <span class="n">fields</span><span class="p">,</span> <span class="n">models</span>
  364. <span class="k">class</span> <span class="nc">IrModuleModule</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
  365. <span class="n">_inherit</span> <span class="o">=</span> <span class="s1">'ir.module.module'</span>
  366. <span class="n">xml_documentation_qty</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Integer</span><span class="p">(</span>
  367. <span class="n">string</span><span class="o">=</span><span class="s1">'Quantity of Comments in XML Files'</span><span class="p">)</span>
  368. <span class="nd">&#64;api.model</span>
  369. <span class="k">def</span> <span class="nf">_get_analyse_settings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  370. <span class="n">res</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_get_analyse_settings</span><span class="p">()</span>
  371. <span class="k">if</span> <span class="ow">not</span> <span class="s1">'.html'</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
  372. <span class="n">res</span><span class="p">[</span><span class="s1">'.html'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
  373. <span class="n">res</span><span class="p">[</span><span class="s1">'.html'</span><span class="p">][</span><span class="s1">'documentation'</span><span class="p">]</span> <span class="s1">'xml_documentation_qty'</span>
  374. <span class="k">return</span> <span class="n">res</span>
  375. </pre>
  376. </div>
  377. <div class="section" id="exclude-files-and-directories">
  378. <h2><a class="toc-backref" href="#id4">Exclude files and directories</a></h2>
  379. <p>Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’
  380. ‘System Parameters’ :</p>
  381. <blockquote>
  382. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/config_parameters.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/config_parameters.png" />
  383. </blockquote>
  384. <p>The list of folders and filename will be exclude from the analysis.
  385. You can change the default settings.</p>
  386. </div>
  387. </div>
  388. <div class="section" id="usage">
  389. <h1><a class="toc-backref" href="#id5">Usage</a></h1>
  390. <ul class="simple">
  391. <li>Go to ‘Apps’ / ‘Module Analysis’ / ‘Installed module by Types’</li>
  392. </ul>
  393. <p>Open the stats to analyse the detail of the code installed</p>
  394. <blockquote>
  395. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png" />
  396. <img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pie.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pie.png" />
  397. </blockquote>
  398. </div>
  399. <div class="section" id="bug-tracker">
  400. <h1><a class="toc-backref" href="#id6">Bug Tracker</a></h1>
  401. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
  402. In case of trouble, please check there if your issue has already been reported.
  403. If you spotted it first, help us smashing it by providing a detailed and welcomed
  404. <a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
  405. <p>Do not contact contributors directly about support or help with technical issues.</p>
  406. </div>
  407. <div class="section" id="credits">
  408. <h1><a class="toc-backref" href="#id7">Credits</a></h1>
  409. <div class="section" id="authors">
  410. <h2><a class="toc-backref" href="#id8">Authors</a></h2>
  411. <ul class="simple">
  412. <li>GRAP</li>
  413. </ul>
  414. </div>
  415. <div class="section" id="contributors">
  416. <h2><a class="toc-backref" href="#id9">Contributors</a></h2>
  417. <ul class="simple">
  418. <li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li>
  419. </ul>
  420. </div>
  421. <div class="section" id="maintainers">
  422. <h2><a class="toc-backref" href="#id10">Maintainers</a></h2>
  423. <p>This module is maintained by the OCA.</p>
  424. <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
  425. <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
  426. mission is to support the collaborative development of Odoo features and
  427. promote its widespread use.</p>
  428. <p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/module_analysis">OCA/server-tools</a> project on GitHub.</p>
  429. <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>
  430. </div>
  431. </div>
  432. </div>
  433. </body>
  434. </html>