gOdoo-cli 0.11.12__tar.gz → 0.11.13__tar.gz

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/PKG-INFO

@@ -1,43 +1,44 @@
 Metadata-Version: 2.1
 Name: gOdoo-cli
-Version: 0.11.12
+Version: 0.11.13
 Summary: Wrapper around Odoo-Bin with some convinience RPC functions.
 Home-page: https://github.com/OpenJKSoftware/gOdoo
 License: LGPL-3
 Keywords: odoo,godoo,devcontainer
 Author: Joshua Kreuder
 Author-email: Joshua_Kreuder@outlook.com
-Requires-Python: >=3.9,<3.12
+Requires-Python: >=3.9
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: codequality
 Provides-Extra: devcontainer
-Requires-Dist: black (>=22.10.0,<23.0.0) ; extra == "codequality"
-Requires-Dist: debugpy (>=1.6.0,<2.0.0) ; extra == "devcontainer"
-Requires-Dist: flake8 (>=5.0.4,<6.0.0) ; extra == "codequality"
-Requires-Dist: gitpython (>=3.1.27,<4.0.0)
-Requires-Dist: godoo-rpc (>=0.1.2,<0.2.0)
-Requires-Dist: inotify (>=0.2.10,<0.3.0) ; extra == "devcontainer"
-Requires-Dist: ipdb (>=0.13.9,<0.14.0) ; extra == "devcontainer"
-Requires-Dist: isort (>=5.10.1,<6.0.0) ; extra == "codequality"
-Requires-Dist: mock (>=4.0.3,<5.0.0) ; extra == "devcontainer"
-Requires-Dist: openupgradelib (>=3.3.4,<4.0.0)
-Requires-Dist: passlib (>=1.7.3,<2.0.0)
-Requires-Dist: psycopg2 (>=2.8.6,<3.0.0)
-Requires-Dist: py-spy (>=0.3.11,<0.4.0) ; extra == "devcontainer"
-Requires-Dist: pydevd-odoo (>=1.2.1,<2.0.0) ; extra == "devcontainer"
-Requires-Dist: pylint-odoo (>=8.0.16,<9.0.0) ; extra == "codequality"
-Requires-Dist: pytest (>=7.2.1,<8.0.0) ; extra == "codequality"
-Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "codequality"
-Requires-Dist: python-dotenv (>=0.20.0,<0.21.0)
-Requires-Dist: rope (>=0.23.0,<0.24.0) ; extra == "devcontainer"
-Requires-Dist: ruamel-yaml (>=0.17.21,<0.18.0)
-Requires-Dist: typer (>=0.9.0,<0.10.0)
-Requires-Dist: typer-common-functions (>=0.0.8,<0.0.9)
-Requires-Dist: watchdog (>=2.1.7,<3.0.0) ; extra == "devcontainer"
+Requires-Dist: black (>=22.10.0) ; extra == "codequality"
+Requires-Dist: debugpy (>=1.6.0) ; extra == "devcontainer"
+Requires-Dist: flake8 (>=5.0.4) ; extra == "codequality"
+Requires-Dist: gitpython (>=3.1.27)
+Requires-Dist: godoo-rpc (>=0.1.4)
+Requires-Dist: inotify (>=0.2.10) ; extra == "devcontainer"
+Requires-Dist: ipdb (>=0.13.9) ; extra == "devcontainer"
+Requires-Dist: isort (>=5.10.1) ; extra == "codequality"
+Requires-Dist: mock (>=4.0.3) ; extra == "devcontainer"
+Requires-Dist: openupgradelib (>=3.3.4)
+Requires-Dist: passlib (>=1.7.3)
+Requires-Dist: psycopg2 (>=2.8.6)
+Requires-Dist: py-spy (>=0.3.11) ; extra == "devcontainer"
+Requires-Dist: pydevd-odoo (>=1.2.1) ; extra == "devcontainer"
+Requires-Dist: pylint-odoo (>=8.0.16) ; extra == "codequality"
+Requires-Dist: pytest (>=7.2.1) ; extra == "codequality"
+Requires-Dist: pytest-cov (>=4.0.0) ; extra == "codequality"
+Requires-Dist: python-dotenv (>=0.20.0)
+Requires-Dist: rope (>=0.23.0) ; extra == "devcontainer"
+Requires-Dist: ruamel-yaml (>=0.17.21)
+Requires-Dist: typer (>=0.9.0)
+Requires-Dist: typer-common-functions (>=0.0.12)
+Requires-Dist: watchdog (>=2.1.7) ; extra == "devcontainer"
 Project-URL: Repository, https://github.com/OpenJKSoftware/gOdoo
 Description-Content-Type: text/markdown
 

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gOdoo-cli"
-version = "0.11.12"
+version = "0.11.13"
 description = "Wrapper around Odoo-Bin with some convinience RPC functions."
 authors = ["Joshua Kreuder <Joshua_Kreuder@outlook.com>"]
 license = "LGPL-3"
@@ -10,7 +10,7 @@ repository = "https://github.com/OpenJKSoftware/gOdoo"
 keywords = ["odoo", "godoo","devcontainer"]
 
 [tool.poetry.group.dev.dependencies]
-pre-commit = "^3.4.0"
+pre-commit = ">=3.4.0"
 
 [tool.poetry_bumpversion.file."src/godoo_cli/version.py"]
 
@@ -18,31 +18,31 @@ pre-commit = "^3.4.0"
 godoo = "godoo_cli:launch_cli"
 
 [tool.poetry.dependencies]
-python = ">=3.9,<3.12"
-python-dotenv = "^0.20.0"
-ruamel-yaml = "^0.17.21"
-gitpython = "^3.1.27"
-godoo-rpc = "^0.1.2"
-openupgradelib = "^3.3.4"
-psycopg2 = "^2.8.6" # Mirror Odoo Reqs
-passlib = "^1.7.3" # Mirror Odoo Reqs
-typer-common-functions = "^0.0.8"
-typer = "^0.9.0"
-
-pylint-odoo = { version="^8.0.16", optional = true}
-ipdb = { version="^0.13.9", optional = true}
-debugpy = { version="^1.6.0", optional = true}
-black = { version="^22.10.0", optional = true}
-isort = { version="^5.10.1", optional = true}
-watchdog = { version="^2.1.7", optional = true}
-py-spy = { version="^0.3.11", optional = true}
-rope = { version="^0.23.0", optional = true}
-flake8 = { version="^5.0.4", optional = true}
-inotify = { version="^0.2.10",optional = true}
-mock = { version="^4.0.3", optional= true}
-pytest = { version="^7.2.1", optional= true}
-pytest-cov = {version="^4.0.0",optional=true}
-pydevd-odoo = { version="^1.2.1",optional=true}
+python = ">=3.9"
+python-dotenv = ">=0.20.0"
+ruamel-yaml = ">=0.17.21"
+gitpython = ">=3.1.27"
+godoo-rpc = ">=0.1.4"
+openupgradelib = ">=3.3.4"
+psycopg2 = ">=2.8.6" # Mirror Odoo Reqs
+passlib = ">=1.7.3" # Mirror Odoo Reqs
+typer-common-functions = ">=0.0.12"
+typer = ">=0.9.0"
+
+pylint-odoo = { version=">=8.0.16", optional = true}
+ipdb = { version=">=0.13.9", optional = true}
+debugpy = { version=">=1.6.0", optional = true}
+black = { version=">=22.10.0", optional = true}
+isort = { version=">=5.10.1", optional = true}
+watchdog = { version=">=2.1.7", optional = true}
+py-spy = { version=">=0.3.11", optional = true}
+rope = { version=">=0.23.0", optional = true}
+flake8 = { version=">=5.0.4", optional = true}
+inotify = { version=">=0.2.10",optional = true}
+mock = { version=">=4.0.3", optional= true}
+pytest = { version=">=7.2.1", optional= true}
+pytest-cov = {version=">=4.0.0",optional=true}
+pydevd-odoo = { version=">=1.2.1",optional=true}
 
 [tool.poetry.extras]
 devcontainer = [
@@ -75,7 +75,7 @@ log_cli_format = "%(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(linen
 log_cli_date_format = "%Y-%m-%d %H:%M:%S"
 
 [tool.pyright]
-ignore="**/__manifest__.py"
+ignore=["**/__manifest__.py"]
 
 [tool.black]
 line-length = 120

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/cli.py

@@ -1,4 +1,5 @@
 """Main CLI."""
+
 from typing import Optional
 
 import typer
@@ -14,6 +15,7 @@ from .commands import (
     launch_odoo,
     odoo_run_tests,
     odoo_shell,
+    odoo_shell_run_script,
     rpc_cli_app,
     set_odoo_config,
     source_cli_app,
@@ -80,6 +82,7 @@ def main_cli():
     app.command("test")(odoo_run_tests)
     app.command("config")(set_odoo_config)
     app.command("shell")(odoo_shell)
+    app.command("shell-script")(odoo_shell_run_script)
     app.command("uninstall")(uninstall_modules)
     return app
 

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/cli_common.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 from pathlib import Path
 from typing import List, Optional
 
-from typer import Option
+from typer import Argument, Option
 from typer_common_functions import get_type_from_default, typer_retuner, typer_unpacker
 
 
@@ -42,6 +42,16 @@ class OdooLaunchArgs:
         rich_help_panel="Odoo",
     )
     log_file_path: Path = Option(None, dir_okay=False, writable=True, help="Logfile Path", rich_help_panel="Odoo")
+    banner_text: str = Argument(
+        ...,
+        help="Banner Text to add to Odoo Log",
+        envvar="ODOO_BANNER_TEXT",
+    )
+    banner_bg_color: str = Option(
+        "green",
+        help="Banner Background Color",
+        envvar="ODOO_BANNER_BG_COLOR",
+    )
 
 
 @dataclass

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/commands/__init__.py

@@ -4,7 +4,7 @@ from .config import set_odoo_config
 from .db import db_cli_app
 from .launch import launch_import, launch_odoo
 from .rpc import rpc_cli_app
-from .shell import odoo_shell, uninstall_modules
+from .shell.shell import odoo_shell, odoo_shell_run_script, uninstall_modules
 from .source_get import source_cli_app
 from .test import test_cli_app
 from .test.test_run import odoo_run_tests

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/commands/bootstrap.py

@@ -12,6 +12,7 @@ from ..helpers.modules import get_addon_paths, godooModules
 from ..helpers.modules_py import _install_py_reqs_by_odoo_cmd
 from ..helpers.system import run_cmd
 from .db.connection import DBConnection
+from .shell.shell import odoo_shell_run_script
 
 CLI = CommonCLI()
 
@@ -142,11 +143,12 @@ def bootstrap_odoo(
     install_base_modules: Annotated[
         bool,
         typer.Option(
-            ...,
             help="Install base and web modules if no other -i or -u is present in Bootstrap",
             rich_help_panel="Odoo",
         ),
     ] = True,
+    banner_text=CLI.odoo_launch.banner_text,
+    banner_bg_color=CLI.odoo_launch.banner_bg_color,
 ):
     """Bootstrap Odoo."""
 
@@ -186,4 +188,8 @@ def bootstrap_odoo(
     ret = run_cmd(cmd_string).returncode
     if ret != 0:
         LOGGER.error("Odoo-Bin Returned %d", ret)
+    if banner_text:
+        os.environ["ODOO_BANNER_TEXT"] = banner_text
+        os.environ["ODOO_BANNER_BG_COLOR"] = banner_bg_color
+        odoo_shell_run_script(script_name="odoo_banner", odoo_main_path=odoo_main_path, odoo_conf_path=odoo_conf_path)
     return CLI.returner(ret)

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/commands/db/query.py

@@ -100,10 +100,14 @@ def is_bootstrapped(
         password=db_password,
         db_name=db_name,
     )
-    boot = _is_bootstrapped(db_connection=connection)
-    LOGGER.info("Odoo Database Status: %s", boot.value)
-    return_code = 1 if boot == DB_BOOTSTRAP_STATUS.NO_DB else 2 if boot == DB_BOOTSTRAP_STATUS.EMPTY_DB else 0
-    raise typer.Exit(return_code)
+    bootstrap_value = _is_bootstrapped(db_connection=connection)
+    LOGGER.info("Odoo Database Status: %s", bootstrap_value.value)
+    ret_mapping = {
+        DB_BOOTSTRAP_STATUS.BOOTSTRAPPED: 0,
+        DB_BOOTSTRAP_STATUS.NO_DB: 20,
+        DB_BOOTSTRAP_STATUS.EMPTY_DB: 21,
+    }
+    raise typer.Exit(ret_mapping[bootstrap_value])
 
 
 def _get_installed_modules(db_connection: DBConnection, to_install=False):

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/commands/launch.py

@@ -59,7 +59,7 @@ def _launch_command(
     return " ".join(odoo_cmd)
 
 
-def pre_launch(
+def bootstrap_and_prep_launch_cmd(
     odoo_main_path: Path,
     workspace_addon_path: Path,
     thirdparty_addon_path: Path,
@@ -76,7 +76,7 @@ def pre_launch(
     launch_or_bootstrap: bool = False,
     languages: str = "de_DE,en_US",
 ):
-    """Start Bootstrap if database is not bootstrapped. And return Launch CMD.
+    """Start Bootstrap if database is not bootstrapped. Install Py Depends And return Launch CMD.
 
     Parameters
     ----------
@@ -227,7 +227,7 @@ def launch_odoo(
         password=db_password,
         db_name=db_name,
     )
-    launch_cmd = pre_launch(
+    launch_cmd = bootstrap_and_prep_launch_cmd(
         odoo_main_path=odoo_main_path,
         workspace_addon_path=workspace_addon_path,
         thirdparty_addon_path=thirdparty_addon_path,
@@ -288,7 +288,7 @@ def launch_import(
         db_name=db_name,
     )
 
-    launch_cmd = pre_launch(
+    launch_cmd = bootstrap_and_prep_launch_cmd(
         odoo_main_path=odoo_main_path,
         workspace_addon_path=workspace_addon_path,
         thirdparty_addon_path=thirdparty_addon_path,

godoo_cli-0.11.13/src/godoo_cli/commands/shell/scripts/odoo_banner.py

@@ -0,0 +1,79 @@
+"""Install Web Ribbon addon and set Text and color. To be Piped into Odoo Shell."""
+
+import logging
+import os
+from typing import Optional
+
+from odoo import api
+
+LOGGER = logging.getLogger(__name__)
+
+env: api.Environment = env  # Just to silence pyright # pyright: ignore # NOQA
+
+
+def set_banner(banner_text: Optional[str] = "Development", banner_background_color: Optional[str] = ""):
+    """Set Odoo top left Banner.
+
+    Parameters
+    ----------
+    banner_text : str, optional
+        Text to display on banner, by default ""
+    banner_background_color : str, optional
+        rbg("","","",""), by default ""
+    """
+    if not banner_background_color:
+        banner_background_color = "rgb(255,0,0)"
+
+    view_env = env["ir.ui.view"]
+    view_dic = {
+        "name": "godoo.dev_banner",
+        "type": "qweb",
+        "mode": "extension",
+        "active": True,
+        "inherit_id": env.ref("web.layout").id,
+        "arch_db": f"""
+            <data name="Godoo Dev Banner" inherit_id="web.layout" active="False">
+                <xpath expr="//body" position="inside">
+                    <div>
+                        <span id="oe_neutralize_banner" style="text-align: center; color: #FFFFFF; background-color: {banner_background_color}; position: relative; display: block; font-size: 16px;">
+                            {banner_text}
+                        </span>
+                    </div>
+                </xpath>
+            </data>
+        """,
+    }
+    if view := view_env.search([("name", "=", view_dic["name"])]):
+        LOGGER.info("Updating Banner view: %s", view_dic["name"])
+        view.update(view_dic)
+    else:
+        LOGGER.info(
+            "Creating Banner view: %s\nText: %s\nColor: %s", view_dic["name"], banner_text, banner_background_color
+        )
+        view_env.create(view_dic)
+
+
+def disable_record(ref):
+    if rec := env.ref(ref, raise_if_not_found=False):
+        if rec.active:
+            LOGGER.info("Disabling Record: %s", rec.display_name)
+            rec.active = False
+
+
+def remove_upgrade_test_ribbon():
+    disable_record("__upgrade__.upg_test_banner")
+    disable_record("__upgrade__.upg_test_ribbon")
+    disable_record("web.neutralize_banner")
+
+
+set_banner(
+    os.getenv("ODOO_BANNER_TEXT"),
+    os.getenv("ODOO_BANNER_BG_COLOR"),
+)
+remove_upgrade_test_ribbon()
+if ribb := env["ir.module.module"].search([("name", "=", "web_environment_ribbon"), ("state", "=", "installed")]):
+    LOGGER.info("Uninstalling Web Environment Ribbon addon")
+    ribb.button_immediate_uninstall()
+
+
+env.cr.commit()

{godoo_cli-0.11.12/src/godoo_cli/commands → godoo_cli-0.11.13/src/godoo_cli/commands/shell}/shell.py

@@ -5,9 +5,9 @@ from typing import List
 
 import typer
 
-from ..cli_common import CommonCLI
-from ..helpers.odoo_files import odoo_bin_get_version
-from ..helpers.system import run_cmd
+from ...cli_common import CommonCLI
+from ...helpers.odoo_files import odoo_bin_get_version
+from ...helpers.system import run_cmd
 
 CLI = CommonCLI()
 LOGGER = logging.getLogger(__name__)
@@ -67,6 +67,46 @@ def odoo_shell(
     return CLI.returner(ret.returncode)
 
 
+def complete_script_name():
+    script_folder = Path(__file__).parent / "scripts"
+    return [p.stem for p in script_folder.glob("*.py")]
+
+
+@CLI.unpacker
+@CLI.arg_annotator
+def odoo_shell_run_script(
+    script_name: str = typer.Argument(..., help="Internal Script to run", autocompletion=complete_script_name),
+    odoo_main_path=CLI.odoo_paths.bin_path,
+    odoo_conf_path=CLI.odoo_paths.conf_path,
+    db_host=CLI.database.db_host,
+    db_port=CLI.database.db_port,
+    db_name=CLI.database.db_name,
+    db_user=CLI.database.db_user,
+    db_password=CLI.database.db_password,
+):
+    """
+    Run Predefined Script using Odoo-Shell (Script selection in Tab-Complete).
+    """
+    script_folder = Path(__file__).parent / "scripts"
+    script_path = script_folder / f"{script_name}.py"
+    if not script_path.exists():
+        LOGGER.error("Script '%s' not found in %s", script_name, script_folder)
+        return CLI.returner(1)
+
+    shell_cmd = f"{str(odoo_main_path.absolute())}/odoo-bin shell --no-http"
+    if odoo_conf_path.exists():
+        shell_cmd += f" -c {str(odoo_conf_path.absolute())}"
+    else:
+        LOGGER.warning("No Odoo Config File found at %s", odoo_conf_path)
+        if not all([db_host, db_port, db_name, db_user, db_password]):
+            LOGGER.error("Missing database options and Config File. Aborting.")
+            return CLI.returner(1)
+        shell_cmd += f" --db_host={db_host} --db_port={db_port} --database={db_name} --db_user={db_user} --db_password={db_password}"
+
+    LOGGER.info("Running Script: %s", script_path)
+    run_cmd(shell_cmd, stdin=script_path.open("r"))
+
+
 def odoo_pregenerate_assets(odoo_main_path: Path):
     """Uses Odoo shell to Pregenerate Asset bundles in Odoo.
     Ensures the Asset bundles are present in Filestore

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/commands/test/test_load_data.py

@@ -7,8 +7,8 @@ from ...cli_common import CommonCLI
 from ...helpers.modules import get_addon_paths, godooModules
 from ...helpers.system import run_cmd
 from ..db.connection import DBConnection
-from ..launch import pre_launch
-from ..shell import odoo_shell
+from ..launch import bootstrap_and_prep_launch_cmd
+from ..shell.shell import odoo_shell
 
 CLI = CommonCLI()
 LOGGER = logging.getLogger(__name__)
@@ -87,7 +87,7 @@ def odoo_load_test_data(
         db_name=db_name,
     )
 
-    launch_cmd = pre_launch(
+    launch_cmd = bootstrap_and_prep_launch_cmd(
         odoo_main_path=odoo_main_path,
         workspace_addon_path=workspace_addon_path,
         thirdparty_addon_path=thirdparty_addon_path,

{godoo_cli-0.11.12 → godoo_cli-0.11.13}/src/godoo_cli/commands/test/test_run.py

@@ -4,15 +4,15 @@ from pathlib import Path
 from typing import List
 
 import typer
-from typing_extensions import Annotated
+from typing_extensions import Annotated, Optional
 
 from ...cli_common import CommonCLI
 from ...helpers.modules import get_addon_paths, godooModules
 from ...helpers.modules_git import get_changed_modules_and_depends
 from ...helpers.system import run_cmd
 from ..db.connection import DBConnection
-from ..launch import pre_launch
-from ..shell import odoo_pregenerate_assets
+from ..launch import bootstrap_and_prep_launch_cmd
+from ..shell.shell import odoo_pregenerate_assets
 
 CLI = CommonCLI()
 LOGGER = logging.getLogger(__name__)
@@ -47,12 +47,12 @@ def odoo_get_changed_modules(
     changed_modules = get_changed_modules_and_depends(diff_ref=diff_ref, addon_path=workspace_addon_path)
     if not changed_modules:
         return
-    print("\n".join(sorted([p.stem for p in changed_modules])))  # pylint: disable=print-used
+    print("\n".join(sorted([p.name for p in changed_modules])))  # pylint: disable=print-used
 
 
 @CLI.arg_annotator
 def odoo_run_tests(
-    test_modules: List[str] = typer.Argument(
+    test_module_names: List[str] = typer.Argument(
         ...,
         help="""
         Space separated list of Modules to Test or special commands:
@@ -76,7 +76,7 @@ def odoo_run_tests(
     db_user=CLI.database.db_user,
     db_password=CLI.database.db_password,
     skip_test_modules: Annotated[
-        List[str],
+        Optional[List[str]],
         typer.Option(envvar="ODOO_TEST_SKIP_MODULES", help="Modules not to Test even if specified in test_modules"),
     ] = None,
     odoo_log_level: str = typer.Option("test", help="Log level"),
@@ -87,7 +87,7 @@ def odoo_run_tests(
     Will set test specific odoo.conf if it needs to bootstrap
     """
 
-    test_module_names = _test_modules_special_cases(test_modules, workspace_addon_path)
+    test_module_names = _test_modules_special_cases(test_module_names, workspace_addon_path)
     addon_paths = get_addon_paths(odoo_main_path, workspace_addon_path, thirdparty_addon_path)
     module_reg = godooModules(addon_paths)
     test_modules = list(module_reg.get_modules(test_module_names))
@@ -146,7 +146,7 @@ def odoo_run_tests(
         db_name=db_name,
     )
 
-    launch_cmd = pre_launch(
+    launch_cmd = bootstrap_and_prep_launch_cmd(
         odoo_main_path=odoo_main_path,
         workspace_addon_path=workspace_addon_path,
         thirdparty_addon_path=thirdparty_addon_path,

godoo_cli-0.11.13/src/godoo_cli/version.py

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

godoo_cli-0.11.12/src/godoo_cli/version.py

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