From fd5ac1331957b0b14f116a10cfc7f0261be8d8f6 Mon Sep 17 00:00:00 2001 From: Sergio Teruel Albert Date: Wed, 27 Jun 2018 13:00:28 +0200 Subject: [PATCH] [11.0][MIG] base_external_dbsource_mysql: Migration to v11.0 --- base_external_dbsource_mysql/README.rst | 74 ++- base_external_dbsource_mysql/__init__.py | 1 - base_external_dbsource_mysql/__manifest__.py | 19 +- .../i18n/base_external_dbsource_mysql.pot | 2 +- .../models/__init__.py | 2 - .../models/base_external_dbsource.py | 3 +- .../readme/CONFIGURE.rst | 4 + .../readme/CONTRIBUTORS.rst | 5 + .../readme/DESCRIPTION.rst | 2 + .../readme/INSTALL.rst | 5 + .../readme/ROADMAP.rst | 1 + base_external_dbsource_mysql/readme/USAGE.rst | 9 + .../static/description/index.html | 464 ++++++++++++++++++ .../tests/__init__.py | 2 - .../tests/test_base_external_dbsource.py | 1 - 15 files changed, 554 insertions(+), 40 deletions(-) create mode 100644 base_external_dbsource_mysql/readme/CONFIGURE.rst create mode 100644 base_external_dbsource_mysql/readme/CONTRIBUTORS.rst create mode 100644 base_external_dbsource_mysql/readme/DESCRIPTION.rst create mode 100644 base_external_dbsource_mysql/readme/INSTALL.rst create mode 100644 base_external_dbsource_mysql/readme/ROADMAP.rst create mode 100644 base_external_dbsource_mysql/readme/USAGE.rst create mode 100644 base_external_dbsource_mysql/static/description/index.html diff --git a/base_external_dbsource_mysql/README.rst b/base_external_dbsource_mysql/README.rst index 035ba211..0f3cdb4b 100644 --- a/base_external_dbsource_mysql/README.rst +++ b/base_external_dbsource_mysql/README.rst @@ -1,34 +1,61 @@ -.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg - :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html - :alt: License: LGPL-3 - ================================ External Database Source - MySQL ================================ +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fserver--backend-lightgray.png?logo=github + :target: https://github.com/OCA/server-backend/tree/11.0/base_external_dbsource_mysql + :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-11-0/server-backend-11-0-base_external_dbsource_mysql + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/253/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module extends ``base_external_dbsource``, allowing you to connect to foreign MySQL databases using SQLAlchemy. +**Table of contents** +.. contents:: + :local: Installation ============ -* Install ``sqlalchemy`` and ``MySQLdb`` python libraries +To install this module, you need to: + +* Install ``libmysqlclient-dev`` package (``default-libmysqlclient-dev`` on Debian) +* Install ``sqlalchemy`` and ``mysqlclient`` python libraries * Install ``base_external_dbsource_sqlite`` Odoo module Configuration ============= -Database sources can be configured in Settings > Configuration -> Data sources. +To configure this module, you need to: +#. Database sources can be configured in Settings > Technical > + Database Structure > Database sources. Usage ===== To use this module: -* Go to Settings > Database Structure > Database Sources +* Go to Settings > Technical > Database Structure > Database Sources * Click on Create to enter the following information: * Datasource name  @@ -36,45 +63,52 @@ To use this module: * Connector: Choose the database to which you want to connect * Connection string: Specify how to connect to database -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/149/10.0 for server-tools - Known issues / Roadmap ====================== - * Add X.509 authentication Bug Tracker =========== -Bugs are tracked on `GitHub Issues `_. +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. +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 ======= +Authors +~~~~~~~ + +* Daniel Reis +* LasLabs + Contributors ------------- +~~~~~~~~~~~~ * Daniel Reis * Maxime Chambreuil * Gervais Naoussi * Dave Lasley +* Sergio Teruel -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -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. -To contribute to this module, please visit http://odoo-community.org. +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. diff --git a/base_external_dbsource_mysql/__init__.py b/base_external_dbsource_mysql/__init__.py index a0fdc10f..0650744f 100644 --- a/base_external_dbsource_mysql/__init__.py +++ b/base_external_dbsource_mysql/__init__.py @@ -1,2 +1 @@ -# -*- coding: utf-8 -*- from . import models diff --git a/base_external_dbsource_mysql/__manifest__.py b/base_external_dbsource_mysql/__manifest__.py index 1762124b..18dc3583 100644 --- a/base_external_dbsource_mysql/__manifest__.py +++ b/base_external_dbsource_mysql/__manifest__.py @@ -1,29 +1,26 @@ -# -*- coding: utf-8 -*- # Copyright <2011> # Copyright 2016 LasLabs Inc. # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). { 'name': 'External Database Source - MySQL', - 'version': '10.0.1.0.0', + 'version': '11.0.1.0.0', 'category': 'Tools', 'author': "Daniel Reis, " "LasLabs, " "Odoo Community Association (OCA)", - 'website': 'https://github.com/OCA/server-tools', + 'website': 'https://github.com/OCA/server-backend', 'license': 'LGPL-3', 'depends': [ 'base_external_dbsource_sqlite', ], - # Uncomment this for v11 - # 'external_dependencies': [ - # 'python': [ - # 'sqlalchemy', - # 'MySQLdb', - # ] - # ], + 'external_dependencies': { + 'python': [ + 'sqlalchemy', + 'MySQLdb', + ], + }, 'demo': [ 'demo/base_external_dbsource.xml', ], 'installable': True, - 'auto_install': True, # Remove this key for v11 } diff --git a/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot b/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot index 8001d98a..a11eccec 100644 --- a/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot +++ b/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot @@ -4,7 +4,7 @@ # msgid "" msgstr "" -"Project-Id-Version: Odoo Server 10.0\n" +"Project-Id-Version: Odoo Server 11.0\n" "Report-Msgid-Bugs-To: \n" "Last-Translator: <>\n" "Language-Team: \n" diff --git a/base_external_dbsource_mysql/models/__init__.py b/base_external_dbsource_mysql/models/__init__.py index 44b7269b..91032fcb 100644 --- a/base_external_dbsource_mysql/models/__init__.py +++ b/base_external_dbsource_mysql/models/__init__.py @@ -1,3 +1 @@ -# -*- coding: utf-8 -*- - from . import base_external_dbsource diff --git a/base_external_dbsource_mysql/models/base_external_dbsource.py b/base_external_dbsource_mysql/models/base_external_dbsource.py index 660b0130..bf701ce6 100644 --- a/base_external_dbsource_mysql/models/base_external_dbsource.py +++ b/base_external_dbsource_mysql/models/base_external_dbsource.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2011 Daniel Reis # Copyright 2016 LasLabs Inc. # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). @@ -19,7 +18,7 @@ try: CONNECTORS.append(('mysql', 'MySQL')) assert MySQLdb except (ImportError, AssertionError): - _logger.info('MySQL not available. Please install "mysqldb" ' + _logger.info('MySQLdb not available. Please install "mysqlclient" ' 'python package.') except ImportError: _logger.info('base_external_dbsource Odoo module not found.') diff --git a/base_external_dbsource_mysql/readme/CONFIGURE.rst b/base_external_dbsource_mysql/readme/CONFIGURE.rst new file mode 100644 index 00000000..ce19b386 --- /dev/null +++ b/base_external_dbsource_mysql/readme/CONFIGURE.rst @@ -0,0 +1,4 @@ +To configure this module, you need to: + +#. Database sources can be configured in Settings > Technical > + Database Structure > Database sources. \ No newline at end of file diff --git a/base_external_dbsource_mysql/readme/CONTRIBUTORS.rst b/base_external_dbsource_mysql/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..aea7525a --- /dev/null +++ b/base_external_dbsource_mysql/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* Daniel Reis +* Maxime Chambreuil +* Gervais Naoussi +* Dave Lasley +* Sergio Teruel diff --git a/base_external_dbsource_mysql/readme/DESCRIPTION.rst b/base_external_dbsource_mysql/readme/DESCRIPTION.rst new file mode 100644 index 00000000..4c450b50 --- /dev/null +++ b/base_external_dbsource_mysql/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +This module extends ``base_external_dbsource``, allowing you to connect to +foreign MySQL databases using SQLAlchemy. diff --git a/base_external_dbsource_mysql/readme/INSTALL.rst b/base_external_dbsource_mysql/readme/INSTALL.rst new file mode 100644 index 00000000..ded84710 --- /dev/null +++ b/base_external_dbsource_mysql/readme/INSTALL.rst @@ -0,0 +1,5 @@ +To install this module, you need to: + +* Install ``libmysqlclient-dev`` package (``default-libmysqlclient-dev`` on Debian) +* Install ``sqlalchemy`` and ``mysqlclient`` python libraries +* Install ``base_external_dbsource_sqlite`` Odoo module diff --git a/base_external_dbsource_mysql/readme/ROADMAP.rst b/base_external_dbsource_mysql/readme/ROADMAP.rst new file mode 100644 index 00000000..8b025883 --- /dev/null +++ b/base_external_dbsource_mysql/readme/ROADMAP.rst @@ -0,0 +1 @@ +* Add X.509 authentication diff --git a/base_external_dbsource_mysql/readme/USAGE.rst b/base_external_dbsource_mysql/readme/USAGE.rst new file mode 100644 index 00000000..d366e192 --- /dev/null +++ b/base_external_dbsource_mysql/readme/USAGE.rst @@ -0,0 +1,9 @@ +To use this module: + +* Go to Settings > Technical > Database Structure > Database Sources +* Click on Create to enter the following information: + +* Datasource name  +* Pasword +* Connector: Choose the database to which you want to connect +* Connection string: Specify how to connect to database diff --git a/base_external_dbsource_mysql/static/description/index.html b/base_external_dbsource_mysql/static/description/index.html new file mode 100644 index 00000000..0496f07a --- /dev/null +++ b/base_external_dbsource_mysql/static/description/index.html @@ -0,0 +1,464 @@ + + + + + + +External Database Source - MySQL + + + +
+

External Database Source - MySQL

+ + +

Beta License: LGPL-3 OCA/server-backend Translate me on Weblate Try me on Runbot

+

This module extends base_external_dbsource, allowing you to connect to +foreign MySQL databases using SQLAlchemy.

+

Table of contents

+ +
+

Installation

+

To install this module, you need to:

+
    +
  • Install libmysqlclient-dev package (default-libmysqlclient-dev on Debian)
    • +
  • Install sqlalchemy and mysqlclient python libraries
    • +
  • Install base_external_dbsource_sqlite Odoo module
    • +
+
+
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Database sources can be configured in Settings > Technical > +Database Structure > Database sources.
    2. +
+
+
+

Usage

+

To use this module:

+
    +
  • Go to Settings > Technical > Database Structure > Database Sources
    • +
  • Click on Create to enter the following information:
    • +
  • Datasource name
    • +
  • Pasword
    • +
  • Connector: Choose the database to which you want to connect
    • +
  • Connection string: Specify how to connect to database
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Add X.509 authentication
    • +
+
+
+

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

+
+

Authors

+
    +
  • Daniel Reis
    • +
  • LasLabs
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+
+
+
+ + diff --git a/base_external_dbsource_mysql/tests/__init__.py b/base_external_dbsource_mysql/tests/__init__.py index 768d7990..87aa84b3 100644 --- a/base_external_dbsource_mysql/tests/__init__.py +++ b/base_external_dbsource_mysql/tests/__init__.py @@ -1,3 +1 @@ -# -*- encoding: utf-8 -*- - from . import test_base_external_dbsource diff --git a/base_external_dbsource_mysql/tests/test_base_external_dbsource.py b/base_external_dbsource_mysql/tests/test_base_external_dbsource.py index 998a89ed..36280d49 100644 --- a/base_external_dbsource_mysql/tests/test_base_external_dbsource.py +++ b/base_external_dbsource_mysql/tests/test_base_external_dbsource.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2016 LasLabs Inc. import mock