OpenERP client library which allows to easily interact with an OpenERP server.
Project description
OERPLib is a client library to OpenERP server. It aims to provide an easy way to remotely pilot an OpenERP server.
- Features supported:
XML-RPC and Net-RPC protocols,
access to all methods proposed by an OpenERP model class (even browse) with an API similar to the server-side API,
ability to use named parameters with such methods (OpenERP >= 6.1),
user context automatically sent (OpenERP >= 6.1),
browse records,
execute workflows,
manage databases,
reports downloading.
How does it work? See below:
import oerplib
# Prepare the connection to the OpenERP server
oerp = oerplib.OERP('localhost', protocol='xmlrpc', port=8069)
# Check available databases
print(oerp.db.list())
# Login (the object returned is a browsable record)
user = oerp.login('user', 'passwd', 'db_name')
print(user.name) # name of the user connected
print(user.company_id.name) # the name of its company
# Simple 'raw' query
user_data = oerp.execute('res.users', 'read', [user.id])
print(user_data)
# Use all methods of an OSV class
order_obj = oerp.get('sale.order')
order_ids = order_obj.search([])
for order in order_obj.browse(order_ids):
print(order.name)
products = [line.product_id.name for line in order.order_line]
print(products)
# Update data through a browsable record
user.name = "Brian Jones"
oerp.write_record(user)
See the documentation for more details.
Supported OpenERP versions
OERPLib has been tested on OpenERP server v5.0, v6.0, v6.1 and v7.0. It should work on next versions if OpenERP keeps a stable API.
Supported Python versions
OERPLib support Python versions 2.6 and 2.7.
Generate the documentation
To generate the documentation, you have to install Sphinx documentation generator:
easy_install -U sphinx
Then, you can use the build_doc option of the setup.py:
python setup.py build_doc
The generated documentation will be in the ./doc/build/html directory.
Bugs or suggestions
Please, feel free to report bugs or suggestions in the Bug Tracker!
Changes in this version
Consult the CHANGES.txt file.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
