Skip to content

Commit f1f3ca2

Browse files
committed
[ADD] README.md
1 parent 24ada68 commit f1f3ca2

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 🧰 Upgrade Utils
2+
3+
This repository contains helper functions to facilitate the writing of upgrade scripts.
4+
5+
## Installation
6+
7+
### The usual one
8+
Once you have clone this repository locally, just start `odoo` with the `src` directory prepended to the `--upgrade-path` option.
9+
```shell-session
10+
$ ./odoo-bin --upgrade-path=/path/to/upgrade-util/src,/path/to/other/upgrade/script/directory [...]
11+
```
12+
13+
### The alternative one
14+
On platforms where you dont manage odoo yourself, i.e. [Odoo.sh](https://www.odoo.sh/), you can install this package via pip:
15+
```shell-session
16+
$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master
17+
```
18+
19+
## How to use them?
20+
Once installed, the following packages are available
21+
- `odoo.upgrade.util`: the helper themself. See the wiki for info.
22+
- `odoo.upgrade.testing`: base TestCase classes

0 commit comments

Comments
 (0)