Skip to content

Utility helpers to write better upgrade scripts.

License

Notifications You must be signed in to change notification settings

odoo/upgrade-util

Repository files navigation

🧰 Upgrade Utils

This repository contains helper functions to facilitate the writing of upgrade scripts.

Installation

The usual one

Once you have clone this repository locally, just start odoo with the src directory prepended to the --upgrade-path option.

$ ./odoo-bin --upgrade-path=/path/to/upgrade-util/src,/path/to/other/upgrade/script/directory [...]

The alternative one

On platforms where you dont manage odoo yourself, you can install this package via pip:

$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master

On Odoo.sh it is recommended to add it to the requirements.txt of your repository:

odoo_upgrade @ git+https://github.com/odoo/upgrade-util@master

How to use them?

Once installed, the following packages are available

  • odoo.upgrade.util: the helper themself. See the wiki for info.
  • odoo.upgrade.testing: base TestCase classes