==========
Components
==========
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:a17ffda475316eda129ff24559c5cd3822c3698fa06e1f22e4e64e400a446e2a
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
:target: https://odoo-community.org/page/development-status
:alt: Production/Stable
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github
:target: https://github.com/OCA/connector/tree/17.0/component
:alt: OCA/connector
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/connector-17-0/connector-17-0-component
: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/connector&target_branch=17.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module implements a component system and is a base block for the
Connector Framework. It can be used without using the full Connector
though.
Documentation: http://odoo-connector.com/
You may also want to check the `Introduction to Odoo
Components <https://dev.to/guewen/introduction-to-odoo-components-bn0>`__
by @guewen.
**Table of contents**
.. contents::
:local:
Usage
=====
As a developer, you have access to a component system. You can find the
documentation in the code or on http://odoo-connector.com
In a nutshell, you can create components:
::
from odoo.addons.component.core import Component
class MagentoPartnerAdapter(Component):
_name = 'magento.partner.adapter'
_inherit = 'magento.adapter'
_usage = 'backend.adapter'
_collection = 'magento.backend'
_apply_on = ['res.partner']
And later, find the component you need at runtime (dynamic dispatch at
component level):
::
def run(self, external_id):
backend_adapter = self.component(usage='backend.adapter')
external_data = backend_adapter.read(external_id)
In order for tests using components to work, you will need to use the
base class provided by \`odoo.addons.component.tests.common\`:
- TransactionComponentCase
There are also some specific base classes for testing the component
registry, using the ComponentRegistryCase as a base class. See the
docstrings in tests/common.py.
Changelog
=========
16.0.1.0.0 (2022-10-04)
-----------------------
- [MIGRATION] from 15.0
15.0.1.0.0 (2021-11-25)
-----------------------
- [MIGRATION] from 14.0
14.0.1.0.0 (2020-10-22)
-----------------------
- [MIGRATION] from 13.0
13.0.1.0.0 (2019-10-23)
-----------------------
- [MIGRATION] from 12.0
12.0.1.0.0 (2018-10-02)
-----------------------
- [MIGRATION] from 11.0 branched at rev. 324e006
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector/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/connector/issues/new?body=module:%20component%0Aversion:%2017.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
-------
* Camptocamp
Contributors
------------
- Guewen Baconnier <guewen.baconnier@camptocamp.com>
- Laurent Mignon <laurent.mignon@acsone.eu>
- Simone Orsi <simone.orsi@camptocamp.com>
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.
.. |maintainer-guewen| image:: https://github.com/guewen.png?size=40px
:target: https://github.com/guewen
:alt: guewen
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-guewen|
This module is part of the `OCA/connector <https://github.com/OCA/connector/tree/17.0/component>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/connector",
"name": "odoo-addon-component",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Camptocamp,Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": null,
"description": "==========\nComponents\n==========\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:a17ffda475316eda129ff24559c5cd3822c3698fa06e1f22e4e64e400a446e2a\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png\n :target: https://odoo-community.org/page/development-status\n :alt: Production/Stable\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github\n :target: https://github.com/OCA/connector/tree/17.0/component\n :alt: OCA/connector\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/connector-17-0/connector-17-0-component\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/connector&target_branch=17.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module implements a component system and is a base block for the\nConnector Framework. It can be used without using the full Connector\nthough.\n\nDocumentation: http://odoo-connector.com/\n\nYou may also want to check the `Introduction to Odoo\nComponents <https://dev.to/guewen/introduction-to-odoo-components-bn0>`__\nby @guewen.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUsage\n=====\n\nAs a developer, you have access to a component system. You can find the\ndocumentation in the code or on http://odoo-connector.com\n\nIn a nutshell, you can create components:\n\n::\n\n from odoo.addons.component.core import Component\n\n class MagentoPartnerAdapter(Component):\n _name = 'magento.partner.adapter'\n _inherit = 'magento.adapter'\n\n _usage = 'backend.adapter'\n _collection = 'magento.backend'\n _apply_on = ['res.partner']\n\nAnd later, find the component you need at runtime (dynamic dispatch at\ncomponent level):\n\n::\n\n def run(self, external_id):\n backend_adapter = self.component(usage='backend.adapter')\n external_data = backend_adapter.read(external_id)\n\nIn order for tests using components to work, you will need to use the\nbase class provided by \\`odoo.addons.component.tests.common\\`:\n\n- TransactionComponentCase\n\nThere are also some specific base classes for testing the component\nregistry, using the ComponentRegistryCase as a base class. See the\ndocstrings in tests/common.py.\n\nChangelog\n=========\n\n16.0.1.0.0 (2022-10-04)\n-----------------------\n\n- [MIGRATION] from 15.0\n\n15.0.1.0.0 (2021-11-25)\n-----------------------\n\n- [MIGRATION] from 14.0\n\n14.0.1.0.0 (2020-10-22)\n-----------------------\n\n- [MIGRATION] from 13.0\n\n13.0.1.0.0 (2019-10-23)\n-----------------------\n\n- [MIGRATION] from 12.0\n\n12.0.1.0.0 (2018-10-02)\n-----------------------\n\n- [MIGRATION] from 11.0 branched at rev. 324e006\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/connector/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/connector/issues/new?body=module:%20component%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Camptocamp\n\nContributors\n------------\n\n- Guewen Baconnier <guewen.baconnier@camptocamp.com>\n- Laurent Mignon <laurent.mignon@acsone.eu>\n- Simone Orsi <simone.orsi@camptocamp.com>\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\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\n.. |maintainer-guewen| image:: https://github.com/guewen.png?size=40px\n :target: https://github.com/guewen\n :alt: guewen\n\nCurrent `maintainer <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-guewen| \n\nThis module is part of the `OCA/connector <https://github.com/OCA/connector/tree/17.0/component>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "Add capabilities to register and use decoupled components, as an alternative to model classes",
"version": "17.0.1.0.0.3",
"project_urls": {
"Homepage": "https://github.com/OCA/connector"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1738fb50ad9578433bd951ed1fbebf04842235a885630f68eb1e514946caaad",
"md5": "7516a0270507db89e0ca3839c63668e0",
"sha256": "733f563080d01b9f3a3785fad8d723d26d7e9f4e23bfd268974e4cf350971fa2"
},
"downloads": -1,
"filename": "odoo_addon_component-17.0.1.0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7516a0270507db89e0ca3839c63668e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 59119,
"upload_time": "2024-02-27T03:15:55",
"upload_time_iso_8601": "2024-02-27T03:15:55.780157Z",
"url": "https://files.pythonhosted.org/packages/a1/73/8fb50ad9578433bd951ed1fbebf04842235a885630f68eb1e514946caaad/odoo_addon_component-17.0.1.0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 03:15:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "connector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo-addon-component"
}
JSON
