Development¶

Create a new module from source¶

Create a new module.

task create-module addons/project/project_sprint

Add a new model.

task generate-module-model addons/project/project_sprint project.sprint

Add model security.

task generate-module-security addons/project/project_sprint project.sprint

Generate module docs.

task generate-module-docs addons/project/project_sprint project.sprint

Load modules from external folder¶

To load modules from a external folder, set this env var in your .env file:

ODOO_ADDONS_PATH=/path/to/your/module-repo,../odoo-project/odoo-apps

The paths will be appended to the Odoo config.

Initialize without demo data¶

In your .env file set this env var:

WITHOUT_DEMO=True

Set Odoo database name¶

The default database name is the checked out Odoo version.

To define another name, set this env var in your .env file:

DB_NAME=odoo

Disable browser open¶

To disable the browser open when starting the Odoo server edit the .env file:

BROWSER_OPEN=false

Set podman as container engine¶

If you are using podman, set this .env var:

CONTAINER_ENGINE=podman

Change log level¶

To change the log level of Odoo set this env var in your .env file:

LOG_LEVEL=debug

Manage database with container¶

Start pgadmin.

task pgadmin

Open pgadmin http://localhost:8000/ and login with admin@example.com:admin.

Stop all containers¶

Without service name the stop commands stops all containers.

task stop

Remove containers¶

Removes containers and volumes.

task remove

Drop database¶

To drop the default database run:

task drop-db

Define Postgres image version¶

Define the Postgres image in your .env file:

POSTGRES_IMAGE=postgres:16-alpine

Build and publish container image¶

Ensure the host machine can build multi-platform images.

Checkout latest revision of the Odoo version.

task checkout-latest-revision

Build and publish the Odoo image.

task build images/odoo --push

Setup mail catcher¶

Start mailpit server.

task start mailpit

When you send mails in Odoo they will be catched and shown on http://localhost:8025/.

Source env file¶

Assuming the name of the environment is test, you source env vars like this:

eval "$(task show-env test)"

Forward mails with Odoo Mailgate¶

Start all containers.

task start

Initialize the Odoo database.

task exec odoo init-db

Log into Odoo and setup an alias for info@yourcompany.com.

Send a test mail with swaks:

swaks --to info@yourcompany.com --from sender@example.com \
  --server localhost:25 \
  --body "This is a test email for the Odoo mailgate system." \
  --header "Subject: Test Email for Odoo"

The mail will be forwarded to Odoo.

Trace the mailgate log with:

docker exec mailgate tail -f /var/log/mail.log

You can also send a mail with tls encryption:

swaks --to info@yourcompany.com --from sender@example.com \
  --server localhost:587 \
  --tls \
  --body "This is a test email for the Odoo mailgate system." \
  --header "Subject: Test Email for Odoo"

Create Odoo revision¶

Check the latest official Odoo image tag on https://hub.docker.com/_/odoo/tags.

Replace the - with a . in the tag name and create a revision:

task create-revision "$VERSION.YYYYDDMM"

Replace all image references in the docs.

Commit and push revision with tag:

task commit-and-push-revision

Update repo template from oca-addons-repo-template¶

Run copier to copy the OCA template fiels

source task source
copier copy --UNSAFE https://github.com/OCA/oca-addons-repo-template.git "templates/$VERSION"

Answer with:

$VERSION
Mint-System
Mint System GmbH
server-tools
Enter for all remaining questions.

Remove unnecessary linter files.

cd "templates/$VERSION"
rm .copier-answers.yml
rm .pylintrc-mandatory
rm README.md

Restore the folder templates/$VERSION/.github and update templates/$VERSION/.gitignore with:

# Odoo Build
tmp

In .pre-commit-config.yaml remove mandatory pylint odoo:

  - id: pylint_odoo
    args:
      - --rcfile=.pylintrc-mandatory

And set https://www.mint-system.ch/ as args for the mainainter-tools.

In the .ruff.toml set this option at the top:

line-length = 120

Template the server tools repo and run the linter:

task template-repo addons/server_tools
cd addons/server_tools
task all

Refine the templates based on the linter results.

Debug Odoo with VSCode¶

In VSCode define a break point for a selected method.

Run Odoo source with a debugger.

task debug source

In VSCode run Python - attach debugger to attach the debugger.

Open http://localhost:8069 and run the method that you want to debug.

VSCode should jump to the breakpoint and you can step through the method.

Profile Odoo memory usage¶

Run Odoo with memray.

task record-with-memray native

Open http://localhost:8069 and finish the recording with ctrl+c.

The flamegraph report will be generated and opened.

Profile Odoo execution time¶

Run Odoo and get the process id.

PID=$(ps -eo pid,comm | grep -m 1 'odoo' | awk '{print $1}')

Record the Odoo process with py-spy.

task record-with-py-spy "$PID"

Finish the recording with ctrl+c.

The browser will open https://www.speedscope.app/. Upload the tmp/speedscope-profiling.json file.

Show module depdency tree¶

Use the manifestoo command to reason about module dependencies. The --addons-path will be provided.

Here is an example output:

[main][~/Odoo-Build]$ task manifestoo --select partner_firstname tree
partner_firstname (19.0.1.0.0)
└── base_setup (19.0+c)
    └── web (19.0+c)