bl-odoo 0.0.0__tar.gz

bl_odoo-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bl_odoo-0.0.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: bl-odoo
+Version: 0.0.0
+Summary: A command-line tool for managing Odoo dependencies.
+Author-email: Your Name <your.email@example.com>
+License-Expression: MIT
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: copier
+Requires-Dist: rich
+Requires-Dist: ruamel-yaml>=0.19.1
+Requires-Dist: typer
+Requires-Dist: xdg-base-dirs>=6.0.2
+Dynamic: license-file
+
+# bl
+[![CI](https://github.com/FranzPoize/bl/actions/workflows/ci-publish.yml/badge.svg)](https://github.com/FranzPoize/bl/actions/workflows/ci-publish.yml) [![codecov](https://codecov.io/github/FranzPoize/bl/graph/badge.svg?token=JWD4KU0PEN)](https://codecov.io/github/FranzPoize/bl)
+
+## 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
+
+```bash
+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
+<img width="1683" height="756" alt="bl_build" src="https://github.com/user-attachments/assets/22fc1565-3a54-4f57-9b85-a11263b9b536" />
+
+### Freeze
+
+```bash
+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
+
+```bash
+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
+
+```bash
+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`.
+
+#### 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` delete `src` and `external-src` directories
+* `--unlink` also clean the links directory
+* `--force` remove confirmation prompts
+* `--dry-run` just output what it would do
+
+### Init
+
+```bash
+bl init [DESTINATION]
+```
+
+#### What does it do
+Initializes a new project from the [docky-odoo-template-shared](https://github.com/akretion/docky-odoo-template-shared) template using [Copier](https://copier.readthedocs.io/).
+
+#### Params
+* `DESTINATION` destination directory (default: current directory)
+
+## 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:
+```yaml
+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:
+```yaml
+folder_name:
+  modules:
+    ...
+  remotes:
+    ...
+  merges:
+    ...
+  shell_command_after:
+    - git am ../../patches/patch_folder/*
+```
+After:
+```yaml
+folder_name:
+  modules:
+    ...
+  remotes:
+    ...
+  merges:
+    ...
+  patch_globs:
+    - ../../patches/patch_folder/*
+```
+
+
+## Benchmarks
+
+### Ak benchmarks
+#### Fresh install
+<img width="1462" height="347" alt="ak_bench_cold" src="https://github.com/user-attachments/assets/e29cd3d9-831c-43c1-8f29-e040ebee5740" />
+
+#### Already cloned once
+<img width="1419" height="356" alt="ak_bench_hot" src="https://github.com/user-attachments/assets/47b5756e-efe1-4272-82b7-e160f73af1be" />
+
+### Bl benchmarks
+#### Fresh install
+<img width="1335" height="343" alt="bl_bench_cold" src="https://github.com/user-attachments/assets/a64ba1c4-17bd-4017-acfd-5749df505f50" />
+
+#### Already cloned once
+<img width="1373" height="342" alt="bl_bench_hot" src="https://github.com/user-attachments/assets/b11e60c2-368b-496c-bc88-f5a765f44bfe" />
+
+### Results
+|Type| AK | BL |
+|----|----|----|
+|Cold| ~100s | 2 - 10x faster |
+|Hot| 3-20s | 2 - 10x faster |
+

bl_odoo-0.0.0/README.md

@@ -0,0 +1,187 @@
+# bl
+[![CI](https://github.com/FranzPoize/bl/actions/workflows/ci-publish.yml/badge.svg)](https://github.com/FranzPoize/bl/actions/workflows/ci-publish.yml) [![codecov](https://codecov.io/github/FranzPoize/bl/graph/badge.svg?token=JWD4KU0PEN)](https://codecov.io/github/FranzPoize/bl)
+
+## 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
+
+```bash
+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
+<img width="1683" height="756" alt="bl_build" src="https://github.com/user-attachments/assets/22fc1565-3a54-4f57-9b85-a11263b9b536" />
+
+### Freeze
+
+```bash
+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
+
+```bash
+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
+
+```bash
+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`.
+
+#### 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` delete `src` and `external-src` directories
+* `--unlink` also clean the links directory
+* `--force` remove confirmation prompts
+* `--dry-run` just output what it would do
+
+### Init
+
+```bash
+bl init [DESTINATION]
+```
+
+#### What does it do
+Initializes a new project from the [docky-odoo-template-shared](https://github.com/akretion/docky-odoo-template-shared) template using [Copier](https://copier.readthedocs.io/).
+
+#### Params
+* `DESTINATION` destination directory (default: current directory)
+
+## 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:
+```yaml
+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:
+```yaml
+folder_name:
+  modules:
+    ...
+  remotes:
+    ...
+  merges:
+    ...
+  shell_command_after:
+    - git am ../../patches/patch_folder/*
+```
+After:
+```yaml
+folder_name:
+  modules:
+    ...
+  remotes:
+    ...
+  merges:
+    ...
+  patch_globs:
+    - ../../patches/patch_folder/*
+```
+
+
+## Benchmarks
+
+### Ak benchmarks
+#### Fresh install
+<img width="1462" height="347" alt="ak_bench_cold" src="https://github.com/user-attachments/assets/e29cd3d9-831c-43c1-8f29-e040ebee5740" />
+
+#### Already cloned once
+<img width="1419" height="356" alt="ak_bench_hot" src="https://github.com/user-attachments/assets/47b5756e-efe1-4272-82b7-e160f73af1be" />
+
+### Bl benchmarks
+#### Fresh install
+<img width="1335" height="343" alt="bl_bench_cold" src="https://github.com/user-attachments/assets/a64ba1c4-17bd-4017-acfd-5749df505f50" />
+
+#### Already cloned once
+<img width="1373" height="342" alt="bl_bench_hot" src="https://github.com/user-attachments/assets/b11e60c2-368b-496c-bc88-f5a765f44bfe" />
+
+### Results
+|Type| AK | BL |
+|----|----|----|
+|Cold| ~100s | 2 - 10x faster |
+|Hot| 3-20s | 2 - 10x faster |
+

bl_odoo-0.0.0/bl/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"

bl_odoo-0.0.0/bl/__main__.py

@@ -0,0 +1,214 @@
+import argparse
+import asyncio
+import atexit
+import json
+import logging
+import logging.handlers
+import queue
+import subprocess
+import sys
+from pathlib import Path
+
+from copier import run_copy
+from plumbum.lib import captured_stdout
+from rich.console import Console
+
+import bl
+from bl.clean_project import clean_project, show_diffs
+from bl.editable import make_editable
+from bl.freezer import freeze_project
+from bl.spec_parser import load_spec_file
+from bl.spec_processor import process_project
+
+err_console = Console(stderr=True)
+out_console = Console()
+
+
+class RichConsoleHandler(logging.Handler):
+    def __init__(self, level=logging.NOTSET):
+        super().__init__(level)
+        self._console = out_console
+        self._err_console = err_console
+
+    def emit(self, record: logging.LogRecord) -> None:
+        try:
+            msg = self.format(record)
+            level = record.levelno
+            if level >= logging.CRITICAL:
+                level_style = "bold red"
+            elif level >= logging.ERROR:
+                level_style = "red"
+            elif level >= logging.WARNING:
+                level_style = "yellow"
+            elif level >= logging.INFO:
+                level_style = "cyan"
+            else:
+                level_style = "dim"
+
+            message = f"[{level_style}]{record.levelname}[/]: {msg}"
+            if level >= logging.ERROR or level >= logging.DEBUG:
+                self._err_console.print(message)
+            else:
+                self._console.print(message)
+            if record.exc_info:
+                self._console.print_exception()
+        except Exception:
+            self.handleError(record)
+
+
+que = queue.Queue(-1)
+queue_handler = logging.handlers.QueueHandler(que)
+listener = logging.handlers.QueueListener(que, RichConsoleHandler())
+
+
+def check_last_version() -> bool:
+    ret = subprocess.run(["which", "pip"], capture_output=True)
+    ok = ret.returncode == 0
+    pip_target = ret.stdout.decode().strip()
+
+    pip_call = subprocess.run(["pip", "index", "versions", "--json", "bl-odoo"], capture_output=True)
+    pip_index_ok = pip_call.returncode == 0
+    pip_return_value = pip_call.stdout.decode().strip()
+
+    json_pip_index = json.loads(pip_return_value)
+    bl_last_version = json_pip_index["versions"][0]
+    c_maj, c_min, c_patch = bl.__version__.split(".")
+    l_maj, l_min, l_patch = bl_last_version.split(".")
+
+    if c_maj < l_maj or c_min < l_min or c_patch < l_patch:
+        msg = (
+            "[red]Watch out ![/] There is a new bl version you should update "
+            + f"(Yours is {bl.__version__} != Last is {bl_last_version})"
+        )
+        border_msg = "[red]" + "#" * (len(msg) - len("[red][/]")) + "[/]"
+        out_console.print(f"{border_msg}\n{msg}\n{border_msg}\n\n")
+
+
+def setup_logging(log_level: str) -> None:
+    level = getattr(logging, log_level, logging.WARNING)
+    root_logger = logging.getLogger()
+    root_logger.handlers.clear()
+    root_logger.setLevel(level)
+    queue_handler.setFormatter(logging.Formatter("%(message)s"))
+    root_logger.addHandler(queue_handler)
+    listener.start()
+
+
+@atexit.register
+def stop_logging():
+    listener.stop()
+
+
+def run():
+    parser = argparse.ArgumentParser(
+        description="Process a project specification.", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+    )
+
+    parent_parser = argparse.ArgumentParser(add_help=False)
+    parent_parser.add_argument(
+        "-c", "--config", type=Path, help="Path to the project specification file.", default="spec.yaml"
+    )
+    parent_parser.add_argument(
+        "-N",
+        "--no-check-version",
+        action="store_true",
+        help="Disable last version check",
+    )
+    parent_parser.add_argument("-z", "--frozen", type=Path, help="Path to the frozen specification file.")
+    parent_parser.add_argument(
+        "-o",
+        "--config-override",
+        type=Path,
+        action="append",
+        help="Path to an override config to extend the project specification. "
+        "Can be used multiple times, applied in order.",
+    )
+    parent_parser.add_argument("-j", "--concurrency", type=int, default=28, help="Number of concurrent tasks.")
+    parent_parser.add_argument(
+        "-b",
+        "--use-bindfs",
+        action="store_true",
+        help="Use bindfs instead of creating symlinks (must have user_allow_other in /etc/fuse.conf).",
+    )
+    parent_parser.add_argument("-w", "--workdir", type=Path, help="Working directory. Defaults to config directory.")
+    parent_parser.add_argument(
+        "--log-level",
+        type=str.upper,
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default="WARNING",
+        help="Logging level.",
+    )
+
+    sub = parser.add_subparsers(help="subcommand help", dest="command")
+    sub.add_parser("build", parents=[parent_parser], help="build help")
+    sub.add_parser("freeze", parents=[parent_parser], help="freeze help")
+    sub.add_parser("diff", parents=[parent_parser], help="Show diff for all dirty repos")
+    edit_parser = sub.add_parser("edit", parents=[parent_parser], help="Make a repo editable")
+    edit_parser.add_argument("repository_name", type=Path)
+    init_parser = sub.add_parser("init", parents=[parent_parser], help="Initialize a project from a template")
+    init_parser.add_argument("destination", type=Path, nargs="?", default=Path("."), help="Destination directory")
+    clean_parser = sub.add_parser("clean", parents=[parent_parser], help="Clean src and external-src in workdir")
+    clean_parser.add_argument(
+        "--remove",
+        action="store_true",
+        help="Delete src and external-src.",
+    )
+    clean_parser.add_argument(
+        "--unlink",
+        action="store_true",
+        help="Clean the links directory.",
+    )
+    clean_parser.add_argument(
+        "--force",
+        action="store_true",
+        help="Remove confirmation prompts.",
+    )
+    clean_parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="Just output dirty repo.",
+    )
+
+    args = parser.parse_args()
+
+    level_name = args.log_level
+    setup_logging(level_name)
+
+    if not args.no_check_version:
+        check_last_version()
+
+    if args.command == "init":
+        run_copy("https://github.com/akretion/docky-odoo-template-shared", args.destination)
+        sys.exit(0)
+
+    project_spec = load_spec_file(args.config, args.frozen, args.workdir, args.config_override)
+    if project_spec is None:
+        sys.exit(1)
+
+    try:
+        if args.command == "freeze":
+            asyncio.run(freeze_project(project_spec, args.frozen, concurrency=args.concurrency))
+        elif args.command == "build":
+            asyncio.run(process_project(project_spec, concurrency=args.concurrency, use_bindfs=args.use_bindfs))
+        elif args.command == "diff":
+            asyncio.run(show_diffs(project_spec))
+        elif args.command == "edit":
+            asyncio.run(make_editable(args.repository_name, args.config, args.workdir))
+        elif args.command == "clean":
+            ret = asyncio.run(
+                clean_project(
+                    project_spec,
+                    remove=args.remove,
+                    unlink=args.unlink,
+                    force=args.force,
+                    dry_run=args.dry_run,
+                )
+            )
+            if ret != 0:
+                sys.exit(1)
+    except Exception:
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    run()