-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
8.0 prototype #107
8.0 prototype #107
Changes from 23 commits
75d0073
69db83f
ece36a0
ed68995
d741319
fa90610
1d5041d
616b7b7
4ac7556
60f327b
6dfed35
2eebf02
83855cc
ee0a983
e109b24
ab7700f
02cc47b
6e31ff4
fda47cd
aeb05be
d44e189
dbbd49d
9c095ac
81ba353
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg | ||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html | ||
:alt: License: AGPL-3 | ||
|
||
================= | ||
Module Prototyper | ||
================= | ||
|
||
This module allows the administrator to prototype new features and export them as module. | ||
Functional people can prepare the job for a developer who is left with the logic to implement | ||
in addition to everything the prototype does not export yet. | ||
|
||
Installation | ||
============ | ||
|
||
Make sure you have Jinja2 version 2.7.3 or higher installed:: | ||
|
||
$ pip install --upgrade Jinja2==2.7.3 | ||
|
||
Configuration | ||
============= | ||
|
||
No configuration required. | ||
|
||
Usage | ||
===== | ||
|
||
To use this module, you need to: | ||
|
||
* install the dependencies of your future module | ||
* customize your instance by adding fields and creating inherited views | ||
* create your menu items and their window actions | ||
* prepare your data and demo data by creating filters | ||
* create your own groups with access rights and record rules | ||
* add your own access rights and record rules to an existing group | ||
|
||
Once you have customized your instance properly, you can go to Settings > Module Prototypes > Prototypes | ||
and create a new prototype: | ||
|
||
* fill in the information of your module (enter the name, the description, the logo, etc.) | ||
* in the Depencencies tab, select all the other modules that yours will be depending on | ||
* in the Data & Demo tab, select your filters for data and demo data | ||
* in the Fields tab, select the fields you created or customized | ||
* in the Interface tab, select your menu items and your views | ||
* in the Security tab, select your groups, access rights and record rules | ||
* save and click on export | ||
|
||
You will get a zip file containing your module ready to be installed and compliant with the | ||
conventions of the OCA. You can then provide the module to a developer who have to implement | ||
things like default values or onchange methods. | ||
|
||
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas | ||
:alt: Try me on Runbot | ||
:target: https://runbot.odoo-community.org/runbot/149/8.0 | ||
|
||
Known issues / Roadmap | ||
====================== | ||
|
||
* `#104`_ - Include controllers.py and templates.xml from scaffold. | ||
* Attach images to the prototype and export them to be used in the 'images' module manifest. | ||
* Export reports | ||
* Export workflows, nodes, transitions, actions | ||
* Export groups, access rights and record rules | ||
* Allow selecting and exporting website stuff | ||
|
||
.. _#104: https://github.com/OCA/server-tools/issues/104 | ||
|
||
Bug Tracker | ||
=========== | ||
|
||
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. | ||
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback | ||
`here <https://github.com/OCA/server-tools/issues/new?body=module:%20module_prototyper%0Aversion:%200.3%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Version should be 8.0 (Odoo version), not 0.3 (module version). |
||
|
||
Credits | ||
======= | ||
|
||
Contributors | ||
------------ | ||
|
||
* David Arnold <blaggacao@users.noreply.github.com> | ||
* Jordi Riera <jordi.riera@savoirfairelinux.com> | ||
* Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com> | ||
* El hadji Dem <elhadji.dem@savoirfairelinux.com> | ||
* Savoir-faire Linux <support@savoirfairelinux.com> | ||
* Vincent Vinet <vincent.vinet@savoirfairelinux.com> | ||
|
||
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. | ||
|
||
Changelog | ||
========= | ||
|
||
v0.3 | ||
---- | ||
|
||
* Replace ir.ui.model by ir.ui.view in generated xml views | ||
* Improve pep8 compatibility of generation of models | ||
|
||
v0.2 | ||
---- | ||
|
||
* Renamed from prototype to module_prototyper as discussed in #108 | ||
* Menu in Settings that gather element used to create a prototype (menu views, views, fields) | ||
|
||
v0.1 | ||
---- | ||
|
||
* The set up of openerp.py is covered, description, maintainer, website, name, technical name... | ||
* Views and menus can be set through odoo and gathered in prototype. The files will be automatically generated and add to the data section of the openerp.py. Be aware some advanced feature as domain or context might still missing. | ||
* Dependencies can be set through the Dependencies tab | ||
* Custom fields can be added. A file by model will be generated with all the fields of the model. The init.py files are updated accordingly. Be aware that some features are not implemented yet, as the domain, the context. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# -*- encoding: utf-8 -*- | ||
############################################################################## | ||
# | ||
# OpenERP, Open Source Management Solution | ||
# This module copyright (C) 2010 - 2014 Savoir-faire Linux | ||
# (<http://www.savoirfairelinux.com>). | ||
# | ||
# This program is free software: you can redistribute it and/or modify | ||
# it under the terms of the GNU Affero General Public License as | ||
# published by the Free Software Foundation, either version 3 of the | ||
# License, or (at your option) any later version. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU Affero General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU Affero General Public License | ||
# along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
# | ||
############################################################################## | ||
from . import ( | ||
models, | ||
wizard | ||
) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# -*- encoding: utf-8 -*- | ||
############################################################################## | ||
# | ||
# OpenERP, Open Source Management Solution | ||
# This module copyright (C) 2010 - 2014 Savoir-faire Linux | ||
# (<http://www.savoirfairelinux.com>). | ||
# | ||
# This program is free software: you can redistribute it and/or modify | ||
# it under the terms of the GNU Affero General Public License as | ||
# published by the Free Software Foundation, either version 3 of the | ||
# License, or (at your option) any later version. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU Affero General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU Affero General Public License | ||
# along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
# | ||
############################################################################## | ||
|
||
{ | ||
'name': 'Module Prototyper', | ||
'version': '8.0.0.0.3', | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Version should be 8.0.0.3.0 instead, because all changes done requires a module update, so you should raise y version from x.y.z |
||
'author': 'Savoir-faire Linux, Odoo Community Association (OCA)', | ||
'maintainer': 'Savoir-faire Linux', | ||
'website': 'http://www.savoirfairelinux.com', | ||
'license': 'AGPL-3', | ||
'category': 'Others', | ||
'summary': 'Prototype your module.', | ||
'depends': [ | ||
'admin_technical_features', | ||
], | ||
'external_dependencies': { | ||
'python': [], | ||
}, | ||
'data': [ | ||
'wizard/module_prototyper_module_export_view.xml', | ||
'views/module_prototyper_view.xml', | ||
'views/ir_model_fields_view.xml', | ||
'security/ir.model.access.csv', | ||
], | ||
'installable': True, | ||
'application': True, | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg | ||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html | ||
:alt: License: AGPL-3 | ||
|
||
=========== | ||
Module name | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace with placeholder {module_title} ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This file is loaded as a placeholder for the description. It is not a template. |
||
=========== | ||
|
||
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 ... | ||
|
||
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas | ||
:alt: Try me on Runbot | ||
:target: https://runbot.odoo-community.org/runbot/{repo_id}/{branch} | ||
|
||
.. repo_id is available in https://github.com/OCA/maintainer-tools/blob/master/tools/repos_with_ids.txt | ||
.. branch is "8.0" for example | ||
|
||
For further information, please visit: | ||
|
||
* https://www.odoo.com/forum/help-1 | ||
|
||
Known issues / Roadmap | ||
====================== | ||
|
||
* ... | ||
|
||
Bug Tracker | ||
=========== | ||
|
||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/{project_repo}/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 | ||
`here <https://github.com/OCA/{project_repo}/issues/new?body=module:%20{module_name}%0Aversion:%20{version}%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
|
||
Credits | ||
======= | ||
|
||
Contributors | ||
------------ | ||
|
||
* Firstname Lastname <email.address@example.org> | ||
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These 2 steps are not yet covered by the module, so you should remove them from the usage until the module get support for them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, they are covered, a user can perform those steps.
Data, demo data and security are not exported yet, that's why they appear in the roadmap section.