Metadata-Version: 2.1
Name: odoo-addon-base_external_system_odoorpc
Version: 16.0.1.0.0.3
Summary: Connect to a remote Odoo instance via the odoorpc library.
Home-page: https://github.com/OCA/server-backend
Author: Therp BV, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.10
Requires-Dist: odoo-addon-base-external-system<16.1dev,>=16.0dev
Requires-Dist: odoo<16.1dev,>=16.0a
Requires-Dist: odoorpc

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=============================
Base External System Odoo-rpc
=============================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:47c4207de3606e41b1c5d3a2309fcf4cae132e249ecb0deed8fc46221f9362ed
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
    :target: https://github.com/OCA/server-backend/tree/16.0/base_external_system_odoorpc
    :alt: OCA/server-backend
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-backend-16-0/server-backend-16-0-base_external_system_odoorpc
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=16.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

============================
Base External System OdooRPC
============================

This module adds an *external system adapter* for connecting to another Odoo instance
using the Python ``odoorpc`` client (JSON-RPC).

It is built on top of ``base_external_system`` and implements a new adapter model:

* ``external.system.odoo`` (System Type: *External System RPC*)

The adapter supports:

* Validating required connection parameters (host, port, database, username, password)
* Optional SSL transport (JSON-RPC over SSL)
* A context-managed client lifecycle via the ``base_external_system`` adapter contract
  (open client, perform calls, logout/cleanup)

Typical use cases include:

* Reading data from a legacy Odoo (e.g. Odoo 8/9/10) into a newer Odoo (e.g. Odoo 16)
* Synchronizations, migrations, or import tools that must query remote models
  (e.g. ``stock.production.lot``, ``stock.move``, ``res.partner``) via RPC

**Table of contents**

.. contents::
   :local:

Installation
============

This module requires the Python package ``odoorpc`` to be installed in the same
environment as your Odoo server.

Install it with pip, for example::

    pip install odoorpc

Then install the Odoo module in the Apps menu as usual.

If you run Odoo in Docker or another containerized setup, ensure the dependency
is present in the image that runs the Odoo server.

Configuration
=============

1. Go to *Settings → External Systems* (menu provided by ``base_external_system``).
2. Create a new record.
3. Set **System Type** to *External System RPC* (``external.system.odoo``).
4. Fill in the connection parameters:

   * Host (e.g. ``odoo-test.odoo.org``)
   * Port (e.g. ``443`` or ``8069``)
   * Database name
   * Username
   * Password
   * SSL toggle (if applicable)

5. Save the record.

After saving, the adapter interface record is created automatically by
``base_external_system`` and is available via the ``interface`` field.

Usage
=====

Test connection (UI)


Open an external system record configured with System Type *External System RPC*
and click the *Test Connection* button.

If successful, the adapter will report success (using the success mechanism
provided by ``base_external_system``).

Using the client in code


Use the standard context manager from ``base_external_system``::

    system = self.env.ref("your_module.external_system_odoo_remote")
    with system.client() as odoo:
        partner_model = odoo.env["res.partner"]
        ids = partner_model.search([("is_company", "=", True)], limit=10)
        data = partner_model.read(ids, ["name"])

The yielded object is an ``odoorpc.ODOO`` client instance, so any remote model can be
accessed via ``odoo.env["model.name"]``.

Legacy helper (optional)


Some projects historically called a helper directly on the adapter record::

    odoo = system.interface._connect()

If your adapter keeps that helper for backward compatibility, it returns the same
client object as ``external_get_client()``.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_external_system_odoorpc%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Therp BV

Contributors
~~~~~~~~~~~~

* Therp BV <https://therp.nl>
* Nikos Tsirintanis <ntsirintanis@therp.nl>

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/16.0/base_external_system_odoorpc>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
