Odoo Project Tools

Installation

This repository contains helper tasks for working with Camptocamp Odoo projects.

Create a virtual environment and activate it, then run:

pip install --user git+https://github.com/camptocamp/odoo-project-tools.git

If you use pipx then you can run instead:

pipx install git+https://github.com/camptocamp/odoo-project-tools.git

Usage

Note: information below is subject to change.

The package brings the following commands:

otools-project: manage proj

otools-addons: tools to work with addons

otools-release: bump releases

otools-tasks: access to the "old" invoke tasks, being rewritten.

Use --help to get the list of subcommands.

Project conversion

Create a new checkout of the project you are working on, with the submodules up-to-date (you will need to start an instance later in the process to get the installed addons, and at that stage of the conversion, the project will not be runnable yet).

Go to the root of your project and follow the steps below:

1. Run sync from Vincent's fork of odoo-template

   invoke project.sync --fork vrenaville/odoo-template --version mig_to_core
   

2. Initialize the project at v1

   PROJ_TMPL_VER=1 otools-project init
   

3. Stage new files and commit

   git add .
   git commit -m "Initialize project v1"
   

   You can always reset hard to this commit when trying the conversion to v2 ;) (don't forget to update the project submodules again, as they will certainly have been reset)

4. Install conversion tools

   pip install "odoo-tools[convert] @ git+https://github.com/camptocamp/odoo-project-tools.git"
   

   or, if you're using pipx:

   pipx inject odoo-tools "odoo-tools[convert] @ git+https://github.com/camptocamp/odoo-project-tools.git"
   

5. Start a local instance with a copy of the production database

6. Run the conversion script

   CONV_ADMIN_PWD=admin otools-conversion -p 8069
   

   The script will move things around, figure out which OCA addons are installed on your instance, and when done display a message about what further manual steps are required, and what you need to check for. These steps will also be saved to a file (see step 8 below).

   Be careful, if you need to redo these steps, the submodules will have been removed by the script, you will need to run git submodule update -i again.

7. Install pre-commit and run it on all files

   pre-commit install
   pre-commit run --all-files
   

   Manually fix the issues that pre-commit is unable to fix by itself

8. Stage all changes and commit

   git add .
   git commit -m "Convert to proj v2"
   

9. Follow the steps in the generated V2_MIG_NEXT_STEPS.todo file