bl-odoo 0.3.0__tar.gz → 0.3.2__tar.gz

bl_odoo-0.3.2/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: bl-odoo
+Version: 0.3.2
+Summary: A command-line tool for managing Odoo dependencies.
+Author-email: Your Name <your.email@example.com>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich
+Requires-Dist: typer
+Dynamic: license-file
+
+# bl
+
+## Why BL
+
+Because `ak` is slow and `bl` is fast
+
+Because `ak` crashes if anything goes wrong
+
+Because `ak` error are impossible to find
+
+## Install
+
+`pipx install bl-odoo`
+
+## Usage
+
+### Build
+
+```bl build -c <path_to_spec.yaml> -z <path_to_frozen.yaml> -j <concurrency>```
+
+#### Params
+* `path_to_spec.yaml` should be the path to your spec (default: spec.yaml)
+* `path_to_frozen.yaml` should be the path to your spec (default: frozen.yaml)
+* `concurrency` number of module clone simultaneously (default: 28)
+
+#### How it looks
+<img width="1683" height="756" alt="bl_build" src="https://github.com/user-attachments/assets/22fc1565-3a54-4f57-9b85-a11263b9b536" />
+
+### Freeze
+
+```bl freeze -c <path_to_spec.yaml> -z <path_to_frozen.yaml> -j <concurrency>```
+
+#### Params
+* `path_to_spec.yaml` should be the path to your spec (default: spec.yaml)
+* `path_to_frozen.yaml` should be the path to your spec (default: frozen.yaml)
+* `concurrency` number of module clone simultaneously (default: 28)
+
+## 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
+
+## 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.3.2/README.md

@@ -0,0 +1,81 @@
+# bl
+
+## Why BL
+
+Because `ak` is slow and `bl` is fast
+
+Because `ak` crashes if anything goes wrong
+
+Because `ak` error are impossible to find
+
+## Install
+
+`pipx install bl-odoo`
+
+## Usage
+
+### Build
+
+```bl build -c <path_to_spec.yaml> -z <path_to_frozen.yaml> -j <concurrency>```
+
+#### Params
+* `path_to_spec.yaml` should be the path to your spec (default: spec.yaml)
+* `path_to_frozen.yaml` should be the path to your spec (default: frozen.yaml)
+* `concurrency` number of module clone simultaneously (default: 28)
+
+#### How it looks
+<img width="1683" height="756" alt="bl_build" src="https://github.com/user-attachments/assets/22fc1565-3a54-4f57-9b85-a11263b9b536" />
+
+### Freeze
+
+```bl freeze -c <path_to_spec.yaml> -z <path_to_frozen.yaml> -j <concurrency>```
+
+#### Params
+* `path_to_spec.yaml` should be the path to your spec (default: spec.yaml)
+* `path_to_frozen.yaml` should be the path to your spec (default: frozen.yaml)
+* `concurrency` number of module clone simultaneously (default: 28)
+
+## 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
+
+## 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.3.0 → bl_odoo-0.3.2}/bl/__main__.py

@@ -12,15 +12,19 @@ def run():
     parser = argparse.ArgumentParser(
         description="Process a project specification.", formatter_class=argparse.ArgumentDefaultsHelpFormatter
     )
-    parser.add_argument(
-        "-f", "--freeze", const=True, default=None, nargs="?", type=Path, help="Freeze the current state of modules"
-    )
-    parser.add_argument(
+
+    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"
     )
-    parser.add_argument("-z", "--frozen", type=Path, help="Path to the frozen specification file.")
-    parser.add_argument("-j", "--concurrency", type=int, default=28, help="Number of concurrent tasks.")
-    parser.add_argument("-w", "--workdir", type=Path, help="Working directory. Defaults to config directory.")
+    parent_parser.add_argument("-z", "--frozen", type=Path, help="Path to the frozen specification file.")
+    parent_parser.add_argument("-j", "--concurrency", type=int, default=28, help="Number of concurrent tasks.")
+    parent_parser.add_argument("-w", "--workdir", type=Path, help="Working directory. Defaults to config directory.")
+
+    sub = parser.add_subparsers(help="subcommand help", dest="command")
+    build = sub.add_parser("build", parents=[parent_parser], help="build help")
+    freeze = sub.add_parser("freeze", parents=[parent_parser], help="freeze help")
+
     args = parser.parse_args()
 
     project_spec = load_spec_file(args.config, args.frozen, args.workdir)
@@ -28,9 +32,9 @@ def run():
         sys.exit(1)
 
     try:
-        if args.freeze:
-            asyncio.run(freeze_project(project_spec, args.freeze, concurrency=args.concurrency))
-        else:
+        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))
     except Exception:
         sys.exit(1)

{bl_odoo-0.3.0 → bl_odoo-0.3.2}/bl/freezer.py

@@ -40,7 +40,7 @@ async def freeze_spec(
 async def freeze_project(project_spec: ProjectSpec, freeze_file: Path | bool, concurrency: int):
     frz_semaphore = asyncio.Semaphore(concurrency)
     workdir = project_spec.workdir
-    freeze_file_name = freeze_file if freeze_file is not True else "frozen.yaml"
+    freeze_file_name = freeze_file if freeze_file else "frozen.yaml"
     freeze_file_path = workdir / freeze_file_name
 
     task_count_progress = Progress(
@@ -49,14 +49,14 @@ async def freeze_project(project_spec: ProjectSpec, freeze_file: Path | bool, co
         MofNCompleteColumn(),
     )
     count_task = task_count_progress.add_task(
-        f"Freezing modules into {freeze_file_path}", total=len(project_spec.specs)
+        f"Freezing modules into {freeze_file_path}", total=len(project_spec.repos)
     )
 
     freeze_data = {}
 
     with Live(task_count_progress, console=console, refresh_per_second=10):
         task_list = []
-        for name, spec in project_spec.specs.items():
+        for name, spec in project_spec.repos.items():
             task_list.append(
                 freeze_spec(
                     frz_semaphore,
@@ -71,7 +71,6 @@ async def freeze_project(project_spec: ProjectSpec, freeze_file: Path | bool, co
         for item in freeze_list:
             freeze_data.update(item)
 
-    console.print(yaml.dump(freeze_data, default_flow_style=False))
     with open(freeze_file_path, "w") as freeze_stream:
         yaml.dump(freeze_data, freeze_stream, default_flow_style=False)
 

{bl_odoo-0.3.0 → bl_odoo-0.3.2}/bl/spec_parser.py

@@ -3,7 +3,7 @@ import warnings
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Type
 
 import yaml
 
@@ -69,6 +69,13 @@ def parse_remote_refspec_from_parts(parts: List[str], frozen_repo: Dict[str, Dic
     return RefspecInfo(remote_key, ref_spec, ref_type, ref_name)
 
 
+def get_with_syntax_check(name, data, key: str, type: Type):
+    result = data.get(key, type())
+    if not isinstance(result, type):
+        raise Exception(f"Key {key} not of proper syntax should be {str(type)} in {name} description")
+    return result
+
+
 def load_spec_file(config: Path, frozen: Path, workdir: Path) -> Optional[ProjectSpec]:
     """
     Loads and parses the project specification from a YAML file.
@@ -115,14 +122,14 @@ def load_spec_file(config: Path, frozen: Path, workdir: Path) -> Optional[Projec
 
     repos: Dict[str, RepoInfo] = {}
     for repo_name, repo_data in data.items():
-        modules = repo_data.get("modules", [])
-        src = repo_data.get("src")
-        remotes = repo_data.get("remotes") or {}
-        merges = repo_data.get("merges") or []
-        shell_commands = repo_data.get("shell_command_after") or None
-        patch_globs_to_apply = repo_data.get("patch_globs") or None
-        target_folder = repo_data.get("target_folder") or None
-        locales = repo_data.get("locales", [])
+        modules = get_with_syntax_check(repo_name, repo_data, "modules", list)
+        src = get_with_syntax_check(repo_name, repo_data, "src", str)
+        remotes = get_with_syntax_check(repo_name, repo_data, "remotes", dict)
+        merges = get_with_syntax_check(repo_name, repo_data, "merges", list)
+        shell_commands = get_with_syntax_check(repo_name, repo_data, "shell_command_after", list)
+        patch_globs_to_apply = get_with_syntax_check(repo_name, repo_data, "patch_globs", list)
+        target_folder = get_with_syntax_check(repo_name, repo_data, "target_folder", str)
+        locales = get_with_syntax_check(repo_name, repo_data, "locales", list)
 
         frozen_repo = frozen_mapping.get(repo_name, {})
 

{bl_odoo-0.3.0 → bl_odoo-0.3.2}/bl/spec_processor.py

@@ -4,6 +4,7 @@ import warnings
 from pathlib import Path
 from typing import Dict, List
 
+from rich import progress
 from rich.console import Console
 from rich.live import Live
 from rich.progress import BarColumn, MofNCompleteColumn, Progress, SpinnerColumn, TaskID, TextColumn

{bl_odoo-0.3.0 → bl_odoo-0.3.2}/bl/utils.py

@@ -14,14 +14,14 @@ english_env["LANG"] = "en_US.UTF-8"
 
 def get_module_path(workdir: Path, module_name: str, module_spec: RepoInfo) -> Path:
     """Returns the path to the module directory."""
-    if module_name == "odoo" and module_spec.target_folder is None:
+    if module_name == "odoo" and not module_spec.target_folder:
         warnings.warn(
             "importing 'odoo' without a 'target_folder' "
             + "property is deprecated. Use target_folder: 'src/' in spec.yaml.",
             DeprecationWarning,
         )
         return workdir / "src/"
-    elif module_spec.target_folder is not None:
+    elif module_spec.target_folder:
         return workdir / module_spec.target_folder
     else:
         return workdir / "external-src" / module_name
@@ -29,13 +29,15 @@ def get_module_path(workdir: Path, module_name: str, module_spec: RepoInfo) -> P
 
 def get_local_ref(origin: RefspecInfo) -> str:
     """Generates a local reference name for a given origin."""
-    return f"loc-{origin.ref_name or origin.refspec}"
+    return f"{origin.ref_name or origin.refspec}"
 
 
 async def run_git(*args: str, cwd: Optional[Path] = None) -> tuple[int, str, str]:
     """Executes a git command asynchronously."""
     proc = await asyncio.create_subprocess_exec(
         "git",
+        "--git-dir",
+        ".git/",
         *args,
         stdout=asyncio.subprocess.PIPE,
         stderr=asyncio.subprocess.PIPE,

bl_odoo-0.3.2/bl_odoo.egg-info/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: bl-odoo
+Version: 0.3.2
+Summary: A command-line tool for managing Odoo dependencies.
+Author-email: Your Name <your.email@example.com>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich
+Requires-Dist: typer
+Dynamic: license-file
+
+# bl
+
+## Why BL
+
+Because `ak` is slow and `bl` is fast
+
+Because `ak` crashes if anything goes wrong
+
+Because `ak` error are impossible to find
+
+## Install
+
+`pipx install bl-odoo`
+
+## Usage
+
+### Build
+
+```bl build -c <path_to_spec.yaml> -z <path_to_frozen.yaml> -j <concurrency>```
+
+#### Params
+* `path_to_spec.yaml` should be the path to your spec (default: spec.yaml)
+* `path_to_frozen.yaml` should be the path to your spec (default: frozen.yaml)
+* `concurrency` number of module clone simultaneously (default: 28)
+
+#### How it looks
+<img width="1683" height="756" alt="bl_build" src="https://github.com/user-attachments/assets/22fc1565-3a54-4f57-9b85-a11263b9b536" />
+
+### Freeze
+
+```bl freeze -c <path_to_spec.yaml> -z <path_to_frozen.yaml> -j <concurrency>```
+
+#### Params
+* `path_to_spec.yaml` should be the path to your spec (default: spec.yaml)
+* `path_to_frozen.yaml` should be the path to your spec (default: frozen.yaml)
+* `concurrency` number of module clone simultaneously (default: 28)
+
+## 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
+
+## 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.3.0 → bl_odoo-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bl-odoo"
-version = "0.3.0"
+version = "0.3.2"
 description = "A command-line tool for managing Odoo dependencies."
 authors = [
   { name="Your Name", email="your.email@example.com" },

bl_odoo-0.3.0/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.4
-Name: bl-odoo
-Version: 0.3.0
-Summary: A command-line tool for managing Odoo dependencies.
-Author-email: Your Name <your.email@example.com>
-License-Expression: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pyyaml>=6.0.3
-Requires-Dist: rich
-Requires-Dist: typer
-Dynamic: license-file
-
-# bl
-
-A new Python project.

bl_odoo-0.3.0/README.md

@@ -1,3 +0,0 @@
-# bl
-
-A new Python project.

bl_odoo-0.3.0/bl_odoo.egg-info/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.4
-Name: bl-odoo
-Version: 0.3.0
-Summary: A command-line tool for managing Odoo dependencies.
-Author-email: Your Name <your.email@example.com>
-License-Expression: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pyyaml>=6.0.3
-Requires-Dist: rich
-Requires-Dist: typer
-Dynamic: license-file
-
-# bl
-
-A new Python project.