oerplib3


Nameoerplib3 JSON
Version 0.8.5 PyPI version JSON
download
home_pagehttps://zeroincombenze-tools.readthedocs.io
SummaryPython3 oerlib porting
upload_time2024-08-21 16:55:52
maintainerNone
docs_urlNone
authorSébastien Alix, Antonio Maria Vigliotti
requires_pythonNone
licenseAffero GPL
keywords openerp odoo server client xml-rpc xmlrpc net-rpc netrpc webservice
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ================
oerplib3 2.0.0.5
================



|Maturity| |license gpl|



Overview
========

OERPLib3 is a Python module providing an easy way to pilot
your OpenERP and Odoo servers through RPC.

It is a fork for python3 of `OERPLib project <https://github.com/osiell/oerplib>`__
by Sébastien Alix who have not participated to development of this module.



Features
--------

+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| Oerplib3                                                                                 | Oerplib                                                | OdooRPC                                    |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| XML-RPC protocols                                                                        |  XML-RPC and (legacy) Net-RPC protocols                | JSON RPC                                   |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| Transfer from Odoo >= 6.1 <= 9.0 to Odoo >= 11.0                                         | Transfer from Odoo >= 6.1 <= 9.0 to Odoo >= 6.1 <= 9.0 | Transfer from Odoo >= 10.0 to Odoo >= 10.0 |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| access to all methods proposed by a model class (even browse)                            | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| ability to use named parameters with such methods (Odoo >= 6.1)                          | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| user context automatically sent (Odoo >= 6.1) providing support for internationalization | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| browse records                                                                           | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| execute workflows                                                                        | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| manage databases                                                                         | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| reports downloading                                                                      | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+
| inspection capabilities                                                                  | |same|                                                 | |same|                                     |
+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+



Usage
=====

This module work exactly like original
`OERPLib <https://github.com/osiell/oerplib>`__

::

    import oerplib3 as oerplib

    # Prepare the connection to the 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)



Getting started
===============


Prerequisites
-------------

Zeroincombenze tools requires:

* Linux Centos 7/8 or Debian 9/10 or Ubuntu 18/20/22
* python 2.7+, some tools require python 3.6+, best python 3.8+
* bash 5.0+



Installation
------------

Stable version via Python Package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    pip install oerplib3

Current version via Git
~~~~~~~~~~~~~~~~~~~~~~~

::

    cd $HOME
    [[ ! -d ./tools ]] && git clone https://github.com/zeroincombenze/tools.git
    cd ./tools
    ./install_tools.sh -pUT
    source $HOME/devel/activate_tools



Upgrade
-------

Stable version via Python Package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    pip install --upgrade oerplib3

Current version via Git
~~~~~~~~~~~~~~~~~~~~~~~

::

    cd ./tools
    ./install_tools.sh -pUT
    source $HOME/devel/activate_tools



ChangeLog History
-----------------

0.8.5 (2024-08-21)
~~~~~~~~~~~~~~~~~~

* [FIX] Python 3.10 porting

0.8.4 (2023-05-06)
~~~~~~~~~~~~~~~~~~

* [FIX] First porting



FAQ
---

**Why this module was forked from OERPlib?**

OERPlib runs just with python2 and the author did not migrate
package on python3

**Why I should use this module? Was it better to use OdooRPC?**

OdooRPC runs on python3 but it does not support Odoo xmlrpc protocol.
So, if you have to read data from an old Odoo version database, you have to
use OERPlib3.



Credits
=======

Copyright
---------

SHS-AV s.r.l. <https://www.shs-av.com/>


Authors
-------

* Sébastien Alix <False>
* `SHS-AV s.r.l. <https://www.zeroincombenze.it>`__



Contributors
------------

* `Antonio Maria Vigliotti <antoniomaria.vigliotti@gmail.com>`__


|
|

.. |Maturity| image:: https://img.shields.io/badge/maturity-Alfa-black.png
    :target: https://odoo-community.org/page/development-status
    :alt: 
.. |license gpl| image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |license opl| image:: https://img.shields.io/badge/licence-OPL-7379c3.svg
    :target: https://www.odoo.com/documentation/user/9.0/legal/licenses/licenses.html
    :alt: License: OPL
.. |Tech Doc| image:: https://www.zeroincombenze.it/wp-content/uploads/ci-ct/prd/button-docs-2.svg
    :target: https://wiki.zeroincombenze.org/en/Odoo/2.0.0/dev
    :alt: Technical Documentation
.. |Help| image:: https://www.zeroincombenze.it/wp-content/uploads/ci-ct/prd/button-help-2.svg
    :target: https://wiki.zeroincombenze.org/it/Odoo/2.0.0/man
    :alt: Technical Documentation
.. |Try Me| image:: https://www.zeroincombenze.it/wp-content/uploads/ci-ct/prd/button-try-it-2.svg
    :target: https://erp2.zeroincombenze.it
    :alt: Try Me
.. |Zeroincombenze| image:: https://avatars0.githubusercontent.com/u/6972555?s=460&v=4
   :target: https://www.zeroincombenze.it/
   :alt: Zeroincombenze
.. |en| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/flags/en_US.png
   :target: https://www.facebook.com/Zeroincombenze-Software-gestionale-online-249494305219415/
.. |it| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/flags/it_IT.png
   :target: https://www.facebook.com/Zeroincombenze-Software-gestionale-online-249494305219415/
.. |check| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/check.png
.. |no_check| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/no_check.png
.. |menu| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/menu.png
.. |right_do| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/right_do.png
.. |exclamation| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/exclamation.png
.. |warning| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/warning.png
.. |same| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/same.png
.. |late| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/late.png
.. |halt| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/halt.png
.. |info| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/info.png
.. |xml_schema| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/certificates/iso/icons/xml-schema.png
   :target: https://github.com/zeroincombenze/grymb/blob/master/certificates/iso/scope/xml-schema.md
.. |DesktopTelematico| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/certificates/ade/icons/DesktopTelematico.png
   :target: https://github.com/zeroincombenze/grymb/blob/master/certificates/ade/scope/Desktoptelematico.md
.. |FatturaPA| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/certificates/ade/icons/fatturapa.png
   :target: https://github.com/zeroincombenze/grymb/blob/master/certificates/ade/scope/fatturapa.md
.. |chat_with_us| image:: https://www.shs-av.com/wp-content/chat_with_us.gif
   :target: https://t.me/Assitenza_clienti_powERP
            

Raw data

            {
    "_id": null,
    "home_page": "https://zeroincombenze-tools.readthedocs.io",
    "name": "oerplib3",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "openerp odoo server client xml-rpc xmlrpc net-rpc netrpc webservice",
    "author": "S\u00e9bastien Alix, Antonio Maria Vigliotti",
    "author_email": "antoniomaria.vigliotti@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/42/77/2d74d8ad2dc79b7d97f529b42b0b3eb245535ff5d7e27205f4afd55fb115/oerplib3-0.8.5.tar.gz",
    "platform": null,
    "description": "================\noerplib3 2.0.0.5\n================\n\n\n\n|Maturity| |license gpl|\n\n\n\nOverview\n========\n\nOERPLib3 is a Python module providing an easy way to pilot\nyour OpenERP and Odoo servers through RPC.\n\nIt is a fork for python3 of `OERPLib project <https://github.com/osiell/oerplib>`__\nby S\u00e9bastien Alix who have not participated to development of this module.\n\n\n\nFeatures\n--------\n\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| Oerplib3                                                                                 | Oerplib                                                | OdooRPC                                    |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| XML-RPC protocols                                                                        |  XML-RPC and (legacy) Net-RPC protocols                | JSON RPC                                   |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| Transfer from Odoo >= 6.1 <= 9.0 to Odoo >= 11.0                                         | Transfer from Odoo >= 6.1 <= 9.0 to Odoo >= 6.1 <= 9.0 | Transfer from Odoo >= 10.0 to Odoo >= 10.0 |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| access to all methods proposed by a model class (even browse)                            | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| ability to use named parameters with such methods (Odoo >= 6.1)                          | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| user context automatically sent (Odoo >= 6.1) providing support for internationalization | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| browse records                                                                           | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| execute workflows                                                                        | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| manage databases                                                                         | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| reports downloading                                                                      | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n| inspection capabilities                                                                  | |same|                                                 | |same|                                     |\n+------------------------------------------------------------------------------------------+--------------------------------------------------------+--------------------------------------------+\n\n\n\nUsage\n=====\n\nThis module work exactly like original\n`OERPLib <https://github.com/osiell/oerplib>`__\n\n::\n\n    import oerplib3 as oerplib\n\n    # Prepare the connection to the server\n    oerp = oerplib.OERP('localhost', protocol='xmlrpc', port=8069)\n\n    # Check available databases\n    print(oerp.db.list())\n\n    # Login (the object returned is a browsable record)\n    user = oerp.login('user', 'passwd', 'db_name')\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 = oerp.execute('res.users', 'read', [user.id])\n    print(user_data)\n\n    # Use all methods of an OSV class\n    order_obj = oerp.get('sale.order')\n    order_ids = order_obj.search([])\n    for order in order_obj.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 browsable record\n    user.name = \"Brian Jones\"\n    oerp.write_record(user)\n\n\n\nGetting started\n===============\n\n\nPrerequisites\n-------------\n\nZeroincombenze tools requires:\n\n* Linux Centos 7/8 or Debian 9/10 or Ubuntu 18/20/22\n* python 2.7+, some tools require python 3.6+, best python 3.8+\n* bash 5.0+\n\n\n\nInstallation\n------------\n\nStable version via Python Package\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n    pip install oerplib3\n\nCurrent version via Git\n~~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n    cd $HOME\n    [[ ! -d ./tools ]] && git clone https://github.com/zeroincombenze/tools.git\n    cd ./tools\n    ./install_tools.sh -pUT\n    source $HOME/devel/activate_tools\n\n\n\nUpgrade\n-------\n\nStable version via Python Package\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n    pip install --upgrade oerplib3\n\nCurrent version via Git\n~~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n    cd ./tools\n    ./install_tools.sh -pUT\n    source $HOME/devel/activate_tools\n\n\n\nChangeLog History\n-----------------\n\n0.8.5 (2024-08-21)\n~~~~~~~~~~~~~~~~~~\n\n* [FIX] Python 3.10 porting\n\n0.8.4 (2023-05-06)\n~~~~~~~~~~~~~~~~~~\n\n* [FIX] First porting\n\n\n\nFAQ\n---\n\n**Why this module was forked from OERPlib?**\n\nOERPlib runs just with python2 and the author did not migrate\npackage on python3\n\n**Why I should use this module? Was it better to use OdooRPC?**\n\nOdooRPC runs on python3 but it does not support Odoo xmlrpc protocol.\nSo, if you have to read data from an old Odoo version database, you have to\nuse OERPlib3.\n\n\n\nCredits\n=======\n\nCopyright\n---------\n\nSHS-AV s.r.l. <https://www.shs-av.com/>\n\n\nAuthors\n-------\n\n* S\u00e9bastien Alix <False>\n* `SHS-AV s.r.l. <https://www.zeroincombenze.it>`__\n\n\n\nContributors\n------------\n\n* `Antonio Maria Vigliotti <antoniomaria.vigliotti@gmail.com>`__\n\n\n|\n|\n\n.. |Maturity| image:: https://img.shields.io/badge/maturity-Alfa-black.png\n    :target: https://odoo-community.org/page/development-status\n    :alt: \n.. |license gpl| image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg\n    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n    :alt: License: AGPL-3\n.. |license opl| image:: https://img.shields.io/badge/licence-OPL-7379c3.svg\n    :target: https://www.odoo.com/documentation/user/9.0/legal/licenses/licenses.html\n    :alt: License: OPL\n.. |Tech Doc| image:: https://www.zeroincombenze.it/wp-content/uploads/ci-ct/prd/button-docs-2.svg\n    :target: https://wiki.zeroincombenze.org/en/Odoo/2.0.0/dev\n    :alt: Technical Documentation\n.. |Help| image:: https://www.zeroincombenze.it/wp-content/uploads/ci-ct/prd/button-help-2.svg\n    :target: https://wiki.zeroincombenze.org/it/Odoo/2.0.0/man\n    :alt: Technical Documentation\n.. |Try Me| image:: https://www.zeroincombenze.it/wp-content/uploads/ci-ct/prd/button-try-it-2.svg\n    :target: https://erp2.zeroincombenze.it\n    :alt: Try Me\n.. |Zeroincombenze| image:: https://avatars0.githubusercontent.com/u/6972555?s=460&v=4\n   :target: https://www.zeroincombenze.it/\n   :alt: Zeroincombenze\n.. |en| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/flags/en_US.png\n   :target: https://www.facebook.com/Zeroincombenze-Software-gestionale-online-249494305219415/\n.. |it| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/flags/it_IT.png\n   :target: https://www.facebook.com/Zeroincombenze-Software-gestionale-online-249494305219415/\n.. |check| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/check.png\n.. |no_check| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/no_check.png\n.. |menu| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/menu.png\n.. |right_do| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/right_do.png\n.. |exclamation| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/exclamation.png\n.. |warning| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/warning.png\n.. |same| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/same.png\n.. |late| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/late.png\n.. |halt| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/halt.png\n.. |info| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/awesome/info.png\n.. |xml_schema| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/certificates/iso/icons/xml-schema.png\n   :target: https://github.com/zeroincombenze/grymb/blob/master/certificates/iso/scope/xml-schema.md\n.. |DesktopTelematico| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/certificates/ade/icons/DesktopTelematico.png\n   :target: https://github.com/zeroincombenze/grymb/blob/master/certificates/ade/scope/Desktoptelematico.md\n.. |FatturaPA| image:: https://raw.githubusercontent.com/zeroincombenze/grymb/master/certificates/ade/icons/fatturapa.png\n   :target: https://github.com/zeroincombenze/grymb/blob/master/certificates/ade/scope/fatturapa.md\n.. |chat_with_us| image:: https://www.shs-av.com/wp-content/chat_with_us.gif\n   :target: https://t.me/Assitenza_clienti_powERP",
    "bugtrack_url": null,
    "license": "Affero GPL",
    "summary": "Python3 oerlib porting",
    "version": "0.8.5",
    "project_urls": {
        "Documentation": "https://zeroincombenze-tools.readthedocs.io",
        "Homepage": "https://zeroincombenze-tools.readthedocs.io",
        "Source": "https://github.com/zeroincombenze/tools"
    },
    "split_keywords": [
        "openerp",
        "odoo",
        "server",
        "client",
        "xml-rpc",
        "xmlrpc",
        "net-rpc",
        "netrpc",
        "webservice"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42772d74d8ad2dc79b7d97f529b42b0b3eb245535ff5d7e27205f4afd55fb115",
                "md5": "61e8427f0aa2db7b933ac393f5091b13",
                "sha256": "b690f77afe3f3f4618d466447ba5e0d25e0ab49fcbc578bb36e2f940a856d14c"
            },
            "downloads": -1,
            "filename": "oerplib3-0.8.5.tar.gz",
            "has_sig": false,
            "md5_digest": "61e8427f0aa2db7b933ac393f5091b13",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 38720,
            "upload_time": "2024-08-21T16:55:52",
            "upload_time_iso_8601": "2024-08-21T16:55:52.712309Z",
            "url": "https://files.pythonhosted.org/packages/42/77/2d74d8ad2dc79b7d97f529b42b0b3eb245535ff5d7e27205f4afd55fb115/oerplib3-0.8.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-21 16:55:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zeroincombenze",
    "github_project": "tools",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "lcname": "oerplib3"
}
        
Elapsed time: 1.05827s