DFranch / odoo-client-api

Odoo - Python Client API

Odoo Client Library

Very SIMPLE and STUPID Pythonic Odoo Client Library to make-use-of Odoo WebServices. It is designed to wrap all XML RPC Technicality into more object-orientated meaning of programming using class and dedicated Methods.

Features:

• Basic-Generic ORM API (create, read, write, unlink ...) CRUD.
• Generic ORM Research API (search, search_read, search_count, name_search ...).
• Generic superset Method to avoid implmentation (symmetric code but need to be attentive).
• Dedicated WORKFLOW Methods to drive business process smoothly.
• Easy SaaS/HTTPS or Local Instance/Database Connection styles.

##Usage:

• Add api directory odooclient to project.
• Import from odooclient import client.

##Below are examples of odoo-client-api usage :

##Saas Test

from odooclient import client

odoo = client.OdooClient( host='demo.odoo.com', dbname='firebug', saas=True, debug=True)
odoo.ServerInfo()
odoo.Authenticate('admin', 'admin')

##SaaS Security Test

from odooclient import client

odoo = client.OdooClient( host='demo.odoo.com', dbname='firebug', saas=True, debug=True)
odoo.Authenticate('[e-mail]', 'a')
odoo.CheckSecurity('res.users', ['create'])
odoo.CheckSecurity('res.partner')

##Local Test

from odooclient import client

odoo = client.OdooClient(protocol='xmlrpc', host='localhost', dbname='test', port=8069, debug=True)
odoo.ServerInfo()
odoo.Authenticate('admin', 'admin')
odoo.Read('res.partner', [1, 2], fields=['name'])
rid = odoo.Create('res.partner', {'name': "Odoo"})
odoo.SearchCount('res.partner')
odoo.Write('res.partner', [rid], {'name': 'Odoo'})
odoo.Search('res.partner', [('name', 'like', 'Odoo')], order='id desc')
odoo.SearchRead('res.partner', [('name', 'like', 'Odoo')], ['name'])
odoo.GetFields('res.partner')
odoo.Copy('res.partner', record_id,{'name': "jigar"})
odoo.NameCreate('res.partner',"jigar")
allids = [o[0] for o in odoo.NameSearch("res.partner", "jigar")]
odoo.Unlink("res.partner", allids)

##Local Security Test

from odooclient import client

odoo = client.OdooClient(protocol='xmlrpc', host='localhost', dbname='test', port=8069, debug=True)
odoo.Authenticate('demo', 'demo')
odoo.CheckSecurity('res.users', ['create'])
odoo.CheckSecurity('res.partner' )

###Generic method Method

For More Control Over API , Generic Method is also implemented, where you can call any method from API, but you have to care full in passing Params :

Method create with odoo-client-lib API look like :

    odoo.Create('res.partner', {'name': "Odoo"})

But this can be also called using Generic method Methodwhich look like:

   odoo.Method('res.partner', 'create', {'name': "Odoo"})

This sounds more Raw and generic but doesn't make difference in this case as create being generic ORM method, but any method implementation specific to Model can be called using Method, this enable Extended API feature.

###Workflow methods :

Odoo has every powerful workflow engine and the lib facilitate you workflow engine methods like Create workflow for some record, or delete the workflow, validate workflow, trigger workflow signals. Below are example of all available methods that can be used. Suport for worflow is for Odoo/OpenERP v9 or earlier versionoly, from Odoov10 the workflow engone is discontinued.

from odooclient import client

odoo = client.OdooClient(protocol='xmlrpc', host='localhost', dbname='asd', port=8069, debug=True)
odoo.Authenticate('admin', 'admin')
print odoo.UnlinkWorkflow('account.invoice', 58328)
print odoo.CreateWorkflow('account.invoice', 58328)
print odoo.StepWorkflow('account.invoice', 58328)
print odoo.SignalWorkflow('account.invoice', 58328, 'invoice_open')
print odoo.RedirectWorkflow('account.invoice', [(58328,58329)])

Note: This is Still development copy not finalized.

##P.S. :

Feature to be Added are :

• Report Priting API
• Tools lib.
• CSV reader
• Server Friendly Text Sanitizer(Unicode, UTF-8)
• A Fork with ODBC Features.