https://github.com/savoirfairelinux/openerp-pyui
Generate OpenERP XML views through a Python API
https://github.com/savoirfairelinux/openerp-pyui
Last synced: 2 months ago
JSON representation
Generate OpenERP XML views through a Python API
- Host: GitHub
- URL: https://github.com/savoirfairelinux/openerp-pyui
- Owner: savoirfairelinux
- License: agpl-3.0
- Created: 2013-12-12T15:41:15.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-12-18T20:53:26.000Z (over 11 years ago)
- Last Synced: 2025-03-24T21:42:30.595Z (3 months ago)
- Language: Python
- Size: 211 KB
- Stars: 7
- Watchers: 17
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
OpenERP PyUI: Say no to XML madness!
===
PyUI is a Python library made to let OpenERP developers design their views in their Python code
rather than having to write confusing XML. For example, one could write this tree view:
```xml
My Foobar List
foobar.foobar
```
by writing this instead:
```python
from openerp.osv import orm, fields
from pyui import TreeView, ViewManager
class foobar_foobar(orm.Model):
# [...]
class FoobarViewManager(ViewManager):
def get_tree_view(self):
return TreeView(self, "My Foobar List", columns=['name', 'field1', 'field2'])
FoobarViewManager(foobar_foobar)
```
Installation
---
Clone this repo and run:
python setup.py install
This will install a new ``pyui`` module which you can then import in your OpenERP modules.
How it works
---
OpenERP stores its UI in a ... "battle-scarred" XML format, which is sent to its Javascript web
interface for parsing and UI generation. This XML format is so central to OpenERP that we can't
really get rid of it, but what we can do is make the life of the poor developer easier by
abstracting this XML generation away in a much nicer API.
This is done by overriding ``fields_view_get``, which is called by the JS UI whenever it needs a
view. We then dynamically set the ``arch`` part of the result by creating and rendering wrappers
supplied by this awesome PyUI library.
Compatibility warning
---
It's important to realize that this approach is incompatible with OpenERP XML inheritance model.
When we want to inherit from a view, we refer to it by its "record id", which we don't have with
a Python UI because it doesn't live in the DB.
Inheritance (when we figure out how it will work in the PyUI world) will have to be done exclusively
in the PyUI world.
Alpha status
---
This library is in its infancy and we're still thinking the API as we go, so it's very probably
going to change a lot before it stabilize.
Examples
---
The ``examples`` folder contains demo OpenERP modules using PyUI. You can add this folder to your
addons list and install the modules to try them.