odoo-devops-tools 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

odoo_devops_tools/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.0.1"

odoo_devops_tools/env.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 """
-odk-env
+odt-env
 
 Provision and sync a reproducible Odoo workspace from an INI configuration file
 """
@@ -23,7 +23,7 @@ from typing import Any, Dict, Iterable, Optional
 
 from . import __version__
 
-_logger = logging.getLogger("odk-env")
+_logger = logging.getLogger("odt-env")
 
 _DEFAULT_REQUIREMENTS = [
     "pip",
@@ -604,13 +604,13 @@ def _filter_requirements_file(
                 include_rel = parts[1].strip()
                 include_path = (req_path.parent / include_rel).resolve()
 
-                out_lines.append(f"# odk-env: begin include {include_rel}")
+                out_lines.append(f"# odt-env: begin include {include_rel}")
                 if include_path in visited:
-                    out_lines.append(f"# odk-env: skipped recursive include {include_rel}")
+                    out_lines.append(f"# odt-env: skipped recursive include {include_rel}")
                 else:
                     visited.add(include_path)
                     out_lines.extend(_filter_requirements_file(include_path, ignore_names, visited=visited))
-                out_lines.append(f"# odk-env: end include {include_rel}")
+                out_lines.append(f"# odt-env: end include {include_rel}")
                 continue
 
         # Editable installs: -e <spec> / --editable <spec>
@@ -621,7 +621,7 @@ def _filter_requirements_file(
 
         name = _extract_req_name_from_spec(spec)
         if name and name in ignore_names:
-            out_lines.append(f"# odk-env: skipped (ignored package '{name}'): {raw}")
+            out_lines.append(f"# odt-env: skipped (ignored package '{name}'): {raw}")
             continue
 
         out_lines.append(raw)
@@ -641,7 +641,7 @@ def compile_all_requirements_lock(
 ) -> Path:
     """Compile a single lock file from multiple requirements sources using `uv pip compile`.
 
-    - Collects `base_requirements` (packages listed in INI + OPM defaults)
+    - Collects `base_requirements` (packages listed in INI + odt-env defaults)
     - Inlines and filters each requirements.txt (supports nested -r includes)
     - Applies `requirements_ignore` consistently before compilation
     - Writes:
@@ -678,13 +678,13 @@ def compile_all_requirements_lock(
         req_lines.append("")
 
     lines: list[str] = [
-        "# This file is generated by odk-env (DO NOT EDIT).",
-        "# Source: Odoo + addon repository requirements, plus [virtualenv].requirements and OPM defaults.",
+        "# This file is generated by odt-env (DO NOT EDIT).",
+        "# Source: Odoo + addon repository requirements, plus [virtualenv].requirements and odt-env defaults.",
         "",
     ]
 
     if base_requirements:
-        lines.append("# --- base requirements (from INI + OPM defaults) ---")
+        lines.append("# --- base requirements (from INI + odt-env defaults) ---")
         for spec in base_requirements:
             lines.append(spec)
         lines.append("")
@@ -2419,7 +2419,7 @@ def sync_project(
 # -----------------------------
 
 def build_parser() -> argparse.ArgumentParser:
-    epilog = """If no options are specified, odk-env only regenerates configs and helper scripts.
+    epilog = """If no options are specified, odt-env only regenerates configs and helper scripts.
 
 ROOT selection:
   By default, ROOT is the directory containing the INI.
@@ -2427,16 +2427,16 @@ ROOT selection:
   Use --dest-root to override the ROOT path embedded into generated configs/scripts (deployment root).
 
 Examples:
-  odk-env /path/to/odoo-project.ini --sync-all --create-venv
-  odk-env /path/to/odoo-project.ini --sync-all --create-wheelhouse
-  odk-env /path/to/odoo-project.ini --sync-all --create-venv --root /path/to/workspace-root
-  odk-env /path/to/odoo-project.ini --rebuild-venv --reuse-wheelhouse
-  odk-env /path/to/odoo-project.ini --rebuild-venv --reuse-wheelhouse --root /path/to/workspace-root
+  odt-env /path/to/odoo-project.ini --sync-all --create-venv
+  odt-env /path/to/odoo-project.ini --sync-all --create-wheelhouse
+  odt-env /path/to/odoo-project.ini --sync-all --create-venv --root /path/to/workspace-root
+  odt-env /path/to/odoo-project.ini --rebuild-venv --reuse-wheelhouse
+  odt-env /path/to/odoo-project.ini --rebuild-venv --reuse-wheelhouse --root /path/to/workspace-root
 """
 
     parser = argparse.ArgumentParser(
-        prog="odk-env",
-        description=f"odk-env {__version__}",
+        prog="odt-env",
+        description=f"odt-env {__version__}",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog=epilog,
     )
@@ -2444,7 +2444,7 @@ Examples:
     parser.add_argument(
         "--version",
         action="version",
-        version=f"odk-env {__version__}",
+        version=f"odt-env {__version__}",
         help="Show the program version and exit.",
     )
 
@@ -2493,7 +2493,7 @@ Examples:
         action="store_true",
         help=(
             "Enable virtualenv provisioning (create/update ROOT/venv + wheelhouse). "
-            "Without this flag, OPM will not touch venv/wheelhouse."
+            "Without this flag, odt-env will not touch venv/wheelhouse."
         ),
     )
     parser.add_argument(

{odoo_devops_tools-1.0.0.dist-info → odoo_devops_tools-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odoo-devops-tools
-Version: 1.0.0
+Version: 1.0.1
 Summary: A set of DevOps tools for Odoo deployments and local dev.
 Author: Roman Lacko
 License-Expression: MIT
@@ -38,7 +38,17 @@ Install with pip:
 pip install odoo-devops-tools
 ```
 
-## Command: `odk-env`
+Or install with uv:
+
+```bash
+uv tool install odoo-devops-tools
+```
+
+```bash
+odt-env --help
+```
+
+## Command: `odt-env`
 
 Provision and sync a reproducible Odoo workspace from an INI configuration file.
 
@@ -52,56 +62,56 @@ Provision and sync a reproducible Odoo workspace from an INI configuration file.
 Full **default** behavior (clone repositories, create venv, generate config and helper scripts):
 
 ```bash
-odk-env /path/to/ROOT/odoo-project.ini --sync-all --create-venv
+odt-env /path/to/ROOT/odoo-project.ini --sync-all --create-venv
 ```
 
 By default, `ROOT` is the directory containing the INI file. You can override where the workspace is created with `--root` (must point to an existing directory):
 
 ```bash
-odk-env /path/to/odoo-project.ini --sync-all --create-venv --root /path/to/NEW-ROOT
+odt-env /path/to/odoo-project.ini --sync-all --create-venv --root /path/to/NEW-ROOT
 ```
 
 If you want to **build** the workspace in one location but have the generated configs/scripts refer to a different **deployment root**, use `--dest-root`. This path does **not** need to exist on the build machine (it may only exist on the target host):
 
 ```bash
-odk-env /path/to/odoo-project.ini --sync-all --create-wheelhouse --root /tmp/build-root --dest-root /srv/odoo/myproject
+odt-env /path/to/odoo-project.ini --sync-all --create-wheelhouse --root /tmp/build-root --dest-root /srv/odoo/myproject
 ```
 
 Sync without venv provisioning:
 
 ```bash
-odk-env /path/to/ROOT/odoo-project.ini --sync-all
+odt-env /path/to/ROOT/odoo-project.ini --sync-all
 ```
 
 Build wheelhouse without venv provisioning:
 
 ```bash
-odk-env /path/to/ROOT/odoo-project.ini --sync-all --create-wheelhouse
+odt-env /path/to/ROOT/odoo-project.ini --sync-all --create-wheelhouse
 ```
 
 Offline venv provisioning from an existing wheelhouse:
 
 ```bash
-odk-env /path/to/ROOT/odoo-project.ini --create-venv --reuse-wheelhouse
+odt-env /path/to/ROOT/odoo-project.ini --create-venv --reuse-wheelhouse
 ```
 
 Hard rebuild of the venv:
 
 ```bash
-odk-env /path/to/ROOT/odoo-project.ini --sync-all --rebuild-venv
+odt-env /path/to/ROOT/odoo-project.ini --sync-all --rebuild-venv
 ```
 
-If no options are specified, odk-env only regenerates config and helper scripts:
+If no options are specified, odt-env only regenerates config and helper scripts:
 
 ```bash
-odk-env /path/to/ROOT/odoo-project.ini
+odt-env /path/to/ROOT/odoo-project.ini
 ```
 
-### What odk-env creates (directory layout)
+### What odt-env creates (directory layout)
 
 `ROOT` is the directory containing `odoo-project.ini` (or the path passed via `--root`).
 
-If you pass `--dest-root`, odk-env still creates files under `ROOT`, but **paths embedded inside generated files** are based on `DEST_ROOT`.
+If you pass `--dest-root`, odt-env still creates files under `ROOT`, but **paths embedded inside generated files** are based on `DEST_ROOT`.
 
 - `ROOT/odoo/` - Odoo repository
 - `ROOT/odoo-addons/<name>/` - addon repositories
@@ -124,7 +134,7 @@ This configuration creates a ready-to-run Odoo 18.0 development workspace, inclu
 ```ini
 [virtualenv]
 python_version = 3.11
-# Optional (default: true): when false, odk-env will NOT install a managed CPython via `uv python install`.
+# Optional (default: true): when false, odt-env will NOT install a managed CPython via `uv python install`.
 # Instead it will rely on an existing system Python that matches `python_version`.
 # managed_python = false
 build_constraints =
@@ -159,7 +169,7 @@ max_cron_threads = 0
 
 ### Using multiple configuration files with inheritance
 
-odk-env supports a lightweight include mechanism so you can split configuration across multiple INI files (for example a shared `base.ini` plus a local override file).
+odt-env supports a lightweight include mechanism so you can split configuration across multiple INI files (for example a shared `base.ini` plus a local override file).
 
 Notes:
 
@@ -220,9 +230,9 @@ db_name = sample_odoo18_test
 
 ### Configuration variables & interpolation
 
-odk-env uses Python's **ExtendedInterpolation**, so you can reference values via `${section:option}` (for example `${vars:branch}`).
+odt-env uses Python's **ExtendedInterpolation**, so you can reference values via `${section:option}` (for example `${vars:branch}`).
 
-In addition, odk-env injects a set of **runtime variables** (workspace paths) into the INI `DEFAULT` scope, so they are available from *any* section in the INI file:
+In addition, odt-env injects a set of **runtime variables** (workspace paths) into the INI `DEFAULT` scope, so they are available from *any* section in the INI file:
 
 - `${ini_dir}` - directory containing the INI file
 - `${root_dir}` - workspace root directory
@@ -236,7 +246,7 @@ In addition, odk-env injects a set of **runtime variables** (workspace paths) in
 
 **Note on `--dest-root`:**
 
-- odk-env always *builds* under `ROOT` (filesystem workspace).
+- odt-env always *builds* under `ROOT` (filesystem workspace).
 - When `--dest-root` is provided, values like `${root_dir}`, `${odoo_dir}`, `${addons_dir}` etc. are evaluated against `DEST_ROOT` **for the `[config]` section** (used to render generated files like `odoo-server.conf`).
 - Other sections (for example `[odoo]`, `[addons.*]`, `[virtualenv]`) continue to use the filesystem `ROOT` so build-time operations (git/venv/wheelhouse) are unaffected.
 - `${ini_dir}` always points to the directory containing the entry INI on the build machine (needed for includes).
@@ -271,7 +281,7 @@ logfile = ${root_dir}/odoo-logs/${vars:project}.log
 
 ### Extending `addons_path`
 
-odk-env always generates an `addons_path` for `odoo-server.conf` that includes:
+odt-env always generates an `addons_path` for `odoo-server.conf` that includes:
 
 - Odoo core addons directory (`ROOT/odoo/addons` and/or `ROOT/odoo/odoo/addons`)
 - every synced addon repository (`ROOT/odoo-addons/<name>`)
@@ -295,7 +305,7 @@ addons_path =
 
 ### Shallow clones (`shallow_clone`)
 
-By default, odk-env keeps repositories as **full clones** (all branches + tags + full history). For very large repositories (especially `odoo/odoo`) you can enable a **shallow, single-branch** workflow.
+By default, odt-env keeps repositories as **full clones** (all branches + tags + full history). For very large repositories (especially `odoo/odoo`) you can enable a **shallow, single-branch** workflow.
 
 Where to set it:
 
@@ -322,7 +332,7 @@ Limitations / gotchas:
 
 Switching back to a full clone:
 
-Set `shallow_clone = false` (or remove it) and re-run a sync. If the repo is shallow and/or single-branch, odk-env automatically converts it back to full history (unshallow) and widens the `origin` fetch refspec so a subsequent `fetch --all --tags` can pull all remote branches.
+Set `shallow_clone = false` (or remove it) and re-run a sync. If the repo is shallow and/or single-branch, odt-env automatically converts it back to full history (unshallow) and widens the `origin` fetch refspec so a subsequent `fetch --all --tags` can pull all remote branches.
 
 ### Command-line Options
 
@@ -335,23 +345,23 @@ Set `shallow_clone = false` (or remove it) and re-run a sync. If the repo is sha
 - `--rebuild-venv` - delete `ROOT/venv` and recreate it (implies `--create-venv`).
 - `--reuse-wheelhouse` - reuse an existing `ROOT/wheelhouse/` and install offline only (skip lock/wheel build). Requires `--create-venv`.
 - `--create-wheelhouse` - build/update the lock file + `ROOT/wheelhouse/` **without installing** project requirements into the venv.
-  (odk-env may create/update `ROOT/venv/` as a Python toolchain.)
+  (odt-env may create/update `ROOT/venv/` as a Python toolchain.)
 - `--clear-pip-wheel-cache` - remove all items from the pip's wheel cache.
 - `--no-configs` - don’t generate config files (e.g. `ROOT/odoo-configs/odoo-server.conf`).
 - `--no-scripts` - don’t generate helper scripts under `ROOT/odoo-scripts/`.
 - `--no-data-dir` - don’t create the Odoo data folder under `ROOT/odoo-data/` (or a custom path set via `[config] data_dir` in the INI file).
 
-If no options are specified, odk-env only regenerates configs and helper scripts.
+If no options are specified, odt-env only regenerates configs and helper scripts.
 
 ### Virtualenv
 
-odk-env installs project Python dependencies into the venv only when you pass `--create-venv` (or `--rebuild-venv`).
+odt-env installs project Python dependencies into the venv only when you pass `--create-venv` (or `--rebuild-venv`).
 You can (re)build the `ROOT/wheelhouse/` either as part of venv provisioning, or separately with `--create-wheelhouse`.
 
 - The venv is created/used at: `ROOT/venv`
 - Python version is taken from: `[virtualenv] python_version`
 - venv + installs are done via: `uv venv` and `uv pip`
-- If the requested Python version is not available on the machine and managed Python is enabled, odk-env installs it via `uv python install`.
+- If the requested Python version is not available on the machine and managed Python is enabled, odt-env installs it via `uv python install`.
 - Requirements are resolved into a single lock file and installed into the venv from `ROOT/wheelhouse/` using offline mode (`--offline --no-index`).
 
 #### Reusing an existing wheelhouse
@@ -359,7 +369,7 @@ You can (re)build the `ROOT/wheelhouse/` either as part of venv provisioning, or
 If `ROOT/wheelhouse/` is already prepared (wheels + `all-requirements.lock.txt`), you can run (requires `--create-venv`):
 
 ```bash
-odk-env /path/to/odoo-project.ini --create-venv --reuse-wheelhouse
+odt-env /path/to/odoo-project.ini --create-venv --reuse-wheelhouse
 ```
 
 This skips lock compilation and wheel building and does a strict offline install from the wheelhouse.
@@ -369,15 +379,15 @@ from the existing lock/wheels).
 
 ### Managed Python Install
 
-By default, odk-env manages the requested CPython version for you using `uv`.
+By default, odt-env manages the requested CPython version for you using `uv`.
 
 - Option: `[virtualenv] managed_python`
 - Default: `true` (you can omit it)
 
 Behavior:
 
-- `managed_python = true` (default): when odk-env needs to create `ROOT/venv/`, it ensures the requested `python_version` exists by running `uv python install`.
-- `managed_python = false`: odk-env **skips** `uv python install` and relies on an already-installed system Python that matches `python_version`. If such Python is not available, venv creation will fail.
+- `managed_python = true` (default): when odt-env needs to create `ROOT/venv/`, it ensures the requested `python_version` exists by running `uv python install`.
+- `managed_python = false`: odt-env **skips** `uv python install` and relies on an already-installed system Python that matches `python_version`. If such Python is not available, venv creation will fail.
 
 Example:
 
@@ -391,12 +401,12 @@ managed_python = false
 ### Safety / local changes policy
 
 If any target repository (Odoo or an addon) contains local uncommitted changes
-(including untracked files), odk-env aborts. Commit/stash/clean your working tree
-before running odk-env.
+(including untracked files), odt-env aborts. Commit/stash/clean your working tree
+before running odt-env.
 
 ### Generated scripts
 
-odk-env generates helper scripts into `ROOT/odoo-scripts/`. All scripts use the generated configuration file (`odoo-configs/odoo-server.conf`) and forward any additional arguments to the underlying command.
+odt-env generates helper scripts into `ROOT/odoo-scripts/`. All scripts use the generated configuration file (`odoo-configs/odoo-server.conf`) and forward any additional arguments to the underlying command.
 
 #### Linux/macOS
 

odoo_devops_tools-1.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+odoo_devops_tools/__init__.py,sha256=d4QHYmS_30j0hPN8NmNPnQ_Z0TphDRbu4MtQj9cT9e8,22
+odoo_devops_tools/env.py,sha256=-J8ldBCd6DD5_ner1D2vHmg8M-8-T4CXqTKulZToJBw,90431
+odoo_devops_tools-1.0.1.dist-info/licenses/LICENSE,sha256=3kVGxFPI-TSQGAKsrsm355Lo7Gzq015mqD2K0k3NmUQ,1068
+odoo_devops_tools-1.0.1.dist-info/METADATA,sha256=gWJ1Fi1vWqXPIw1tBiAwcM2hy1pQxvTUrp6BhRpaTcI,17617
+odoo_devops_tools-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+odoo_devops_tools-1.0.1.dist-info/entry_points.txt,sha256=A8yKJox6oeHmW6ymU6X27AEBnwrV_N6lKb3eqQ_5TeQ,55
+odoo_devops_tools-1.0.1.dist-info/top_level.txt,sha256=3qevYYwzrLMVylX0pxsrEqG7NIllKiMYbud3mzosKmg,18
+odoo_devops_tools-1.0.1.dist-info/RECORD,,

odoo_devops_tools-1.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+odt-env = odoo_devops_tools.env:main

odoo_devops_tools-1.0.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-odoo_devops_tools/__init__.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
-odoo_devops_tools/env.py,sha256=Z5vAssdoLSMvo7_MojotM_Ibv9Ul4sFsGOTL7wyCRhI,90415
-odoo_devops_tools-1.0.0.dist-info/licenses/LICENSE,sha256=3kVGxFPI-TSQGAKsrsm355Lo7Gzq015mqD2K0k3NmUQ,1068
-odoo_devops_tools-1.0.0.dist-info/METADATA,sha256=tk3NkzZLhO69dQoGTPm-DyVNF7JsjRi3k43RhiMPa2Q,17521
-odoo_devops_tools-1.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-odoo_devops_tools-1.0.0.dist-info/entry_points.txt,sha256=he_qPZDTHB3HbefjxaaRY7rDYaI9xSD0mUPnvSdM_4g,106
-odoo_devops_tools-1.0.0.dist-info/top_level.txt,sha256=3qevYYwzrLMVylX0pxsrEqG7NIllKiMYbud3mzosKmg,18
-odoo_devops_tools-1.0.0.dist-info/RECORD,,

odoo_devops_tools-1.0.0.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-odk-env = odoo_devops_tools.env:main
-odoo-devops-tools-env = odoo_devops_tools.env:main