odoo-openupgrade-wizard/README.md
Sylvain LE GAL 9b2cd724b5 wip
2024-11-05 17:25:10 +01:00

81 lines
3.3 KiB
Markdown

<!-- markdownlint-disable MD033 -->
[![Gitlab CI](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/badges/main/pipeline.svg)](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/pipelines)
[![codecov](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/badges/main/coverage.svg)](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/odoo-openupgrade-wizard)
![PyPI - Downloads](https://img.shields.io/pypi/dm/odoo-openupgrade-wizard)
![GitLab last commit](https://img.shields.io/gitlab/last-commit/34780558)
![GitLab stars](https://img.shields.io/gitlab/stars/34780558?style=social)
# odoo-openupgrade-wizard
Odoo Openupgrade Wizard is a tool that helps developpers to make major
upgrade of Odoo Community Edition. (formely OpenERP).
It works with Openupgrade OCA tools. (<https://github.com/oca/openupgrade>)
this tool is useful for complex migrations:
- migrate several versions
- take advantage of the migration to install / uninstall modules
- execute sql requests or odoo shell scripts between each migration
- analyse workload
It will create a migration environment (with all the code available)
and provides helpers to run (and replay) migrations until it works.
- To develop and contribute to the library, refer to the
[DEVELOP.md](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/blob/main/DEVELOP.md)
file.
- Refer to the
[Gitlab Issue Page](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/issues)
to see the current limitation, bugs, and task to do.
- See authors in the
[CONTRIBUTORS.md](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/blob/main/CONTRIBUTORS.md)
file.
- See history in the
[CHANGES.rst](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/blob/main/CHANGES.rst)
file.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Command ``init``](#command-init)
- [Command ``init``](#command-init)
- [Command ``pull-submodule``](#command-pull-submodule)
- [Command ``get-code``](#command-get-code)
- [Command ``docker-build``](#command-docker-build)
- [Command ``run``](#command-run)
- [Command ``install-from-csv``](#command-install-from-csv)
- [Command ``upgrade``](#command-upgrade)
- [Command ``generate-module-analysis``](#command-generate-module-analysis)
- [Command ``estimate-workload``](#command-estimate-workload)
- [Command ``psql``](#command-psql)
- [Command ``copydb``](#command-copydb)
- [Command ``dropdb``](#command-dropdb)
- [Command ``dumpdb``](#command-dumpdb)
## Installation<a name="installation"></a>
**Prerequites:**
- The tools run on debian system
- You should have docker installed on your system
- Some features require extra packages. To have all the features available run:
**Installation:**
The library is available on [PyPI](https://pypi.org/project/odoo-openupgrade-wizard/).
To install it simply run :
```shell
pipx install odoo-openupgrade-wizard
```
See alternative installation in the
[DEVELOP.md](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/blob/main/DEVELOP.md)
file.