Welcome to OERPLib’s documentation!


OERPLib is a RPC client library to OpenERP server written in Python. It aims to provide an easy way to remotely pilot an OpenERP server.

Features supported:
  • XML-RPC and (legacy) 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) providing support for internationalization,
  • browse records,
  • execute workflows,
  • manage databases,
  • reports downloading,
  • inspection capabilities (graphical output of relations between models and dependencies between modules, list on_change methods from model views, ...).

Quick start

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

# 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])

# Use all methods of a model class
order_obj = oerp.get('sale.order')
order_ids = order_obj.search([])
for order in order_obj.browse(order_ids):
    products = [line.product_id.name for line in order.order_line]

# Update data through a browsable record
user.name = "Brian Jones"

For more details and features, see the tutorials, the Frequently Asked Questions (FAQ) and the API reference sections.

Supported OpenERP versions

OERPLib has been tested on OpenERP server v5.0, v6.0, v6.1, v7.0 and v8.0. It should work on next versions if OpenERP keeps a stable API.

Supported Python versions

OERPLib support Python versions 2.6, 2.7.


This software is made available under the LGPL v3 license.

Bugs or suggestions

Please, feel free to report bugs or suggestions in the Bug Tracker!

Make a donation

OERPLib is mainly developed on free time. To show your appreciation and support this project, it is possible to make a donation through PayPal:

Indices and tables