From 1d8cbe4ccaba488844fbbf76340bbac9d379d7e6 Mon Sep 17 00:00:00 2001 From: Maxime Chambreuil Date: Sat, 7 Feb 2015 17:19:03 -0500 Subject: [PATCH] [IMP] Add help [FIX] license field [IMP] Add template README.rst as default description [FIX] PEP8 errors [IMP] Take reviews into account --- module_prototyper/models/module_prototyper.py | 89 +++++++++++++++---- .../wizard/module_prototyper_module_export.py | 3 - 2 files changed, 74 insertions(+), 18 deletions(-) diff --git a/module_prototyper/models/module_prototyper.py b/module_prototyper/models/module_prototyper.py index aa2fa0a9e..d98b5840d 100644 --- a/module_prototyper/models/module_prototyper.py +++ b/module_prototyper/models/module_prototyper.py @@ -79,15 +79,74 @@ class ModulePrototyper(models.Model): description = fields.Text( 'Description', required=True, - help=('Enter the description of your module, what it does, how to ' - 'install, configure and use it, the roadmap or known issues. ' + help=('Enter the description of your module, what it does, how to' + 'install, configure and use it, the roadmap or known issues.' 'The description will be exported in README.rst'), - default=get_default_description + default=""" +Module name +=========== + +This module was written to extend the functionality of ... to support ... +and allow you to ... + +Installation +============ + +To install this module, you need to: + + * do this ... + +Configuration +============= + +To configure this module, you need to: + + * go to ... + +Usage +===== + +To use this module, you need to: + + * go to ... + +For further information, please visit: + + * https://www.odoo.com/forum/help-1 + +Known issues / Roadmap +====================== + + * ... + +Credits +======= + +Contributors +------------ + +* Firsname Lastname + +Maintainer +---------- + +.. image:: http://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: http://odoo-community.org + +This module is maintained by the OCA. + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +To contribute to this module, please visit http://odoo-community.org. + """ ) author = fields.Char('Author', required=True, help=('Enter your name')) maintainer = fields.Char( 'Maintainer', - help=('Enter the name of the person or organization who will ' + help=('Enter the name of the person or organization who will' 'maintain this module') ) website = fields.Char('Website', help=('Enter the URL of your website')) @@ -98,9 +157,9 @@ class ModulePrototyper(models.Model): ) version = fields.Char( 'Version', - size=3, - default='0.1', - help=('Enter the version of your module with 2 digits') + size=9, + default='8.0.0.0.1', + help=('Enter the version of your module with 5 digits') ) auto_install = fields.Boolean( 'Auto Install', @@ -117,7 +176,7 @@ class ModulePrototyper(models.Model): 'ir.module.module', 'module_prototyper_module_rel', 'module_prototyper_id', 'module_id', 'Dependencies', - help=('Enter the list of required modules that need to be installed ' + help=('Enter the list of required modules that need to be installed' 'for your module to work properly') ) data_ids = fields.Many2many( @@ -137,34 +196,34 @@ class ModulePrototyper(models.Model): field_ids = fields.Many2many( 'ir.model.fields', 'prototype_fields_rel', 'module_prototyper_id', 'field_id', 'Fields', - help=('Enter the list of fields that you have created or modified ' - 'and want to export in this module. New models will be ' + help=('Enter the list of fields that you have created or modified' + 'and want to export in this module. New models will be' 'exported as long as you choose one of his fields.') ) menu_ids = fields.Many2many( 'ir.ui.menu', 'prototype_menu_rel', 'module_prototyper_id', 'menu_id', 'Menu Items', - help=('Enter the list of menu items that you have created and want ' - 'to export in this module. Related windows actions will be ' + help=('Enter the list of menu items that you have created and want' + 'to export in this module. Related windows actions will be' 'exported as well.') ) view_ids = fields.Many2many( 'ir.ui.view', 'prototype_view_rel', 'module_prototyper_id', 'view_id', 'Views', - help=('Enter the list of views that you have created and want to ' + help=('Enter the list of views that you have created and want to' 'export in this module.') ) group_ids = fields.Many2many( 'res.groups', 'prototype_groups_rel', 'module_prototyper_id', 'group_id', 'Groups', - help=('Enter the list of groups that you have created and want to ' + help=('Enter the list of groups that you have created and want to' 'export in this module.') ) right_ids = fields.Many2many( 'ir.model.access', 'prototype_rights_rel', 'module_prototyper_id', 'right_id', 'Access Rights', - help=('Enter the list of access rights that you have created and ' + help=('Enter the list of access rights that you have created and' 'want to export in this module.') ) rule_ids = fields.Many2many( diff --git a/module_prototyper/wizard/module_prototyper_module_export.py b/module_prototyper/wizard/module_prototyper_module_export.py index e87fcf145..560bf591c 100644 --- a/module_prototyper/wizard/module_prototyper_module_export.py +++ b/module_prototyper/wizard/module_prototyper_module_export.py @@ -33,12 +33,9 @@ class PrototypeModuleExport(models.TransientModel): _name = "module_prototyper.module.export" name = fields.Char('File Name', readonly=True) - # It is implemented in order to manage previous and next versions - # of odoo api_version = fields.Selection( [ ('8.0', '8.0'), - # ('7.0', '7.0') ], 'API version', required=True,