Initial commit: OCA Technical packages (595 packages)

odoo-bringout-oca-connector-connector/connector/README.rst

@@ -0,0 +1,168 @@
+=========
+Connector
+=========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:89e6132419a9388e31f1e1919ac881f45189d2c51e4bd383a41174d51c984b60
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/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/16.0/connector
+    :alt: OCA/connector
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/connector-16-0/connector-16-0-connector
+    :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=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This is a framework designed to build connectors with external systems,
+usually called ``Backends`` in the documentation.
+
+Documentation: http://odoo-connector.com
+
+It features:
+
+* A jobs queue
+
+    In which the connectors can push functions (synchronization tasks)
+    to be executed later.
+
+* An event pattern
+
+    The connectors can subscribe listener functions on the events,
+    executed when the events are fired.
+
+* Connector base classes
+
+    Called ``ConnectorUnit``.
+
+    Include base classes for the use in connectors, ready to be extended:
+
+    * ``Synchronizer``: flow of an import or export
+    * ``Mapper``: transform a record according to mapping rules
+    * ``Binder``: link external IDs with local IDS
+    * ``BackendAdapter``: adapter interface for the exchanges with the backend
+    * But ``ConnectorUnit`` can be extended to accomplish any task
+
+* A multi-backend support
+
+    Each ``ConnectorUnit`` can be registered amongst a backend type (eg.
+    Magento) and a backend version (allow to have a different ``Mapper``
+    for each backend's version for instance)
+
+It is used for example used to connect Magento_ and Prestashop_, but
+also used with Solr, CMIS, ...
+
+.. _Magento: http://odoo-magento-connector.com
+.. _Prestashop: https://github.com/OCA/connector-prestashop
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+This module does nothing on its own.  It is a ground for developing
+advanced connector modules. For further information, please go on:
+http://odoo-connector.com
+
+Changelog
+=========
+
+.. [ The change log. The goal of this file is to help readers
+    understand changes between version. The primary audience is
+    end users and integrators. Purely technical changes such as
+    code refactoring must not be mentioned here.
+
+    This file may contain ONE level of section titles, underlined
+    with the ~ (tilde) character. Other section markers are
+    forbidden and will likely break the structure of the README.rst
+    or other documents where this fragment is included. ]
+
+Next
+~~~~
+
+12.0.1.0.0 (2018-11-26)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* [MIGRATION] from 12.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:%20connector%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
+~~~~~~~
+
+* Camptocamp
+
+Contributors
+~~~~~~~~~~~~
+
+* Guewen Baconnier at Camptocamp
+* Alexandre Fayolle at Camptocamp
+* Benoit Guillot at Akretion
+* Nicolas Bessi at Camptocamp
+* Joël Grand-Guillaume at Camptocamp
+* Arthur Vuillard at Akretion
+* Sebastien Beau at Akretion
+* Laurent Mignon at Acsone
+* Leonardo Pistone at Camptocamp
+* David Béal at Akretion
+* Christophe Combelles at Anybox
+* Stéphane Bidoul at Acsone
+* Malte Jacobi at IBO / HTW
+* Laetitia Gangloff at Acsone
+* David Lefever at Taktik S.A.
+* Jos de Graeve at Apertoso NV
+* Jean-Sébastien Suzanne at Anybox
+* Leonardo Donelli at MONK Software
+* Mathias Colpaert
+* Yannick Vaucher at Camptocamp
+* Nicolas Piganeau at NDP Systèmes
+* Florent Thomas at Mind And Go
+* Matthieu Dietrich at Camptocamp
+* Olivier Laurent at Acsone
+* Eric Antones at NuoBiT Solutions S.L.
+* Asier Neira at Factor Libre S.L.
+
+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/connector <https://github.com/OCA/connector/tree/16.0/connector>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.