.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. image:: https://img.shields.io/badge/python-3.6-blue.svg :alt: Python support: 3.6 .. image:: https://app.travis-ci.com/OCA/odoo-module-migrator.svg?branch=master :target: https://app.travis-ci.com/OCA/odoo-module-migrator
odoo-module-migrator is a python3 library that allows you to automatically migrate
module code to make it compatible with newer Odoo versions.
For example:
__openerp__.py file to __manifest__.py# -*- encoding: utf-8 -*- since V11.0openerp import with odoo importmigrations foldersThis library will:
This project is about migrating code. If you're looking for database data migration between Odoo versions, check out the https://github.com/OCA/OpenUpgrade project.
INFO log
Indicates that the library automatically changed something. A priori you have nothing to do. For example, for a migration from 8.0 to a more recent version:
.. code-block:: shell
12:38:54 INFO Renaming file: '/my_module/__openerp__.py' to '/my_module/__manifest__.py'WARNING log
Indicates that you should check something. There may be something to do to make the module work. For example:
.. code-block:: shell
19:37:55 WARNING Replaced dependency of 'account_analytic_analysis' with 'contract' (Moved to OCA/contract)ERROR log
Indicates that you must change something in your code. If not, the module will not work for sure (not installable or generating errors during execution).
For example, if you have an 8.0 module that depends on 'account_anglo_saxon', which disappeared in more recent versions, the following log will be displayed:
.. code-block:: shell
12:38:54 ERROR Depends on removed module 'account_anglo_saxon'If you want to improve or contribute to this library, please read the
DEVELOP.rst file and the 'Roadmap / Known Issues' sections.
.. code-block:: shell
pip3 install odoo-module-migrator(Recommended by the OCA)
If you want to migrate an Odoo module from version 8.0 to 12.0, for example,
the module pos_order_pricelist_change in the OCA "pos" repository:
.. code-block:: shell
git clone https://github.com/OCA/pos -b 12.0
cd pos
odoo-module-migrate
--directory ./
--modules pos_order_pricelist_change
--init-version-name 8.0
--target-version-name 12.0
--format-patch(Mainly for your custom modules)
If you have created a new branch (for example 12.0) based on your 10.0 branch, you can run the following command:
.. code-block:: shell
odoo-module-migrate
--directory /path/to/repository
--modules module_1,module_2,module_3
--init-version-name 10.0
--target-version-name 12.0This tool will operate the changes for each module.
+--------------------------+----------+-----------------+-------------------------------------------------------+
| Name | Shortcut | Options | Description |
+==========================+==========+=================+=======================================================+
|--directory | -d | Default: | Local folder that contains the module(s) to migrate. |
| | | ./ | |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--init-version-name | -i | Required | Initial version of your module(s) you want to migrate.|
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--target-version-name | -t | Default: | Final version you want to migrate to. |
| | | the latest Odoo | |
| | | version | |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--modules | -m | Default: | Module(s) to migrate. Note: if the format-patch option|
| | | All modules | is enabled, you have to provide only one module. |
| | | in the | |
| | | directory | |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--format-patch | -fp | Disabled | Recover code using the git format-patch command. |
| | | by default | |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--remote-name | -rn | Default: | Name of the main remote used by the format-patch |
| | | origin | command. |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--log-level | -ll | Default: | Possible values: DEBUG, INFO, WARNING, |
| | | INFO | etc. |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--log-path | -lp | Default: | If set, logs will not be displayed on screen, |
| | | False | but stored in a file. |
+--------------------------+----------+-----------------+-------------------------------------------------------+
|--no-commit | -nc | Default: | If set, the library will not git add and git commit |
| | | commit | changes. |
+--------------------------+----------+-----------------+-------------------------------------------------------+
The replacement of the tag lxml library instead of regular expressions.
Add a call to pre-commit run -a, if pre-commit is present in the
repository.
git commit to avoid failure if pre-commit
is present._execute_shell function.[ADD] test.
[ADD] --file-path option.
[ADD] _DEPRECATED_MODULES syntax.
[FIX] Incorrect syntax of regular expression to remove python 2 header. [IMP] First release of all the steps from 8.0 to 13.0.
[ADD] --no-commit option that disables git add and git commit calls.
[FIX] Do not commit many times if migration has many steps.
[REF] Remove useless commented code.
[REF] Create _commit_changes() and _replace_in_file() functions.
[FIX] GitHub URL of the project in setup.py. [ADD] Travis file + links to coveralls. [ADD] test_requirements.txt.
[ADD] Migration from 12.0 to 13.0 and add a warning if references to web_settings_dashboard are found, courtesy of @yelizariev. [ADD] Bump version in manifest file. [ADD] Set installable to True.