odoo-devops-tools 1.23.2__tar.gz → 1.23.4__tar.gz

{odoo_devops_tools-1.23.2 → odoo_devops_tools-1.23.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odoo-devops-tools
-Version: 1.23.2
+Version: 1.23.4
 Summary: Build reproducible Odoo workspaces from a single project definition.
 Author: Roman Lacko
 License-Expression: MIT
@@ -123,14 +123,21 @@ Create a new workspace:
 odoo-compose --init ./odoo19
 ```
 
-Start the Docker Compose environment:
+This creates `./odoo19/odoo-project.ini` with this initial content:
+
+```ini
+[odoo]
+version = 19.0
+```
+
+Then start the Docker Compose environment:
 
 ```bash
 cd ./odoo19
-docker compose up -d
+docker compose up -d --build
 ```
 
-Initialize the Odoo database:
+Optionally initialize the Odoo database from the command line instead of through the web interface:
 
 ```bash
 docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
@@ -141,15 +148,6 @@ docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
 
 Docker Compose runs both Odoo and PostgreSQL. Odoo is available at http://localhost:8069.
 
-The Docker workflow uses the following `odoo-project.ini` configuration:
-
-```ini
-[odoo]
-version = 19.0
-```
-
-Edit this file when you want to add extra addons, change configuration values, pin repositories, or adjust Python dependency handling.
-
 ### 1.1. Adding extra addons
 
 To extend Odoo with additional functionality, add extra addons through `[addons.<name>]` sections in `odoo-project.ini`.
@@ -179,7 +177,7 @@ Sync the configured addon repositories and refresh the generated Docker workflow
 
 ```bash
 odoo-compose --sync-addons
-docker compose up --build -d
+docker compose up -d --build
 ```
 
 The addon repositories are cloned into `ROOT/odoo-addons/oca-web/` and `ROOT/odoo-addons/oca-helpdesk/` and bind-mounted into the Odoo container.
@@ -195,10 +193,10 @@ docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
   --stop-after-init
 ```
 
-For subsequent addon updates, run `click-odoo-update` inside the Odoo container:
+For subsequent addon updates, use the generated Docker update helper:
 
 ```bash
-docker compose exec odoo click-odoo-update -c /etc/odoo/odoo.conf -d odoo
+./docker/local/scripts/update.sh
 ```
 
 ### 1.2. Running Odoo from workspace source
@@ -223,19 +221,21 @@ Sync the Odoo source and generate the Docker artifacts:
 
 ```bash
 odoo-compose --sync-all
-docker compose up --build -d
+docker compose up -d --build
 ```
 
 The resolved Odoo source is bind-mounted read-only at `/opt/odoo`. The Odoo Python source from the base image is removed while its installed dependencies remain available.
 
-### 1.3. Backup and restore
+### 1.3. Script reference
 
-The Docker workflow generates platform-specific helpers under `ROOT/docker/local/scripts/` for backing up and restoring the PostgreSQL database and Odoo filestore independently. Unix-like systems generate `.sh` helpers; Windows generates the corresponding `.bat` helpers.
+The Docker workflow generates platform-specific helper scripts under `ROOT/docker/local/scripts/`. Unix-like systems generate `.sh` helpers; Windows generates the corresponding `.bat` helpers.
 
 On Unix-like systems:
 
 ```text
 docker/local/scripts/
+├── shell.sh
+├── update.sh
 ├── backup-db.sh
 ├── restore-db.sh
 ├── neutralize-db.sh
@@ -246,15 +246,41 @@ docker/local/scripts/
 └── restore-filestore-restic.sh
 ```
 
-On Windows the same helper names are generated with the `.bat` extension instead. The helpers stream backup data directly between the Docker containers and files on the host. No backup directory is mounted into the containers, and no intermediate backup file is created inside a container. The examples below use the Unix `.sh` form.
+The examples below use the Unix `.sh` form.
 
-The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it for any command with `ODOO_DB_NAME`:
+#### 1.3.1. shell
+
+Opens an Odoo shell for the configured database:
 
 ```bash
-ODOO_DB_NAME=odoo_test ./docker/local/scripts/backup-db.sh
+./docker/local/scripts/shell.sh
+```
+
+The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it with `ODOO_DB_NAME`:
+
+```bash
+ODOO_DB_NAME=odoo_test ./docker/local/scripts/shell.sh
+```
+
+Any extra arguments are passed through to the underlying Odoo shell command.
+
+#### 1.3.2. update
+
+Updates installed addons using `click-odoo-update`:
+
+```bash
+./docker/local/scripts/update.sh
 ```
 
-#### 1.3.1. Database backup
+The default database name follows the same `ODOO_DB_NAME` convention as the shell and database helpers.
+
+Any extra arguments are passed through to `click-odoo-update`:
+
+```bash
+./docker/local/scripts/update.sh --update-all
+```
+
+#### 1.3.3. Database backup
 
 Create a PostgreSQL custom-format dump under `ROOT/odoo-backups/`:
 
@@ -274,7 +300,13 @@ Pass an output path explicitly when needed:
 ./docker/local/scripts/backup-db.sh ./odoo-backups/pre-upgrade.dump
 ```
 
-#### 1.3.2. Database restore
+The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it for any command with `ODOO_DB_NAME`:
+
+```bash
+ODOO_DB_NAME=odoo_test ./docker/local/scripts/backup-db.sh
+```
+
+#### 1.3.4. Database restore
 
 Restore a database dump with `pg_restore`:
 
@@ -311,7 +343,7 @@ To restore the same dump into another database without replacing the default dat
 ODOO_DB_NAME=odoo_restore ./docker/local/scripts/restore-db.sh ./odoo-backups/pre-upgrade.dump
 ```
 
-#### 1.3.3. Database neutralization
+#### 1.3.5. Database neutralization
 
 For development or test databases restored from production, run the generated neutralization helper explicitly:
 
@@ -341,7 +373,7 @@ docker compose up -d odoo
 
 `--copy` / `--move` and neutralization serve different purposes: copy/move controls restored database identity, while neutralization controls production side effects.
 
-#### 1.3.4. Filestore backup
+#### 1.3.6. Filestore backup
 
 Create a compressed tar archive of the selected database filestore:
 
@@ -372,7 +404,7 @@ docker compose stop odoo
 docker compose up -d odoo
 ```
 
-#### 1.3.5. Filestore restore
+#### 1.3.7. Filestore restore
 
 Restore a filestore archive:
 
@@ -396,20 +428,10 @@ ODOO_DB_NAME=odoo_restore ./docker/local/scripts/restore-filestore.sh ./odoo-bac
 
 Database and filestore backups are intentionally separate. This allows either part to be restored independently while still making it possible to create matching database and filestore backups when both are needed.
 
-#### 1.3.6. Restic filestore backup
+#### 1.3.8. Restic filestore backup
 
 The generated Docker image also includes `restic`. Restic is an additional option intended especially for large filestores where incremental snapshots and deduplication are useful.
 
-The Docker workflow generates platform-specific restic helpers: `.sh` on Unix-like systems and `.bat` on Windows.
-
-```text
-docker/local/scripts/restic.sh
-docker/local/scripts/backup-filestore-restic.sh
-docker/local/scripts/restore-filestore-restic.sh
-```
-
-The corresponding Windows helpers use the same names with the `.bat` extension. The `restic` helper runs the `restic` binary from the generated Odoo image against the same `odoo-data` volume. The restic cache is kept under `/var/lib/odoo/.cache/restic`, outside the filestore directory, so it persists between one-off containers without being included in filestore backups.
-
 Set `RESTIC_REPOSITORY` and either `RESTIC_PASSWORD_FILE` or `RESTIC_PASSWORD` before using the helpers. For a local repository on the Docker host, use an absolute path. The wrapper automatically bind-mounts the repository into the one-off container; Windows drive paths such as `C:\backups\odoo` are supported by `restic.bat`:
 
 ```bash
@@ -444,7 +466,7 @@ List or inspect snapshots through the generic wrapper:
 ./docker/local/scripts/restic.sh check
 ```
 
-#### 1.3.7. Restic filestore restore
+#### 1.3.9. Restic filestore restore
 
 Restore the latest matching filestore snapshot:
 
@@ -524,16 +546,7 @@ odoo-compose --init ./odoo19 --sync-all --create-venv \
 > **Note**
 > Make sure PostgreSQL is running at the configured host and the configured database user exists.
 
-Start Odoo with the generated script:
-
-```bash
-cd ./odoo19
-./odoo-scripts/run.sh
-```
-
-Odoo starts with the generated configuration from `./odoo-configs/odoo-server.conf` and is available at http://localhost:8069.
-
-The native workflow uses the following `odoo-project.ini` configuration, with PostgreSQL connection settings added to `[config]`:
+This creates `./odoo19/odoo-project.ini` with this initial content:
 
 ```ini
 [odoo]
@@ -546,7 +559,14 @@ db_user = odoo
 db_password = odoo
 ```
 
-Edit this file when you want to add extra addons, change configuration values, pin repositories, or adjust Python dependency handling.
+Then start Odoo with the generated script:
+
+```bash
+cd ./odoo19
+./odoo-scripts/run.sh
+```
+
+Odoo starts with the generated configuration from `./odoo-configs/odoo-server.conf` and is available at http://localhost:8069.
 
 ### 2.1. Adding extra addons
 

{odoo_devops_tools-1.23.2 → odoo_devops_tools-1.23.4}/README.md

@@ -95,14 +95,21 @@ Create a new workspace:
 odoo-compose --init ./odoo19
 ```
 
-Start the Docker Compose environment:
+This creates `./odoo19/odoo-project.ini` with this initial content:
+
+```ini
+[odoo]
+version = 19.0
+```
+
+Then start the Docker Compose environment:
 
 ```bash
 cd ./odoo19
-docker compose up -d
+docker compose up -d --build
 ```
 
-Initialize the Odoo database:
+Optionally initialize the Odoo database from the command line instead of through the web interface:
 
 ```bash
 docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
@@ -113,15 +120,6 @@ docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
 
 Docker Compose runs both Odoo and PostgreSQL. Odoo is available at http://localhost:8069.
 
-The Docker workflow uses the following `odoo-project.ini` configuration:
-
-```ini
-[odoo]
-version = 19.0
-```
-
-Edit this file when you want to add extra addons, change configuration values, pin repositories, or adjust Python dependency handling.
-
 ### 1.1. Adding extra addons
 
 To extend Odoo with additional functionality, add extra addons through `[addons.<name>]` sections in `odoo-project.ini`.
@@ -151,7 +149,7 @@ Sync the configured addon repositories and refresh the generated Docker workflow
 
 ```bash
 odoo-compose --sync-addons
-docker compose up --build -d
+docker compose up -d --build
 ```
 
 The addon repositories are cloned into `ROOT/odoo-addons/oca-web/` and `ROOT/odoo-addons/oca-helpdesk/` and bind-mounted into the Odoo container.
@@ -167,10 +165,10 @@ docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
   --stop-after-init
 ```
 
-For subsequent addon updates, run `click-odoo-update` inside the Odoo container:
+For subsequent addon updates, use the generated Docker update helper:
 
 ```bash
-docker compose exec odoo click-odoo-update -c /etc/odoo/odoo.conf -d odoo
+./docker/local/scripts/update.sh
 ```
 
 ### 1.2. Running Odoo from workspace source
@@ -195,19 +193,21 @@ Sync the Odoo source and generate the Docker artifacts:
 
 ```bash
 odoo-compose --sync-all
-docker compose up --build -d
+docker compose up -d --build
 ```
 
 The resolved Odoo source is bind-mounted read-only at `/opt/odoo`. The Odoo Python source from the base image is removed while its installed dependencies remain available.
 
-### 1.3. Backup and restore
+### 1.3. Script reference
 
-The Docker workflow generates platform-specific helpers under `ROOT/docker/local/scripts/` for backing up and restoring the PostgreSQL database and Odoo filestore independently. Unix-like systems generate `.sh` helpers; Windows generates the corresponding `.bat` helpers.
+The Docker workflow generates platform-specific helper scripts under `ROOT/docker/local/scripts/`. Unix-like systems generate `.sh` helpers; Windows generates the corresponding `.bat` helpers.
 
 On Unix-like systems:
 
 ```text
 docker/local/scripts/
+├── shell.sh
+├── update.sh
 ├── backup-db.sh
 ├── restore-db.sh
 ├── neutralize-db.sh
@@ -218,15 +218,41 @@ docker/local/scripts/
 └── restore-filestore-restic.sh
 ```
 
-On Windows the same helper names are generated with the `.bat` extension instead. The helpers stream backup data directly between the Docker containers and files on the host. No backup directory is mounted into the containers, and no intermediate backup file is created inside a container. The examples below use the Unix `.sh` form.
+The examples below use the Unix `.sh` form.
 
-The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it for any command with `ODOO_DB_NAME`:
+#### 1.3.1. shell
+
+Opens an Odoo shell for the configured database:
 
 ```bash
-ODOO_DB_NAME=odoo_test ./docker/local/scripts/backup-db.sh
+./docker/local/scripts/shell.sh
+```
+
+The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it with `ODOO_DB_NAME`:
+
+```bash
+ODOO_DB_NAME=odoo_test ./docker/local/scripts/shell.sh
+```
+
+Any extra arguments are passed through to the underlying Odoo shell command.
+
+#### 1.3.2. update
+
+Updates installed addons using `click-odoo-update`:
+
+```bash
+./docker/local/scripts/update.sh
 ```
 
-#### 1.3.1. Database backup
+The default database name follows the same `ODOO_DB_NAME` convention as the shell and database helpers.
+
+Any extra arguments are passed through to `click-odoo-update`:
+
+```bash
+./docker/local/scripts/update.sh --update-all
+```
+
+#### 1.3.3. Database backup
 
 Create a PostgreSQL custom-format dump under `ROOT/odoo-backups/`:
 
@@ -246,7 +272,13 @@ Pass an output path explicitly when needed:
 ./docker/local/scripts/backup-db.sh ./odoo-backups/pre-upgrade.dump
 ```
 
-#### 1.3.2. Database restore
+The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it for any command with `ODOO_DB_NAME`:
+
+```bash
+ODOO_DB_NAME=odoo_test ./docker/local/scripts/backup-db.sh
+```
+
+#### 1.3.4. Database restore
 
 Restore a database dump with `pg_restore`:
 
@@ -283,7 +315,7 @@ To restore the same dump into another database without replacing the default dat
 ODOO_DB_NAME=odoo_restore ./docker/local/scripts/restore-db.sh ./odoo-backups/pre-upgrade.dump
 ```
 
-#### 1.3.3. Database neutralization
+#### 1.3.5. Database neutralization
 
 For development or test databases restored from production, run the generated neutralization helper explicitly:
 
@@ -313,7 +345,7 @@ docker compose up -d odoo
 
 `--copy` / `--move` and neutralization serve different purposes: copy/move controls restored database identity, while neutralization controls production side effects.
 
-#### 1.3.4. Filestore backup
+#### 1.3.6. Filestore backup
 
 Create a compressed tar archive of the selected database filestore:
 
@@ -344,7 +376,7 @@ docker compose stop odoo
 docker compose up -d odoo
 ```
 
-#### 1.3.5. Filestore restore
+#### 1.3.7. Filestore restore
 
 Restore a filestore archive:
 
@@ -368,20 +400,10 @@ ODOO_DB_NAME=odoo_restore ./docker/local/scripts/restore-filestore.sh ./odoo-bac
 
 Database and filestore backups are intentionally separate. This allows either part to be restored independently while still making it possible to create matching database and filestore backups when both are needed.
 
-#### 1.3.6. Restic filestore backup
+#### 1.3.8. Restic filestore backup
 
 The generated Docker image also includes `restic`. Restic is an additional option intended especially for large filestores where incremental snapshots and deduplication are useful.
 
-The Docker workflow generates platform-specific restic helpers: `.sh` on Unix-like systems and `.bat` on Windows.
-
-```text
-docker/local/scripts/restic.sh
-docker/local/scripts/backup-filestore-restic.sh
-docker/local/scripts/restore-filestore-restic.sh
-```
-
-The corresponding Windows helpers use the same names with the `.bat` extension. The `restic` helper runs the `restic` binary from the generated Odoo image against the same `odoo-data` volume. The restic cache is kept under `/var/lib/odoo/.cache/restic`, outside the filestore directory, so it persists between one-off containers without being included in filestore backups.
-
 Set `RESTIC_REPOSITORY` and either `RESTIC_PASSWORD_FILE` or `RESTIC_PASSWORD` before using the helpers. For a local repository on the Docker host, use an absolute path. The wrapper automatically bind-mounts the repository into the one-off container; Windows drive paths such as `C:\backups\odoo` are supported by `restic.bat`:
 
 ```bash
@@ -416,7 +438,7 @@ List or inspect snapshots through the generic wrapper:
 ./docker/local/scripts/restic.sh check
 ```
 
-#### 1.3.7. Restic filestore restore
+#### 1.3.9. Restic filestore restore
 
 Restore the latest matching filestore snapshot:
 
@@ -496,16 +518,7 @@ odoo-compose --init ./odoo19 --sync-all --create-venv \
 > **Note**
 > Make sure PostgreSQL is running at the configured host and the configured database user exists.
 
-Start Odoo with the generated script:
-
-```bash
-cd ./odoo19
-./odoo-scripts/run.sh
-```
-
-Odoo starts with the generated configuration from `./odoo-configs/odoo-server.conf` and is available at http://localhost:8069.
-
-The native workflow uses the following `odoo-project.ini` configuration, with PostgreSQL connection settings added to `[config]`:
+This creates `./odoo19/odoo-project.ini` with this initial content:
 
 ```ini
 [odoo]
@@ -518,7 +531,14 @@ db_user = odoo
 db_password = odoo
 ```
 
-Edit this file when you want to add extra addons, change configuration values, pin repositories, or adjust Python dependency handling.
+Then start Odoo with the generated script:
+
+```bash
+cd ./odoo19
+./odoo-scripts/run.sh
+```
+
+Odoo starts with the generated configuration from `./odoo-configs/odoo-server.conf` and is available at http://localhost:8069.
 
 ### 2.1. Adding extra addons
 

odoo_devops_tools-1.23.4/odoo_devops_tools/__init__.py

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

{odoo_devops_tools-1.23.2 → odoo_devops_tools-1.23.4}/odoo_devops_tools/env.py

@@ -3125,6 +3125,52 @@ echo "INFO: Database restore completed: ${{DB_NAME}}"
     return _write_docker_local_script(layout, "restore-db", content)
 
 
+def write_docker_shell_sh(layout: Layout, cfg: ProjectConfig) -> Path:
+    default_db_name = shlex.quote(_docker_default_db_name(cfg))
+    content = fr"""#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${{BASH_SOURCE[0]}}")" && pwd)"
+ROOT_DIR="$(cd "${{SCRIPT_DIR}}/../../.." && pwd)"
+DEFAULT_DB_NAME={default_db_name}
+DB_NAME="${{ODOO_DB_NAME:-${{DEFAULT_DB_NAME}}}}"
+
+cd "${{ROOT_DIR}}"
+
+echo "INFO: Opening Odoo shell for database '${{DB_NAME}}'."
+exec docker compose run --rm --no-deps \
+  --entrypoint odoo odoo \
+  shell \
+  -c /etc/odoo/odoo.conf \
+  -d "${{DB_NAME}}" \
+  "$@"
+"""
+    return _write_docker_local_script(layout, "shell", content)
+
+
+def write_docker_update_sh(layout: Layout, cfg: ProjectConfig) -> Path:
+    default_db_name = shlex.quote(_docker_default_db_name(cfg))
+    content = fr"""#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${{BASH_SOURCE[0]}}")" && pwd)"
+ROOT_DIR="$(cd "${{SCRIPT_DIR}}/../../.." && pwd)"
+DEFAULT_DB_NAME={default_db_name}
+DB_NAME="${{ODOO_DB_NAME:-${{DEFAULT_DB_NAME}}}}"
+
+cd "${{ROOT_DIR}}"
+
+echo "INFO: Updating Odoo addons for database '${{DB_NAME}}'. Passing through any extra arguments."
+exec docker compose run --rm --no-deps -T \
+  --entrypoint click-odoo-update odoo \
+  -c /etc/odoo/odoo.conf \
+  -d "${{DB_NAME}}" \
+  --log-level debug \
+  "$@"
+"""
+    return _write_docker_local_script(layout, "update", content)
+
+
 def write_docker_neutralize_db_sh(layout: Layout, cfg: ProjectConfig) -> Path:
     default_db_name = shlex.quote(_docker_default_db_name(cfg))
     odoo_major_version = _parse_odoo_version(cfg.odoo.version)
@@ -3617,6 +3663,54 @@ exit /b 2
     return _write_docker_local_script(layout, "restore-db", content, ext="bat")
 
 
+def write_docker_shell_bat(layout: Layout, cfg: ProjectConfig) -> Path:
+    default_db_name = _docker_default_db_name(cfg).replace("%", "%%")
+    content = rf"""@echo off
+setlocal
+
+set "SCRIPT_DIR=%~dp0"
+if "%SCRIPT_DIR:~-1%"=="\" set "SCRIPT_DIR=%SCRIPT_DIR:~0,-1%"
+for %%I in ("%SCRIPT_DIR%\..\..\..") do set "ROOT_DIR=%%~fI"
+set "DEFAULT_DB_NAME={default_db_name}"
+if defined ODOO_DB_NAME (
+  set "DB_NAME=%ODOO_DB_NAME%"
+) else (
+  set "DB_NAME=%DEFAULT_DB_NAME%"
+)
+
+cd /d "%ROOT_DIR%" || exit /b 1
+
+echo INFO: Opening Odoo shell for database '%DB_NAME%'.
+docker compose run --rm --no-deps --entrypoint odoo odoo shell -c /etc/odoo/odoo.conf -d "%DB_NAME%" %*
+exit /b %ERRORLEVEL%
+"""
+    return _write_docker_local_script(layout, "shell", content, ext="bat")
+
+
+def write_docker_update_bat(layout: Layout, cfg: ProjectConfig) -> Path:
+    default_db_name = _docker_default_db_name(cfg).replace("%", "%%")
+    content = rf"""@echo off
+setlocal
+
+set "SCRIPT_DIR=%~dp0"
+if "%SCRIPT_DIR:~-1%"=="\" set "SCRIPT_DIR=%SCRIPT_DIR:~0,-1%"
+for %%I in ("%SCRIPT_DIR%\..\..\..") do set "ROOT_DIR=%%~fI"
+set "DEFAULT_DB_NAME={default_db_name}"
+if defined ODOO_DB_NAME (
+  set "DB_NAME=%ODOO_DB_NAME%"
+) else (
+  set "DB_NAME=%DEFAULT_DB_NAME%"
+)
+
+cd /d "%ROOT_DIR%" || exit /b 1
+
+echo INFO: Updating Odoo addons for database '%DB_NAME%'. Passing through any extra arguments.
+docker compose run --rm --no-deps -T --entrypoint click-odoo-update odoo -c /etc/odoo/odoo.conf -d "%DB_NAME%" --log-level debug %*
+exit /b %ERRORLEVEL%
+"""
+    return _write_docker_local_script(layout, "update", content, ext="bat")
+
+
 def write_docker_neutralize_db_bat(layout: Layout, cfg: ProjectConfig) -> Path:
     default_db_name = _docker_default_db_name(cfg).replace("%", "%%")
     odoo_major_version = _parse_odoo_version(cfg.odoo.version)
@@ -4027,6 +4121,8 @@ exit /b 2
 def write_docker_local_scripts(layout: Layout, cfg: ProjectConfig) -> dict[str, Path]:
     if sys.platform.startswith("win"):
         return {
+            "shell": write_docker_shell_bat(layout, cfg),
+            "update": write_docker_update_bat(layout, cfg),
             "backup_db": write_docker_backup_db_bat(layout, cfg),
             "restore_db": write_docker_restore_db_bat(layout, cfg),
             "neutralize_db": write_docker_neutralize_db_bat(layout, cfg),
@@ -4038,6 +4134,8 @@ def write_docker_local_scripts(layout: Layout, cfg: ProjectConfig) -> dict[str,
         }
 
     return {
+        "shell": write_docker_shell_sh(layout, cfg),
+        "update": write_docker_update_sh(layout, cfg),
         "backup_db": write_docker_backup_db_sh(layout, cfg),
         "restore_db": write_docker_restore_db_sh(layout, cfg),
         "neutralize_db": write_docker_neutralize_db_sh(layout, cfg),

{odoo_devops_tools-1.23.2 → odoo_devops_tools-1.23.4}/odoo_devops_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odoo-devops-tools
-Version: 1.23.2
+Version: 1.23.4
 Summary: Build reproducible Odoo workspaces from a single project definition.
 Author: Roman Lacko
 License-Expression: MIT
@@ -123,14 +123,21 @@ Create a new workspace:
 odoo-compose --init ./odoo19
 ```
 
-Start the Docker Compose environment:
+This creates `./odoo19/odoo-project.ini` with this initial content:
+
+```ini
+[odoo]
+version = 19.0
+```
+
+Then start the Docker Compose environment:
 
 ```bash
 cd ./odoo19
-docker compose up -d
+docker compose up -d --build
 ```
 
-Initialize the Odoo database:
+Optionally initialize the Odoo database from the command line instead of through the web interface:
 
 ```bash
 docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
@@ -141,15 +148,6 @@ docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
 
 Docker Compose runs both Odoo and PostgreSQL. Odoo is available at http://localhost:8069.
 
-The Docker workflow uses the following `odoo-project.ini` configuration:
-
-```ini
-[odoo]
-version = 19.0
-```
-
-Edit this file when you want to add extra addons, change configuration values, pin repositories, or adjust Python dependency handling.
-
 ### 1.1. Adding extra addons
 
 To extend Odoo with additional functionality, add extra addons through `[addons.<name>]` sections in `odoo-project.ini`.
@@ -179,7 +177,7 @@ Sync the configured addon repositories and refresh the generated Docker workflow
 
 ```bash
 odoo-compose --sync-addons
-docker compose up --build -d
+docker compose up -d --build
 ```
 
 The addon repositories are cloned into `ROOT/odoo-addons/oca-web/` and `ROOT/odoo-addons/oca-helpdesk/` and bind-mounted into the Odoo container.
@@ -195,10 +193,10 @@ docker compose run --rm odoo -- -c /etc/odoo/odoo.conf -d odoo \
   --stop-after-init
 ```
 
-For subsequent addon updates, run `click-odoo-update` inside the Odoo container:
+For subsequent addon updates, use the generated Docker update helper:
 
 ```bash
-docker compose exec odoo click-odoo-update -c /etc/odoo/odoo.conf -d odoo
+./docker/local/scripts/update.sh
 ```
 
 ### 1.2. Running Odoo from workspace source
@@ -223,19 +221,21 @@ Sync the Odoo source and generate the Docker artifacts:
 
 ```bash
 odoo-compose --sync-all
-docker compose up --build -d
+docker compose up -d --build
 ```
 
 The resolved Odoo source is bind-mounted read-only at `/opt/odoo`. The Odoo Python source from the base image is removed while its installed dependencies remain available.
 
-### 1.3. Backup and restore
+### 1.3. Script reference
 
-The Docker workflow generates platform-specific helpers under `ROOT/docker/local/scripts/` for backing up and restoring the PostgreSQL database and Odoo filestore independently. Unix-like systems generate `.sh` helpers; Windows generates the corresponding `.bat` helpers.
+The Docker workflow generates platform-specific helper scripts under `ROOT/docker/local/scripts/`. Unix-like systems generate `.sh` helpers; Windows generates the corresponding `.bat` helpers.
 
 On Unix-like systems:
 
 ```text
 docker/local/scripts/
+├── shell.sh
+├── update.sh
 ├── backup-db.sh
 ├── restore-db.sh
 ├── neutralize-db.sh
@@ -246,15 +246,41 @@ docker/local/scripts/
 └── restore-filestore-restic.sh
 ```
 
-On Windows the same helper names are generated with the `.bat` extension instead. The helpers stream backup data directly between the Docker containers and files on the host. No backup directory is mounted into the containers, and no intermediate backup file is created inside a container. The examples below use the Unix `.sh` form.
+The examples below use the Unix `.sh` form.
 
-The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it for any command with `ODOO_DB_NAME`:
+#### 1.3.1. shell
+
+Opens an Odoo shell for the configured database:
 
 ```bash
-ODOO_DB_NAME=odoo_test ./docker/local/scripts/backup-db.sh
+./docker/local/scripts/shell.sh
+```
+
+The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it with `ODOO_DB_NAME`:
+
+```bash
+ODOO_DB_NAME=odoo_test ./docker/local/scripts/shell.sh
+```
+
+Any extra arguments are passed through to the underlying Odoo shell command.
+
+#### 1.3.2. update
+
+Updates installed addons using `click-odoo-update`:
+
+```bash
+./docker/local/scripts/update.sh
 ```
 
-#### 1.3.1. Database backup
+The default database name follows the same `ODOO_DB_NAME` convention as the shell and database helpers.
+
+Any extra arguments are passed through to `click-odoo-update`:
+
+```bash
+./docker/local/scripts/update.sh --update-all
+```
+
+#### 1.3.3. Database backup
 
 Create a PostgreSQL custom-format dump under `ROOT/odoo-backups/`:
 
@@ -274,7 +300,13 @@ Pass an output path explicitly when needed:
 ./docker/local/scripts/backup-db.sh ./odoo-backups/pre-upgrade.dump
 ```
 
-#### 1.3.2. Database restore
+The default database name is taken from `[config].db_name` when configured, otherwise it is `odoo`. Override it for any command with `ODOO_DB_NAME`:
+
+```bash
+ODOO_DB_NAME=odoo_test ./docker/local/scripts/backup-db.sh
+```
+
+#### 1.3.4. Database restore
 
 Restore a database dump with `pg_restore`:
 
@@ -311,7 +343,7 @@ To restore the same dump into another database without replacing the default dat
 ODOO_DB_NAME=odoo_restore ./docker/local/scripts/restore-db.sh ./odoo-backups/pre-upgrade.dump
 ```
 
-#### 1.3.3. Database neutralization
+#### 1.3.5. Database neutralization
 
 For development or test databases restored from production, run the generated neutralization helper explicitly:
 
@@ -341,7 +373,7 @@ docker compose up -d odoo
 
 `--copy` / `--move` and neutralization serve different purposes: copy/move controls restored database identity, while neutralization controls production side effects.
 
-#### 1.3.4. Filestore backup
+#### 1.3.6. Filestore backup
 
 Create a compressed tar archive of the selected database filestore:
 
@@ -372,7 +404,7 @@ docker compose stop odoo
 docker compose up -d odoo
 ```
 
-#### 1.3.5. Filestore restore
+#### 1.3.7. Filestore restore
 
 Restore a filestore archive:
 
@@ -396,20 +428,10 @@ ODOO_DB_NAME=odoo_restore ./docker/local/scripts/restore-filestore.sh ./odoo-bac
 
 Database and filestore backups are intentionally separate. This allows either part to be restored independently while still making it possible to create matching database and filestore backups when both are needed.
 
-#### 1.3.6. Restic filestore backup
+#### 1.3.8. Restic filestore backup
 
 The generated Docker image also includes `restic`. Restic is an additional option intended especially for large filestores where incremental snapshots and deduplication are useful.
 
-The Docker workflow generates platform-specific restic helpers: `.sh` on Unix-like systems and `.bat` on Windows.
-
-```text
-docker/local/scripts/restic.sh
-docker/local/scripts/backup-filestore-restic.sh
-docker/local/scripts/restore-filestore-restic.sh
-```
-
-The corresponding Windows helpers use the same names with the `.bat` extension. The `restic` helper runs the `restic` binary from the generated Odoo image against the same `odoo-data` volume. The restic cache is kept under `/var/lib/odoo/.cache/restic`, outside the filestore directory, so it persists between one-off containers without being included in filestore backups.
-
 Set `RESTIC_REPOSITORY` and either `RESTIC_PASSWORD_FILE` or `RESTIC_PASSWORD` before using the helpers. For a local repository on the Docker host, use an absolute path. The wrapper automatically bind-mounts the repository into the one-off container; Windows drive paths such as `C:\backups\odoo` are supported by `restic.bat`:
 
 ```bash
@@ -444,7 +466,7 @@ List or inspect snapshots through the generic wrapper:
 ./docker/local/scripts/restic.sh check
 ```
 
-#### 1.3.7. Restic filestore restore
+#### 1.3.9. Restic filestore restore
 
 Restore the latest matching filestore snapshot:
 
@@ -524,16 +546,7 @@ odoo-compose --init ./odoo19 --sync-all --create-venv \
 > **Note**
 > Make sure PostgreSQL is running at the configured host and the configured database user exists.
 
-Start Odoo with the generated script:
-
-```bash
-cd ./odoo19
-./odoo-scripts/run.sh
-```
-
-Odoo starts with the generated configuration from `./odoo-configs/odoo-server.conf` and is available at http://localhost:8069.
-
-The native workflow uses the following `odoo-project.ini` configuration, with PostgreSQL connection settings added to `[config]`:
+This creates `./odoo19/odoo-project.ini` with this initial content:
 
 ```ini
 [odoo]
@@ -546,7 +559,14 @@ db_user = odoo
 db_password = odoo
 ```
 
-Edit this file when you want to add extra addons, change configuration values, pin repositories, or adjust Python dependency handling.
+Then start Odoo with the generated script:
+
+```bash
+cd ./odoo19
+./odoo-scripts/run.sh
+```
+
+Odoo starts with the generated configuration from `./odoo-configs/odoo-server.conf` and is available at http://localhost:8069.
 
 ### 2.1. Adding extra addons
 

{odoo_devops_tools-1.23.2 → odoo_devops_tools-1.23.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "odoo-devops-tools"
-version = "1.23.2"
+version = "1.23.4"
 description = "Build reproducible Odoo workspaces from a single project definition."
 readme = "README.md"
 license = "MIT"

odoo_devops_tools-1.23.2/odoo_devops_tools/__init__.py

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