https://github.com/odoo/upgrade-util
Utility helpers to write better upgrade scripts.
https://github.com/odoo/upgrade-util
Last synced: 13 days ago
JSON representation
Utility helpers to write better upgrade scripts.
- Host: GitHub
- URL: https://github.com/odoo/upgrade-util
- Owner: odoo
- License: lgpl-3.0
- Created: 2022-11-02T10:46:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T11:44:28.000Z (6 months ago)
- Last Synced: 2024-10-29T12:09:06.047Z (6 months ago)
- Language: Python
- Homepage:
- Size: 6.29 MB
- Stars: 86
- Watchers: 74
- Forks: 41
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - odoo/upgrade-util - Utility helpers to write better upgrade scripts. (Python)
README
# 🧰 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.
```shell-session
$ ./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:
```shell-session
$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master
```
On [Odoo.sh](https://www.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