{ "info": { "author": "GRAP, Odoo Community Association (OCA)", "author_email": "support@odoo-community.org", "bugtrack_url": null, "classifiers": [ "Framework :: Odoo", "License :: OSI Approved :: GNU Affero General Public License v3", "Programming Language :: Python" ], "description": "===============\nModule Analysis\n===============\n\n.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github\n :target: https://github.com/OCA/server-tools/tree/12.0/module_analysis\n :alt: OCA/server-tools\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-module_analysis\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png\n :target: https://runbot.odoo-community.org/runbot/149/12.0\n :alt: Try me on Runbot\n\n|badge1| |badge2| |badge3| |badge4| |badge5| \n\nThis module allows you to know 'how much code' is running on your Odoo\ninstance, group by 'Type' (Odoo Core, OCA, other...)\n\nThis module can be usefull in the following cases :\n\n* To analyse the size of your technical debt, regarding your Custom modules\n* To know the ratio between Odoo / OCA and Custom modules\n* To evaluate the amount to pay to odoo to upgrade your custom code, or the\n induced workload\n\n.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/installed_modules_by_types.png\n\nFor that purpose, it adds new concepts\n\n* ``ir.module.author``, based on the value ``author`` present in the manifest\n file.\n\n.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png\n\n* ``ir.module.type``, populated by default with Odoo and OCA values.\n\n.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png\n\nEach installed modules have extra data in the 'Technical Data' tab :\n\n.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_form.png\n\n**Table of contents**\n\n.. contents::\n :local:\n\nInstallation\n============\n\nTo use this module, you have to install the ``pygount`` python librairy.\n\n``pip install pygount``\n\nConfiguration\n=============\n\n* Go to Apps / Module Analysis / Modules Types Rules\n\nThe Module types Rules are usefull to get the Type of a module, based on\nit information.\n\nThis module comes with default rules.\n\n .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png\n\n\nYou can add your custom rules to identify the modules your team have\ndevelopped for exemple,\n\n .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png\n\n\nto update the data, you have to :\n\n* Go to 'Apps' / 'Update Apps List'\n\n* Check the box 'Analyse Installed modules'\n\n .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png\n\nThis will update analysis of your installed modules.\n\n\nAdding Extra data\n~~~~~~~~~~~~~~~~~\n\nIf you want to analyse other data, (for exemple, having the number of HTML\nfiles), create a custom modules and overload the module model :\n\n.. code-block:: python\n\n from odoo import api, fields, models\n\n class IrModuleModule(models.Model):\n _inherit = 'ir.module.module'\n\n xml_documentation_qty = fields.Integer(\n string='Quantity of Comments in XML Files')\n\n @api.model\n def _get_analyse_settings(self):\n res = super()._get_analyse_settings()\n if not '.html' in res:\n res['.html'] = {}\n res['.html']['documentation'] 'xml_documentation_qty'\n return res\n\nExclude files and directories\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTwo parameters are availaible in 'Settings' / 'Technical' / 'Parameters'\n'System Parameters' :\n\n .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/config_parameters.png\n\nThe list of folders and filename will be exclude from the analysis.\nYou can change the default settings.\n\nUsage\n=====\n\n* Go to 'Apps' / 'Module Analysis' / 'Installed module by Types'\n\nOpen the stats to analyse the detail of the code installed\n\n .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png\n\n .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pie.png\n\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues `_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed\n`feedback `_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* GRAP\n\nContributors\n~~~~~~~~~~~~\n\n* Sylvain LE GAL (https://twitter.com/legalsylvain)\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/server-tools `_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/OCA/server-tools/", "keywords": "", "license": "AGPL-3", "maintainer": "", "maintainer_email": "", "name": "odoo12-addon-module-analysis", "package_url": "https://pypi.org/project/odoo12-addon-module-analysis/", "platform": "", "project_url": "https://pypi.org/project/odoo12-addon-module-analysis/", "project_urls": { "Homepage": "https://github.com/OCA/server-tools/" }, "release_url": "https://pypi.org/project/odoo12-addon-module-analysis/12.0.1.0.0.99.dev20/", "requires_dist": [ "odoo (<12.1dev,>=12.0a)", "pygount" ], "requires_python": ">=3.5", "summary": "Add analysis tools regarding installed modules to know which installed modules comes from Odoo Core, OCA, or are custom modules", "version": "12.0.1.0.0.99.dev20" }, "last_serial": 5768899, "releases": { "12.0.1.0.0.99.dev16": [ { "comment_text": "", "digests": { "md5": "f72d96990b2fc14e2c50b1f653192f1e", "sha256": "83bdf2dbb395b79fc8892d70a711da01c6daa300936482a5373bd2d105514fac" }, "downloads": -1, "filename": "odoo12_addon_module_analysis-12.0.1.0.0.99.dev16-py3-none-any.whl", "has_sig": false, "md5_digest": "f72d96990b2fc14e2c50b1f653192f1e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 257184, "upload_time": "2019-07-24T04:47:57", "url": "https://files.pythonhosted.org/packages/51/33/1f189c97ae196f1625b16a86312a33a58968af99e64ba508e6ed03cf7f81/odoo12_addon_module_analysis-12.0.1.0.0.99.dev16-py3-none-any.whl" } ], "12.0.1.0.0.99.dev17": [ { "comment_text": "", "digests": { "md5": "45a7dbd7dabd1ad9745859a32af83caa", "sha256": "d3cf9f67f0b65aba9e5d3802b9c80cca7c5117e70c86856eab45b41881129325" }, "downloads": -1, "filename": "odoo12_addon_module_analysis-12.0.1.0.0.99.dev17-py3-none-any.whl", "has_sig": false, "md5_digest": "45a7dbd7dabd1ad9745859a32af83caa", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 257181, "upload_time": "2019-07-30T05:05:10", "url": "https://files.pythonhosted.org/packages/88/b2/38df54d1644b907bf5356eba66df3f670775d132e7fd8e345cce0c5e4e97/odoo12_addon_module_analysis-12.0.1.0.0.99.dev17-py3-none-any.whl" } ], "12.0.1.0.0.99.dev20": [ { "comment_text": "", "digests": { "md5": "911c30c56894f0600631735a1b35f925", "sha256": "9238ef99555dc5e41efccc91b000fd35816b21fcfd09b0c3976575f00664d96a" }, "downloads": -1, "filename": "odoo12_addon_module_analysis-12.0.1.0.0.99.dev20-py3-none-any.whl", "has_sig": false, "md5_digest": "911c30c56894f0600631735a1b35f925", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 258784, "upload_time": "2019-09-02T04:49:22", "url": "https://files.pythonhosted.org/packages/3e/82/c15373bdd61ecd1f0cacb028fd9e75a753efbfd09ffaf79a32420e4232ca/odoo12_addon_module_analysis-12.0.1.0.0.99.dev20-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "911c30c56894f0600631735a1b35f925", "sha256": "9238ef99555dc5e41efccc91b000fd35816b21fcfd09b0c3976575f00664d96a" }, "downloads": -1, "filename": "odoo12_addon_module_analysis-12.0.1.0.0.99.dev20-py3-none-any.whl", "has_sig": false, "md5_digest": "911c30c56894f0600631735a1b35f925", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 258784, "upload_time": "2019-09-02T04:49:22", "url": "https://files.pythonhosted.org/packages/3e/82/c15373bdd61ecd1f0cacb028fd9e75a753efbfd09ffaf79a32420e4232ca/odoo12_addon_module_analysis-12.0.1.0.0.99.dev20-py3-none-any.whl" } ] }