Skip to main content

A command-line tool for managing Odoo dependencies.

Project description

bl

CI codecov

Why BL

Because ak is a bit slow and I was tired of waiting around

Install

pipx install bl-odoo

Usage

For all those command bl will try to look in the current directory. If it does find the spec file it will try to look in the child odoo directory. (i.e. you can launch bl in the root of you project) You can also override the default paths and verbosity with:

  • -c/--config: path to the project spec file (default: spec.yaml)
  • -z/--frozen: path to the frozen spec file (default: frozen.yaml)
  • -o/--config-override: path to an override config to extend the project specification
  • -j/--concurrency: number of concurrent tasks (default: 28)
  • -b/--use-bindfs: use bindfs instead of creating symlinks (requires user_allow_other in /etc/fuse.conf)
  • -w/--workdir: working directory, defaults to the directory of --config
  • --log-level: one of DEBUG, INFO, WARNING, ERROR, CRITICAL (default: WARNING)

Build

bl build [-c PATH_TO_SPEC] [-z PATH_TO_FROZEN] [-o CONFIG_OVERRIDE] [-j CONCURRENCY] [-b/--use-bindfs] [-w WORKDIR] [--log-level LEVEL]

What does it do

It does what ak build does

Params

  • PATH_TO_SPEC path to your spec (default: spec.yaml)
  • PATH_TO_FROZEN path to your frozen spec (default: frozen.yaml)
  • CONFIG_OVERRIDE path to an override config to extend the project specification
  • CONCURRENCY number of module clone simultaneously (default: 28)
  • --use-bindfs use bindfs instead of creating symlinks (requires user_allow_other in /etc/fuse.conf)
  • WORKDIR working directory; if omitted, the directory containing spec.yaml
  • LEVEL log level (see --log-level above)

How it looks

bl_build

Freeze

bl freeze [-c PATH_TO_SPEC] [-z PATH_TO_FROZEN] [-o CONFIG_OVERRIDE] [-j CONCURRENCY] [-w WORKDIR] [--log-level LEVEL]

What does it do

It does what ak freeze does

Params

  • PATH_TO_SPEC path to your spec (default: spec.yaml)
  • PATH_TO_FROZEN path to your frozen spec (default: frozen.yaml)
  • CONFIG_OVERRIDE path to an override config to extend the project specification
  • CONCURRENCY number of module clone simultaneously (default: 28)
  • WORKDIR working directory; if omitted, the directory containing spec.yaml
  • LEVEL log level (see --log-level above)

Diff

bl diff [-c PATH_TO_SPEC] [-z PATH_TO_FROZEN] [-o CONFIG_OVERRIDE] [-j CONCURRENCY] [-w WORKDIR] [--log-level LEVEL]

What does it do

Shows diff for all dirty repos in the project.

Params

  • PATH_TO_SPEC path to your spec (default: spec.yaml)
  • PATH_TO_FROZEN path to your frozen spec (default: frozen.yaml)
  • CONFIG_OVERRIDE path to an override config to extend the project specification
  • CONCURRENCY number of module clone simultaneously (default: 28)
  • WORKDIR working directory; if omitted, the directory containing spec.yaml
  • LEVEL log level (see --log-level above)

Clean

bl clean [-c PATH_TO_SPEC] [-o CONFIG_OVERRIDE] [-w WORKDIR] [--log-level LEVEL] [--remove] [--unlink] [--force] [--dry-run]

What does it do

By default it scans all repos in the spec for dirty git state and resets them with git reset --hard. With --remove deletes src and external-src directories instead of resetting diry repo. With --unlink it also cleans the links directory. With --dry-run it just outputs what it would do without doing it. With --force it removes confirmation prompts.

Params

  • PATH_TO_SPEC path to your spec (default: spec.yaml)
  • CONFIG_OVERRIDE path to an override config to extend the project specification
  • WORKDIR working directory; if omitted, the directory containing spec.yaml
  • LEVEL log level (see --log-level above)
  • --remove also delete src and external-src directories
  • --unlink clean the links directory
  • --force remove confirmation prompts
  • --dry-run just output dirty repos without resetting

Odoo is taking a really long time to clone

Yes !

You can add a locales entry to your odoo repo in spec.yaml like so:

odoo:
  modules:
    - account
    ...
  remotes:
    odoo: https://github.com/odoo/odoo
  merges:
    - odoo 14.0
  locales:
    - fr
    - en

It will only download the french and english translation instead of all of them

  • without locales: 849MB and 40 seconds fresh build
  • with locales fr, en: 169MB and 27 seconds fresh build

⚠️ WARNING: you must list all the odoo modules you need if you use the locales property

I have warnings about patch globs

There is a new property to handle git am <patch_glob> (the old one still works but I hope to remove it at some point)

Before:

folder_name:
  modules:
    ...
  remotes:
    ...
  merges:
    ...
  shell_command_after:
    - git am ../../patches/patch_folder/*

After:

folder_name:
  modules:
    ...
  remotes:
    ...
  merges:
    ...
  patch_globs:
    - ../../patches/patch_folder/*

Benchmarks

Ak benchmarks

Fresh install

ak_bench_cold

Already cloned once

ak_bench_hot

Bl benchmarks

Fresh install

bl_bench_cold

Already cloned once

bl_bench_hot

Results

Type AK BL
Cold ~100s 2 - 10x faster
Hot 3-20s 2 - 10x faster

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bl_odoo-0.3.18.tar.gz (33.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bl_odoo-0.3.18-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file bl_odoo-0.3.18.tar.gz.

File metadata

  • Download URL: bl_odoo-0.3.18.tar.gz
  • Upload date:
  • Size: 33.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for bl_odoo-0.3.18.tar.gz
Algorithm Hash digest
SHA256 1b1bed137fe9c24c53a36ebd000150dd61d3d1973354fb2946342727f98a81f8
MD5 b5d104a691c44bc5e670ff623adfacf2
BLAKE2b-256 ff9eee0ab73aadaec0f5df4d02654e5aa6dec5fe1b9b2449f4e449480711d1f6

See more details on using hashes here.

File details

Details for the file bl_odoo-0.3.18-py3-none-any.whl.

File metadata

  • Download URL: bl_odoo-0.3.18-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for bl_odoo-0.3.18-py3-none-any.whl
Algorithm Hash digest
SHA256 f09f3481970d1426947bf299d2a2ac8e3dd6eadd8968e1ad412b9b86e06779c1
MD5 7c0de815efb40a03cdd54df81fa9f923
BLAKE2b-256 779225d2e2713cada992930705fad307d763a7bdc916025d100c234d5ba94cf0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page