gOdoo-cli 0.3.12__tar.gz → 0.3.14__tar.gz

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: godoo-cli
-Version: 0.3.12
+Version: 0.3.14
 Summary: Wrapper around Odoo-Bin with some convinience RPC functions.
 Home-page: https://github.com/OpenJKSoftware/gOdoo
 License: LGPL-3

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gOdoo-cli"
-version = "0.3.12"
+version = "0.3.14"
 description = "Wrapper around Odoo-Bin with some convinience RPC functions."
 authors = ["Joshua Kreuder <Joshua_Kreuder@outlook.com>"]
 license = "LGPL-3"

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/setup.py

@@ -41,7 +41,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'godoo-cli',
-    'version': '0.3.12',
+    'version': '0.3.14',
     'description': 'Wrapper around Odoo-Bin with some convinience RPC functions.',
     'long_description': '# gOdoo Dev Environment\n\n![OdooLogo](https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/odoo_logo.png)\n![ComposeLogo](https://raw.githubusercontent.com/docker/compose/v2/logo.png)\n\n[<img src="https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/godoo-main-cli.png" width="1000"/>](image.png)\n\n**gOdoo** is short for **go Odoo**. \\\nIt is a [Vscode Devcontainer](https://code.visualstudio.com/docs/remote/containers) Environment for [Odoo](https://odoo.com/)\nwith Python CLI `godoo` convenience wrapper around `odoo-bin`.\n\nThis repository is the base source for the Python package [godoo-cli](https://pypi.org/project/godoo-cli/) and serves as\nan all batteries included development environment.\n\nMade Possible by: [WEMPE Elektronic GmbH](https://wetech.de)\n\n# gOdoo-cli\n\nPython package that provides `godoo` command line interface around `odoo-bin`.\n\nIt\'s build with [Typer](https://github.com/tiangolo/typer) to provide some convenience Wrappers for Odoo development and\nDeployment.\n\nMost flags can be configured by Env variables. \\\nUse `godoo --help` to find out more. HINT: Install tab-completion with `godoo --install-completion`\n\n# Docker\n\nThis workspace also contains Docker and Docker-Compose files. \\\n\nThey are used to provide either easy Odoo instances where the source is pulled according to\n[ODOO_MANIFEST.yml](./ODOO_MANIFEST.yml), or as a all batteries included devcontainer for VScode.\n\n## Requirements\n\n- [Docker Compose](https://github.com/docker/compose)\n- [Traefik](https://doc.traefik.io/traefik/) container running with docker provider and "traefik" named docker network.\n  Example: [Traefik Devproxy](https://github.com/joshkreud/traefik_devproxy)\n- SSH Agent running. (check `echo $SSH_AUTH_SOCK`)\\\n  This gets passed trough in the Buildprocess to clone Thirdparty repos.\n\n## Just wanna have a quick and easy Odoo Instance?\n\n```bash\ngit clone https://github.com/OpenJKSoftware/gOdoo\ncd godoo\n. scripts/container_requirements.sh # Check Requirements\ndocker-compose build\ndocker-compose up\n# wait......\n# wait a bit mode ...\n# just a little bit longer ..\n# There we go.\n# Odoo should be reachable on \'https://godoo.docker.localhost\' assuming you didn\'t change .env TRAEFIK_HOST_RULE or COMPOSE_PROJECT_NAME\n```\n\n# Devcontainer\n\n## Features\n\n- All batteries included [Devcontainer](https://code.visualstudio.com/docs/remote/containers) with postgres service\n  Container and local DNS resolvig managed by [Traefik](https://doc.traefik.io/traefik/).\n- Easy fully working Odoo instance by `docker-compose up` with https access.\n- `godoo` CLI wrapper around Odoo. (Most flags can be configured by Environment Variables and are already preconfigured\n  in the Containers. See [.env.sample](./.env.sample))\n- `odoo-bin` is added to PATH and can thus be invoked from every folder.\n- Odoo will run in Proxy_Mode behind a Traefik reverse proxy for easy access on\n  `https://$COMPOSE_PROJECT_NAME.docker.localhost`\n- [Odoo Pylint plugin](https://github.com/OCA/pylint-odoo) preconfigured in vscode\n- Preinstalled vscode Extensions Highlights:\n  - [SQL Tools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) with preconfigured connection for\n    easy Database access in the Sidebar.\n  - [Docker Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) controls\n    container host.\n  - [Odoo Snippets](https://marketplace.visualstudio.com/items?itemName=mstuttgart.odoo-snippets)\n  - [Odoo Developments](https://marketplace.visualstudio.com/items?itemName=scapigliato.vsc-odoo-development) can Grab\n    Odoo Model information from a running Server\n  - [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)\n\n## Usage\n\n1. For Docker on windows: Clone the repo into the WSL2 Filesystem for better IO performance\n2. Have [Traefik](https://github.com/traefik/traefik) Running on `docker.localhost`\n   [Example](https://github.com/joshkreud/traefik_devproxy) \\\n   There must be a Docker network called `traefik` that can reach traefik.\n3. Open Devcontianer:\n   - If you have the Devcontainer CLI: `devcontainer open .`\n   - If not open the workspace in Local Vscode. In the Command pallete search for `Reopen in container`\n4. From **within the container** start Odoo using one of the following commands:\n   - You can enable godoo tab-completion by `godoo --install-completion`\n   - `make` -> Loads Odoo + Workspace Addons\n   - `make bare` -> Loads Odoo with ony `web` installed.\n   - `make kill` -> Search for `odoo-bin` processes and kill them\n   - `make reset` -> Drops DB, deletes config file and datafolder\n   - The full init script is available via "`godoo`". (See --help for Options)\n5. Open Odoo `https://$COMPOSE_PROJECT_NAME.docker.localhost`\\\n   For example `COMPOSE_PROJECT_NAME=godoo` --> [https://godoo.docker.localhost](https://godoo.docker.localhost)\n6. Login with `admin:admin`\n7. Profit!\n\n### Access to Odoo and Thirdparty addon Source\n\nYou can access the Odoo source by opening the VsCode workspace [full.code-workspace](full.code-workspace) from within\nthe Container. This will open a [Multi-Root Workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces).\nReally waiting for https://github.com/microsoft/vscode-remote-release/issues/3665 here.\n\n## Reset Devcontainer Data\n\nWhen you screwed up so bad its time to just start Over godoo has you covered:\n\n### Automatic Reset\n\nThere are 3 Options to reset the Dev Env.\n\n1. From **Outside** the Container run `make reset` in the project root to delete docker volumes and restart the\n   container. (Vscode will prompt to reconnect if still open)\n2. From **Outside** the Container run `make reset-hard` in the project root to force rebuild the main Odoo container and\n   then do the same as `make reset`\n3. From **Inside** the Container run `make reset` to drop the DB and delete varlib and the bootstrap flag, which is way\n   quicker than the other options.\n\n### Manual Reset\n\n1. Close vscode\n2. Remove `app` and `db` container from docker.\n3. Remove volumes: `db, odoo_thirdparty, odoo_web, vscode_extensions`\n4. Restart Devcontainer\n\n## Python Debugging\n\n### VsCode Debugging\n\nDebugging doesn\'t reliably work with\n[Odoo Multiprocess](https://www.odoo.com/documentation/14.0/developer/misc/other/cmdline.html#multiprocessing) mode\nenabled. \\\nThe container ships with a Vscode Debug profile, that sets `--workers 0` to allow for Debugging Breakpoints. See [.vscode/launch.json](./.vscode/launch.json)\n\n### Interactive Shell\n\nUse `godoo shell` to enter an interactive shell on the Database.\n\n# Odoo Modules\n\n## Third Party Modules (manifest.yml)\n\nThe `godoo` bootstrap function, will download some modules using git. \\\nWhich Repos to download is specified in `ODOO_MANIFEST.yml` ([Default](./ODOO_MANIFEST.yml)) \\\nNot all of the cloned addons are automatically installed. \\\nInstall them via the Apps Page in Odoo using `godoo rpc modules install` or using `odoo-bin`.\\\nModules downloaded on the Odoo Marketplace can be dropped as a `.zip` archive in [./thirdparty](./thirdparty)\n',
     'author': 'Joshua Kreuder',

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/src/godoo_cli/cli.py

@@ -5,6 +5,7 @@ from typing import Optional
 
 import typer
 from dotenv import load_dotenv
+from rich import print as rich_print
 
 from .commands import (
     bootstrap_odoo,
@@ -18,6 +19,7 @@ from .commands import (
     set_odoo_config,
     uninstall_modules,
 )
+from .helpers.odoo_files import odoo_bin_get_version
 from .helpers.system import set_logging
 from .version import __version__
 
@@ -66,6 +68,13 @@ def main_callback(
     set_logging(verbose=verbose)
 
 
+def print_versions(ctx: typer.Context):
+    rich_print(f"gOdoo Version: [bold green]{__version__}[/bold green]")
+    if mp := ctx.obj.odoo_main_path:
+        odoo_version = odoo_bin_get_version(mp)
+        rich_print(f"Odoo Version: [bold green]{odoo_version}[/bold green]")
+
+
 def main_cli():
     load_dotenv(".env", override=True)
 
@@ -78,6 +87,7 @@ def main_cli():
     )
 
     # Normal Subcommands
+    app.command("version")(print_versions)
     app.command("launch")(launch_odoo)
     app.command("bootstrap")(bootstrap_odoo)
     app.command("test")(odoo_test)

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/src/godoo_cli/commands/bootstrap.py

@@ -134,9 +134,9 @@ def bootstrap_odoo(
         help="folder that contains thirdparty repos like OCA",
     ),
     db_host: str = typer.Option(
-        ...,
+        "",
         envvar="ODOO_DB_HOST",
-        help="db hostname",
+        help="db hostname (empty for default socket)",
         rich_help_panel="Database Options",
     ),
     db_filter: str = typer.Option(
@@ -164,9 +164,9 @@ def bootstrap_odoo(
         rich_help_panel="Database Options",
     ),
     db_port: str = typer.Option(
-        ...,
+        "",
         envvar="ODOO_DB_PORT",
-        help="db host port",
+        help="db host port (empty for socket)",
         rich_help_panel="Database Options",
     ),
     extra_cmd_args: List[str] = typer.Option(None, help="extra agruments to pass to odoo-bin"),

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/src/godoo_cli/commands/launch.py

@@ -7,7 +7,7 @@ import typer
 
 from ..commands.rpc.cli import rpc_callback
 from ..helpers.cli import typer_retuner, typer_unpacker
-from ..helpers.odoo_files import get_odoo_module_paths
+from ..helpers.odoo_files import get_odoo_module_paths, odoo_bin_get_version
 from ..helpers.system import run_cmd
 from .bootstrap import bootstrap_odoo
 from .rpc import import_to_odoo
@@ -116,12 +116,18 @@ def launch_odoo(
     if ea := extra_args:
         extra_odoo_args += ea
 
+    odoo_main_path = ctx.obj.odoo_main_path
+    odoo_version = odoo_bin_get_version(odoo_main_path)
+
     if dev_mode:
         extra_odoo_args.append(
             "--dev xml,qweb" if load_data_path else "--dev xml,qweb,reload"
         )  # Prevent server restart if Importer threads will be spawned.
+        if "16.0" in odoo_version:
+            extra_odoo_args[-1] += ",werkzeug"
 
     if bootstraped and no_launch:
+        LOGGER.info("Exiting, because launch was disabled via CLI Argument")
         return typer_retuner(ret)
 
     if load_data_path:
@@ -136,7 +142,7 @@ def launch_odoo(
         loader_thread.start()
 
     cmd_string = _launch_command(
-        odoo_path=ctx.obj.odoo_main_path,
+        odoo_path=odoo_main_path,
         odoo_conf_path=ctx.obj.odoo_conf_path,
         extra_cmd_args=extra_odoo_args,
         workspace_addon_path=ctx.obj.workspace_addon_path,

{godoo_cli-0.3.12 → godoo_cli-0.3.14}/src/godoo_cli/helpers/odoo_files.py

@@ -6,14 +6,46 @@ from typing import List, Union
 
 from git import Repo
 
+from .system import run_cmd
+
 LOGGER = logging.getLogger(__name__)
 
 
+def odoo_bin_get_version(odoo_main_repo_path: Path) -> str:
+    """Get Odoo Version by calling 'odoo-bin --version'
+
+    Parameters
+    ----------
+    odoo_main_repo_path : Path
+        Path to odoo-bin folder
+
+    Returns
+    -------
+    str
+        odoo-bin --version output
+    """
+    odoo_bin_path = odoo_main_repo_path / "odoo-bin"
+    version_out = run_cmd(f"{odoo_bin_path.absolute()} --version", capture_output=True, text=True)
+    return version_out.stdout
+
+
 def get_zip_addon_path(thirdparty_path: Path) -> Path:
     return thirdparty_path / "custom"
 
 
-def folder_is_odoo_module(folder: Path):
+def folder_is_odoo_module(folder: Path) -> bool:
+    """Wether folder is a valid odoo module.
+
+    Parameters
+    ----------
+    folder : Path
+        Folder to check
+
+    Returns
+    -------
+    bool
+        true if folder contains a module
+    """
     return folder.is_dir() and any(folder.glob("__manifest__.py"))
 
 

godoo_cli-0.3.14/src/godoo_cli/version.py

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

godoo_cli-0.3.12/src/godoo_cli/version.py

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