This module provides an interface/adapter mechanism for the definition of remote systems.
Note that this module stores everything in plain text. In the interest of security, it is recommended you use another module (such as keychain or red_october to encrypt things like the password and private key). This is not done here in order to not force a specific security method.
Table of contents
Configuration
Configure external systems in Settings => Technical => External Systems
Usage
The credentials for systems are stored in the external.system model, and are to be configured by the user. This model is the unified interface for the underlying adapters.
Using the Interface
Given an external.system singleton called external_system, you would do the following to get the underlying system client:
with external_system.client() as client:
client.do_something()The client will be destroyed once the context has completed. Destruction takes place in the adapter’s external_destroy_client method.
The only unified aspect of this interface is the client connection itself. Other more opinionated interface/adapter mechanisms can be implemented in other modules, such as the file system interface in OCA/server-tools/external_file_location.
Creating an Adapter
Modules looking to add an external system adapter should inherit the external.system.adapter model and override the following methods:
external_get_client: Returns a usable client for the system
external_destroy_client: Destroy the connection, if applicable. Does not need to be defined if the connection destroys itself.
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
Dave Lasley <dave@laslabs.com>
Alexandre Díaz <alexandre.diaz@tecnativa.com>
Ronald Portier <ronald@therp.nl>
Maintainers
This module 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.
This module is part of the OCA/server-backend project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 maintainer
Metadata
1 maintainer
Release files for odoo13-addon-base-external-system 13.0.1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| odoo13_addon_base_external_system-13.0.1.0.1-py3-none-any.whl | Python 3 | none | any | Details for odoo13_addon_base_external_system-13.0.1.0.1-py3-none-any.whl |
Release files / odoo13_addon_base_external_system-13.0.1.0.1-py3-none-any.whl
| Download URL | odoo13_addon_base_external_system-13.0.1.0.1-py3-none-any.whl |
|---|---|
| Size | 33.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
539f46429a424b5a2e02126e0d71786e7e6cd4fc8cceb70d6ae391047c73f47c
|
|
BLAKE2b-256 checksum How to use checksums |
bf1e84ceba5938a98e4cad8773817a8be6b9da8404354db14d5c4db58325c5de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.5
|
Security for odoo13-addon-base-external-system 13.0.1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
