=======
OdooRPC
=======
.. image:: https://img.shields.io/pypi/v/OdooRPC.svg
:target: https://pypi.python.org/pypi/OdooRPC/
:alt: Latest Version
.. image:: https://travis-ci.org/OCA/odoorpc.svg?branch=master
:target: https://travis-ci.org/OCA/odoorpc
:alt: Build Status
.. image:: https://img.shields.io/pypi/pyversions/OdooRPC.svg
:target: https://pypi.python.org/pypi/OdooRPC/
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/l/OdooRPC.svg
:target: https://pypi.python.org/pypi/OdooRPC/
:alt: License
**OdooRPC** is a Python package providing an easy way to
pilot your **Odoo** servers through `RPC`.
Features supported:
- access to all data model methods (even ``browse``) with an API similar
to the server-side API,
- use named parameters with model methods,
- user context automatically sent providing support for
internationalization,
- browse records,
- execute workflows,
- manage databases,
- reports downloading,
- JSON-RPC protocol (SSL supported),
How does it work? See below:
.. code-block:: python
import odoorpc
# Prepare the connection to the server
odoo = odoorpc.ODOO('localhost', port=8069)
# Check available databases
print(odoo.db.list())
# Login
odoo.login('db_name', 'user', 'passwd')
# Current user
user = odoo.env.user
print(user.name) # name of the user connected
print(user.company_id.name) # the name of its company
# Simple 'raw' query
user_data = odoo.execute('res.users', 'read', [user.id])
print(user_data)
# Use all methods of a model
if 'sale.order' in odoo.env:
Order = odoo.env['sale.order']
order_ids = Order.search([])
for order in Order.browse(order_ids):
print(order.name)
products = [line.product_id.name for line in order.order_line]
print(products)
# Update data through a record
user.name = "Brian Jones"
See the documentation for more details and features.
Supported Odoo server versions
==============================
`OdooRPC` is tested on all major releases of `Odoo` (starting from 8.0).
Supported Python versions
=========================
`OdooRPC` support Python 2.7, 3.7+.
License
=======
This software is made available under the `LGPL v3` license.
Generate the documentation
==========================
To generate the documentation, you have to install `Sphinx` documentation
generator::
pip install 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.
Changes in this version
=======================
Consult the ``CHANGELOG`` file.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/odoorpc/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.
Credits
=======
Contributors
------------
* Sébastien Alix <sebastien.alix@osiell.com>
Do not contact contributors directly about support or help with technical issues.
Maintainer
----------
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
This package 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/odoorpc",
"name": "OdooRPC",
"maintainer": "",
"docs_url": "https://pythonhosted.org/OdooRPC/",
"requires_python": "",
"maintainer_email": "",
"keywords": "openerp odoo server rpc client xml-rpc xmlrpc jsonrpc json-rpc odoorpc oerplib communication lib library python service web webservice",
"author": "Sebastien Alix",
"author_email": "seb@usr-src.org",
"download_url": "https://files.pythonhosted.org/packages/cf/0a/9f907fbfefd2486bb4a3faab03f094f03b300b413004f348a3583ecc1898/OdooRPC-0.10.1.tar.gz",
"platform": null,
"description": "=======\nOdooRPC\n=======\n\n.. image:: https://img.shields.io/pypi/v/OdooRPC.svg\n :target: https://pypi.python.org/pypi/OdooRPC/\n :alt: Latest Version\n\n.. image:: https://travis-ci.org/OCA/odoorpc.svg?branch=master\n :target: https://travis-ci.org/OCA/odoorpc\n :alt: Build Status\n\n.. image:: https://img.shields.io/pypi/pyversions/OdooRPC.svg\n :target: https://pypi.python.org/pypi/OdooRPC/\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/pypi/l/OdooRPC.svg\n :target: https://pypi.python.org/pypi/OdooRPC/\n :alt: License\n\n**OdooRPC** is a Python package providing an easy way to\npilot your **Odoo** servers through `RPC`.\n\nFeatures supported:\n - access to all data model methods (even ``browse``) with an API similar\n to the server-side API,\n - use named parameters with model methods,\n - user context automatically sent providing support for\n internationalization,\n - browse records,\n - execute workflows,\n - manage databases,\n - reports downloading,\n - JSON-RPC protocol (SSL supported),\n\nHow does it work? See below:\n\n.. code-block:: python\n\n import odoorpc\n\n # Prepare the connection to the server\n odoo = odoorpc.ODOO('localhost', port=8069)\n\n # Check available databases\n print(odoo.db.list())\n\n # Login\n odoo.login('db_name', 'user', 'passwd')\n\n # Current user\n user = odoo.env.user\n print(user.name) # name of the user connected\n print(user.company_id.name) # the name of its company\n\n # Simple 'raw' query\n user_data = odoo.execute('res.users', 'read', [user.id])\n print(user_data)\n\n # Use all methods of a model\n if 'sale.order' in odoo.env:\n Order = odoo.env['sale.order']\n order_ids = Order.search([])\n for order in Order.browse(order_ids):\n print(order.name)\n products = [line.product_id.name for line in order.order_line]\n print(products)\n\n # Update data through a record\n user.name = \"Brian Jones\"\n\nSee the documentation for more details and features.\n\nSupported Odoo server versions\n==============================\n\n`OdooRPC` is tested on all major releases of `Odoo` (starting from 8.0).\n\nSupported Python versions\n=========================\n\n`OdooRPC` support Python 2.7, 3.7+.\n\nLicense\n=======\n\nThis software is made available under the `LGPL v3` license.\n\nGenerate the documentation\n==========================\n\nTo generate the documentation, you have to install `Sphinx` documentation\ngenerator::\n\n pip install sphinx\n\nThen, you can use the ``build_doc`` option of the ``setup.py``::\n\n python setup.py build_doc\n\nThe generated documentation will be in the ``./doc/build/html`` directory.\n\nChanges in this version\n=======================\n\nConsult the ``CHANGELOG`` file.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues\n<https://github.com/OCA/odoorpc/issues>`_. In case of trouble, please\ncheck there if your issue has already been reported. If you spotted it first,\nhelp us smash it by providing detailed and welcomed feedback.\n\nCredits\n=======\n\nContributors\n------------\n\n* S\u00e9bastien Alix <sebastien.alix@osiell.com>\n\nDo not contact contributors directly about support or help with technical issues.\n\nMaintainer\n----------\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nThis package is maintained by the OCA.\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n",
"bugtrack_url": null,
"license": "LGPL v3",
"summary": "OdooRPC is a Python package providing an easy way to pilot your Odoo servers through RPC.",
"version": "0.10.1",
"project_urls": {
"Homepage": "https://github.com/OCA/odoorpc"
},
"split_keywords": [
"openerp",
"odoo",
"server",
"rpc",
"client",
"xml-rpc",
"xmlrpc",
"jsonrpc",
"json-rpc",
"odoorpc",
"oerplib",
"communication",
"lib",
"library",
"python",
"service",
"web",
"webservice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20608c5ea2a63151d6c1215e127909eeee3c16e792bbae92ab596dd921d6669d",
"md5": "ece460bdeaf050806c537b08105b5c38",
"sha256": "a0900bdd5c989c414b1ef40dafccd9363f179312d9166d9486cf70c7c2f0dd44"
},
"downloads": -1,
"filename": "OdooRPC-0.10.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ece460bdeaf050806c537b08105b5c38",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 38482,
"upload_time": "2023-08-16T09:13:40",
"upload_time_iso_8601": "2023-08-16T09:13:40.800208Z",
"url": "https://files.pythonhosted.org/packages/20/60/8c5ea2a63151d6c1215e127909eeee3c16e792bbae92ab596dd921d6669d/OdooRPC-0.10.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf0a9f907fbfefd2486bb4a3faab03f094f03b300b413004f348a3583ecc1898",
"md5": "77f9f4a309df6a4f47194f1b816eb449",
"sha256": "d0bc524c5b960781165575bad9c13d032d6f968c3c09276271045ddbbb483aa5"
},
"downloads": -1,
"filename": "OdooRPC-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "77f9f4a309df6a4f47194f1b816eb449",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58086,
"upload_time": "2023-08-16T09:13:42",
"upload_time_iso_8601": "2023-08-16T09:13:42.346725Z",
"url": "https://files.pythonhosted.org/packages/cf/0a/9f907fbfefd2486bb4a3faab03f094f03b300b413004f348a3583ecc1898/OdooRPC-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-16 09:13:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "odoorpc",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "odoorpc"
}
JSON
