odoo-dev 0.3.2__tar.gz → 0.4.0__tar.gz

odoo_dev-0.4.0/.github/workflows/release-please.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  push:
+    branches: [master]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      # Maintains a release PR from Conventional Commits; when that PR is merged
+      # it creates the git tag + GitHub release and sets release_created=true.
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # release-please-config.json and .release-please-manifest.json are
+          # read from the repo root by default.
+
+  publish:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created == 'true' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write   # OIDC: mint a short-lived token for PyPI Trusted Publishing
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist + wheel
+        run: uv build
+      - name: Publish to PyPI (Trusted Publishing / OIDC)
+        run: uv publish --trusted-publishing always

odoo_dev-0.4.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.4.0"
+}

odoo_dev-0.4.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.4.0](https://github.com/bemade/odoo-dev/compare/v0.3.3...v0.4.0) (2026-06-11)
+
+
+### Features
+
+* configurable DB connection + connectivity preflight ([#3](https://github.com/bemade/odoo-dev/issues/3)) ([632738e](https://github.com/bemade/odoo-dev/commit/632738e37c1d22d79ec4a03cba72a28ca580f7c8))

odoo_dev-0.4.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: odoo-dev
+Version: 0.4.0
+Summary: Odoo Development Environment Helper
+Project-URL: Homepage, https://git.bemade.org/bemade/odoo-dev
+Project-URL: Repository, https://git.bemade.org/bemade/odoo-dev
+Project-URL: Issues, https://git.bemade.org/bemade/odoo-dev/-/issues
+License-Expression: LGPL-3.0
+Requires-Python: >=3.12
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# odoo-dev
+
+A CLI tool for managing Odoo development environments. Handles local Python setup, Docker containers, database operations, and more.
+
+It is the successor to the older `odoo-deploy` shell scripts — if you have notes for `odoo-deploy`, the rough mapping is: `odoo-dev docker start/stop/build` replaces the old `odoo-dev.sh start/stop/build`, and `odoo-dev run`/`test`/`shell` give you a local (venv-based) workflow that `odoo-deploy` didn't.
+
+## Installation
+
+```bash
+# Install with uv (recommended) — installs the published package from PyPI
+uv tool install odoo-dev
+
+# Or with pip
+pip install odoo-dev
+```
+
+Then make sure the install location is on your `PATH` (uv prints the path; usually `~/.local/bin`):
+
+```bash
+uv tool update-shell   # or: export PATH="$HOME/.local/bin:$PATH"
+```
+
+## Quick Start
+
+```bash
+# In your Odoo project directory
+cd my-odoo-project
+
+# Full setup: clone Odoo repos, create venv, install deps, configure VSCode
+odoo-dev setup
+
+# Or for community edition only
+odoo-dev setup --community
+```
+
+`setup` reads `ODOO_VERSION` / `PYTHON_VERSION` from a `.env` in the project root (or
+prompts for them and offers to save). It then clones the Odoo repos, builds a `.venv`,
+installs system dependencies, and generates `conf/odoo.conf`. It will offer to set up
+Docker at the end — answer "no" if you only want the local venv workflow.
+
+## Database setup (read this before your first `run`/`test`)
+
+The generated `conf/odoo.conf` connects as PostgreSQL user **`odoo`** over the local
+socket. You need a running PostgreSQL server and a matching role. `setup` never creates
+the role, and what it installs differs by OS — on **macOS** it installs the server (but
+does **not** start it); on **Linux** it installs only the PostgreSQL *client* (so you
+supply the server yourself). On a fresh machine do this once:
+
+**macOS (Homebrew):**
+
+```bash
+brew services start postgresql@18          # start the server (use your installed version)
+createuser -s odoo                         # create the role odoo.conf expects
+# Homebrew's versioned postgres is keg-only; add its bin to PATH if psql/createuser aren't found:
+#   export PATH="$(brew --prefix postgresql@18)/bin:$PATH"
+```
+
+**Debian/Ubuntu:** install a server if you don't already have one (or point
+`conf/odoo.conf` at an existing / remote / Docker PostgreSQL):
+
+```bash
+sudo apt-get install postgresql     # if you don't already have a server
+sudo systemctl start postgresql
+sudo -u postgres createuser -s odoo
+```
+
+**Using a different / remote / Docker PostgreSQL:** set `DB_HOST`, `DB_PORT`,
+`DB_USER`, `DB_PASSWORD` in `.env` before running `setup` (it writes them into
+`conf/odoo.conf`), or edit `conf/odoo.conf` directly. With no `DB_HOST`, odoo-dev
+connects over the local socket as the `odoo` role.
+
+Before launching, `run`/`test`/`shell`/`update` run a quick connection preflight: if
+the server is unreachable, the role is missing, or authentication fails, you get a
+specific one-line fix instead of a stack trace.
+
+## Commands
+
+### Local Development (default)
+
+```bash
+odoo-dev run                          # Start Odoo locally (default port 8069)
+odoo-dev run -d mydb -p 8070          # Pick a database and HTTP port
+odoo-dev run -d mydb -i base          # Initialize module(s) on start
+odoo-dev run -d mydb --dev reload     # With hot reload
+odoo-dev run --debug                  # With debugpy (VSCode attach on 5678)
+odoo-dev shell mydb                   # Open an Odoo shell
+odoo-dev update base -d mydb          # Update modules
+odoo-dev test my_module               # Run a module's tests (coverage on by default)
+odoo-dev test my_module --test-tags my_module --no-coverage
+odoo-dev test                         # Auto-discover & test all addons in addons/
+odoo-dev scaffold my_module           # Create a new module
+```
+
+> Note: the HTTP port flag is `-p` / `--port` (not `--http-port`).
+
+### Database Operations
+
+```bash
+odoo-dev db list                      # List databases
+odoo-dev db restore backup.zip        # Restore from backup (neutralized by default)
+odoo-dev db restore backup.zip mydb --no-neutralize
+odoo-dev db drop mydb                  # Drop database
+odoo-dev db neutralize mydb            # Disable emails/crons
+```
+
+### Docker (optional)
+
+```bash
+odoo-dev docker start                 # Start containers
+odoo-dev docker stop                  # Stop containers
+odoo-dev docker restart               # Restart containers
+odoo-dev docker logs                  # View logs
+odoo-dev docker build                 # Rebuild image
+odoo-dev docker shell mydb            # Shell in container
+odoo-dev docker psql                  # PostgreSQL shell
+```
+
+### Setup Commands
+
+```bash
+odoo-dev setup                        # Full setup
+odoo-dev setup --community            # Community edition only
+odoo-dev setup-venv                   # Just create the venv (no repo clone)
+odoo-dev vscode                       # Configure VSCode debugging
+```
+
+## Project Structure
+
+odoo-dev expects this project structure:
+
+```
+my-odoo-project/
+├── .env                 # Optional: ODOO_VERSION, PYTHON_VERSION
+├── addons/              # Your custom addons
+├── requirements.txt     # Project-specific Python deps
+├── odoo/                # Cloned by setup
+├── enterprise/          # Cloned by setup (unless --community)
+├── design-themes/       # Cloned by setup
+├── .venv/               # Created by setup
+└── conf/
+    └── odoo.conf        # Created by setup
+```
+
+## Configuration
+
+Create a `.env` file in your project root:
+
+```bash
+ODOO_VERSION=19.0
+PYTHON_VERSION=3.12
+
+# Optional — DB connection, written into conf/odoo.conf by `setup`.
+# Omit DB_HOST/DB_PORT to use the local socket (the default). Set these to
+# point at a remote / Docker / non-default PostgreSQL:
+# DB_HOST=localhost
+# DB_PORT=5432
+# DB_USER=odoo
+# DB_PASSWORD=odoo
+```
+
+## Requirements
+
+- Python 3.12+
+- uv (recommended) or pip
+- Git
+- PostgreSQL (for local development — server + an `odoo` role; see "Database setup")
+- Docker (optional, for containerized development)
+
+## Development
+
+```bash
+# Clone and install for development
+git clone git@github.com:bemade/odoo-dev.git
+cd odoo-dev
+uv sync
+
+# Run tests
+uv run pytest                 # All tests
+uv run pytest -m "not slow"   # Fast tests only
+
+# Build
+uv build
+```
+
+## License
+
+LGPL-3. For complete license terms, visit https://www.gnu.org/licenses/lgpl-3.0.en.html

odoo_dev-0.4.0/README.md

@@ -0,0 +1,187 @@
+# odoo-dev
+
+A CLI tool for managing Odoo development environments. Handles local Python setup, Docker containers, database operations, and more.
+
+It is the successor to the older `odoo-deploy` shell scripts — if you have notes for `odoo-deploy`, the rough mapping is: `odoo-dev docker start/stop/build` replaces the old `odoo-dev.sh start/stop/build`, and `odoo-dev run`/`test`/`shell` give you a local (venv-based) workflow that `odoo-deploy` didn't.
+
+## Installation
+
+```bash
+# Install with uv (recommended) — installs the published package from PyPI
+uv tool install odoo-dev
+
+# Or with pip
+pip install odoo-dev
+```
+
+Then make sure the install location is on your `PATH` (uv prints the path; usually `~/.local/bin`):
+
+```bash
+uv tool update-shell   # or: export PATH="$HOME/.local/bin:$PATH"
+```
+
+## Quick Start
+
+```bash
+# In your Odoo project directory
+cd my-odoo-project
+
+# Full setup: clone Odoo repos, create venv, install deps, configure VSCode
+odoo-dev setup
+
+# Or for community edition only
+odoo-dev setup --community
+```
+
+`setup` reads `ODOO_VERSION` / `PYTHON_VERSION` from a `.env` in the project root (or
+prompts for them and offers to save). It then clones the Odoo repos, builds a `.venv`,
+installs system dependencies, and generates `conf/odoo.conf`. It will offer to set up
+Docker at the end — answer "no" if you only want the local venv workflow.
+
+## Database setup (read this before your first `run`/`test`)
+
+The generated `conf/odoo.conf` connects as PostgreSQL user **`odoo`** over the local
+socket. You need a running PostgreSQL server and a matching role. `setup` never creates
+the role, and what it installs differs by OS — on **macOS** it installs the server (but
+does **not** start it); on **Linux** it installs only the PostgreSQL *client* (so you
+supply the server yourself). On a fresh machine do this once:
+
+**macOS (Homebrew):**
+
+```bash
+brew services start postgresql@18          # start the server (use your installed version)
+createuser -s odoo                         # create the role odoo.conf expects
+# Homebrew's versioned postgres is keg-only; add its bin to PATH if psql/createuser aren't found:
+#   export PATH="$(brew --prefix postgresql@18)/bin:$PATH"
+```
+
+**Debian/Ubuntu:** install a server if you don't already have one (or point
+`conf/odoo.conf` at an existing / remote / Docker PostgreSQL):
+
+```bash
+sudo apt-get install postgresql     # if you don't already have a server
+sudo systemctl start postgresql
+sudo -u postgres createuser -s odoo
+```
+
+**Using a different / remote / Docker PostgreSQL:** set `DB_HOST`, `DB_PORT`,
+`DB_USER`, `DB_PASSWORD` in `.env` before running `setup` (it writes them into
+`conf/odoo.conf`), or edit `conf/odoo.conf` directly. With no `DB_HOST`, odoo-dev
+connects over the local socket as the `odoo` role.
+
+Before launching, `run`/`test`/`shell`/`update` run a quick connection preflight: if
+the server is unreachable, the role is missing, or authentication fails, you get a
+specific one-line fix instead of a stack trace.
+
+## Commands
+
+### Local Development (default)
+
+```bash
+odoo-dev run                          # Start Odoo locally (default port 8069)
+odoo-dev run -d mydb -p 8070          # Pick a database and HTTP port
+odoo-dev run -d mydb -i base          # Initialize module(s) on start
+odoo-dev run -d mydb --dev reload     # With hot reload
+odoo-dev run --debug                  # With debugpy (VSCode attach on 5678)
+odoo-dev shell mydb                   # Open an Odoo shell
+odoo-dev update base -d mydb          # Update modules
+odoo-dev test my_module               # Run a module's tests (coverage on by default)
+odoo-dev test my_module --test-tags my_module --no-coverage
+odoo-dev test                         # Auto-discover & test all addons in addons/
+odoo-dev scaffold my_module           # Create a new module
+```
+
+> Note: the HTTP port flag is `-p` / `--port` (not `--http-port`).
+
+### Database Operations
+
+```bash
+odoo-dev db list                      # List databases
+odoo-dev db restore backup.zip        # Restore from backup (neutralized by default)
+odoo-dev db restore backup.zip mydb --no-neutralize
+odoo-dev db drop mydb                  # Drop database
+odoo-dev db neutralize mydb            # Disable emails/crons
+```
+
+### Docker (optional)
+
+```bash
+odoo-dev docker start                 # Start containers
+odoo-dev docker stop                  # Stop containers
+odoo-dev docker restart               # Restart containers
+odoo-dev docker logs                  # View logs
+odoo-dev docker build                 # Rebuild image
+odoo-dev docker shell mydb            # Shell in container
+odoo-dev docker psql                  # PostgreSQL shell
+```
+
+### Setup Commands
+
+```bash
+odoo-dev setup                        # Full setup
+odoo-dev setup --community            # Community edition only
+odoo-dev setup-venv                   # Just create the venv (no repo clone)
+odoo-dev vscode                       # Configure VSCode debugging
+```
+
+## Project Structure
+
+odoo-dev expects this project structure:
+
+```
+my-odoo-project/
+├── .env                 # Optional: ODOO_VERSION, PYTHON_VERSION
+├── addons/              # Your custom addons
+├── requirements.txt     # Project-specific Python deps
+├── odoo/                # Cloned by setup
+├── enterprise/          # Cloned by setup (unless --community)
+├── design-themes/       # Cloned by setup
+├── .venv/               # Created by setup
+└── conf/
+    └── odoo.conf        # Created by setup
+```
+
+## Configuration
+
+Create a `.env` file in your project root:
+
+```bash
+ODOO_VERSION=19.0
+PYTHON_VERSION=3.12
+
+# Optional — DB connection, written into conf/odoo.conf by `setup`.
+# Omit DB_HOST/DB_PORT to use the local socket (the default). Set these to
+# point at a remote / Docker / non-default PostgreSQL:
+# DB_HOST=localhost
+# DB_PORT=5432
+# DB_USER=odoo
+# DB_PASSWORD=odoo
+```
+
+## Requirements
+
+- Python 3.12+
+- uv (recommended) or pip
+- Git
+- PostgreSQL (for local development — server + an `odoo` role; see "Database setup")
+- Docker (optional, for containerized development)
+
+## Development
+
+```bash
+# Clone and install for development
+git clone git@github.com:bemade/odoo-dev.git
+cd odoo-dev
+uv sync
+
+# Run tests
+uv run pytest                 # All tests
+uv run pytest -m "not slow"   # Fast tests only
+
+# Build
+uv build
+```
+
+## License
+
+LGPL-3. For complete license terms, visit https://www.gnu.org/licenses/lgpl-3.0.en.html

{odoo_dev-0.3.2 → odoo_dev-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "odoo-dev"
-version = "0.3.2"
+version = "0.4.0"
 description = "Odoo Development Environment Helper"
 readme = "README.md"
 requires-python = ">=3.12"

odoo_dev-0.4.0/release-please-config.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "packages": {
+    ".": {
+      "release-type": "python",
+      "package-name": "odoo-dev",
+      "changelog-path": "CHANGELOG.md",
+      "include-component-in-tag": false,
+      "extra-files": ["src/odoo_dev/__init__.py"]
+    }
+  }
+}

odoo_dev-0.4.0/src/odoo_dev/__init__.py

@@ -0,0 +1,3 @@
+"""Odoo Development Environment Helper."""
+
+__version__ = "0.4.0"  # x-release-please-version

{odoo_dev-0.3.2 → odoo_dev-0.4.0}/src/odoo_dev/commands/run.py

@@ -10,6 +10,7 @@ from typing import Annotated
 import typer
 
 from odoo_dev.config import load_config
+from odoo_dev.preflight import require_db
 from odoo_dev.utils.console import error, info, success, warning
 
 
@@ -53,6 +54,8 @@ def run(
         error("Run 'odoo-dev setup' first to clone Odoo repositories.")
         raise typer.Exit(1)
 
+    require_db(cfg)
+
     venv_python = cfg.venv_path / "bin" / "python"
 
     # Build command
@@ -114,6 +117,8 @@ def shell(
         error("Run 'odoo-dev setup' first.")
         raise typer.Exit(1)
 
+    require_db(cfg)
+
     venv_python = cfg.venv_path / "bin" / "python"
 
     success(f"Opening Odoo shell with database {db_name}...")
@@ -148,6 +153,8 @@ def update(
         error("Run 'odoo-dev setup' first.")
         raise typer.Exit(1)
 
+    require_db(cfg)
+
     venv_python = cfg.venv_path / "bin" / "python"
 
     success(f"Updating modules: {modules} on database {db_name}...")
@@ -192,7 +199,8 @@ def test(
         bool, typer.Option("--coverage/--no-coverage", help="Enable coverage reporting")
     ] = True,
     keep_db: Annotated[
-        bool, typer.Option("--keep-db/--no-keep-db", help="Keep test database after tests")
+        bool,
+        typer.Option("--keep-db/--no-keep-db", help="Keep test database after tests"),
     ] = False,
     exclude: Annotated[
         str | None,
@@ -254,6 +262,8 @@ def test(
     if db_name is None:
         db_name = f"test_{int(time.time())}"
 
+    require_db(cfg)
+
     venv_python = cfg.venv_path / "bin" / "python"
 
     # Determine modules to test
@@ -291,7 +301,15 @@ def test(
                 if not clone_dir.exists():
                     branch = os.environ.get("ODOO_VERSION", cfg.odoo_version)
                     result = subprocess.run(
-                        ["git", "clone", "--depth=1", "-b", branch, repo_url, str(clone_dir)],
+                        [
+                            "git",
+                            "clone",
+                            "--depth=1",
+                            "-b",
+                            branch,
+                            repo_url,
+                            str(clone_dir),
+                        ],
                         capture_output=True,
                     )
                     if result.returncode != 0:
@@ -370,7 +388,9 @@ def test(
 
         if coverage:
             # Build coverage source paths
-            coverage_source = ",".join(str(cfg.addons_dir / m) for m in modules.split(","))
+            coverage_source = ",".join(
+                str(cfg.addons_dir / m) for m in modules.split(",")
+            )
 
             test_cmd = [
                 str(venv_python),
@@ -512,9 +532,12 @@ def _drop_database(cfg, db_name: str) -> None:
     result = subprocess.run(
         [
             "dropdb",
-            "-h", db_config["host"],
-            "-p", db_config["port"],
-            "-U", db_config["user"],
+            "-h",
+            db_config["host"],
+            "-p",
+            db_config["port"],
+            "-U",
+            db_config["user"],
             "--if-exists",
             db_name,
         ],
@@ -534,10 +557,14 @@ def _terminate_connections(db_name: str, db_config: dict[str, str]) -> None:
     subprocess.run(
         [
             "psql",
-            "-h", db_config["host"],
-            "-p", db_config["port"],
-            "-U", db_config["user"],
-            "-d", "postgres",
+            "-h",
+            db_config["host"],
+            "-p",
+            db_config["port"],
+            "-U",
+            db_config["user"],
+            "-d",
+            "postgres",
             "-c",
             f"SELECT pg_terminate_backend(pid) FROM pg_stat_activity "
             f"WHERE datname = '{db_name}' AND pid <> pg_backend_pid()",
@@ -547,6 +574,7 @@ def _terminate_connections(db_name: str, db_config: dict[str, str]) -> None:
         env=env,
     )
 
+
 def _get_addons_path(config_file) -> str:
     """Extract addons_path from odoo.conf."""
     for line in config_file.read_text().splitlines():

{odoo_dev-0.3.2 → odoo_dev-0.4.0}/src/odoo_dev/commands/setup.py

@@ -309,12 +309,28 @@ def _setup_odoo_config(cfg, community_only: bool = False) -> None:
     # Filter to only existing paths
     addons_paths = [p for p in addons_paths if Path(p).exists()]
 
-    config_content = f"""[options]
-addons_path = {",".join(addons_paths)}
-admin_passwd = admin
-db_user = odoo
-db_password = odoo
-"""
+    # DB connection is configurable via .env (loaded into the environment by
+    # load_config). Host/port are written only when set, so the default is the
+    # local socket — matching odoo-bin's behavior when db_host is absent.
+    db_user = os.getenv("DB_USER", "odoo")
+    db_password = os.getenv("DB_PASSWORD", "odoo")
+    db_host = os.getenv("DB_HOST", "")
+    db_port = os.getenv("DB_PORT", "")
+
+    db_lines = []
+    if db_host:
+        db_lines.append(f"db_host = {db_host}")
+    if db_port:
+        db_lines.append(f"db_port = {db_port}")
+    db_lines.append(f"db_user = {db_user}")
+    db_lines.append(f"db_password = {db_password}")
+
+    config_content = (
+        "[options]\n"
+        f"addons_path = {','.join(addons_paths)}\n"
+        "admin_passwd = admin\n"
+        f"{chr(10).join(db_lines)}\n"
+    )
 
     conf_file.write_text(config_content)
     conf_file.chmod(0o600)

{odoo_dev-0.3.2 → odoo_dev-0.4.0}/src/odoo_dev/config.py

@@ -9,6 +9,56 @@ DEFAULT_ODOO_VERSION = "19.0"
 DEFAULT_PYTHON_VERSION = "3.12"
 
 
+@dataclass
+class DbConfig:
+    """PostgreSQL connection settings, as odoo-bin will use them.
+
+    An empty ``host``/``port`` means "use the libpq defaults" (i.e. the local
+    Unix socket), which is exactly what odoo-bin does when ``db_host`` is absent
+    from odoo.conf. The preflight check must mirror that, so we keep them empty
+    rather than substituting ``localhost``/``5432`` (which would force TCP and
+    can spuriously fail on socket/peer-auth setups).
+    """
+
+    host: str = ""
+    port: str = ""
+    user: str = "odoo"
+    password: str = ""
+    name: str | None = None
+
+
+def read_db_config(config_file: Path) -> "DbConfig":
+    """Read DB connection settings from an odoo.conf file.
+
+    Args:
+        config_file: Path to odoo.conf. A missing file yields defaults.
+
+    Returns:
+        DbConfig reflecting the connection odoo-bin would make.
+    """
+    db = DbConfig()
+    if not config_file.exists():
+        return db
+
+    for line in config_file.read_text().splitlines():
+        line = line.strip()
+        if "=" not in line or line.startswith("#"):
+            continue
+        key, _, value = line.partition("=")
+        key, value = key.strip(), value.strip()
+        if key == "db_host":
+            db.host = value
+        elif key == "db_port":
+            db.port = value
+        elif key == "db_user":
+            db.user = value
+        elif key == "db_password":
+            db.password = value
+        elif key == "db_name":
+            db.name = value
+    return db
+
+
 @dataclass
 class ProjectConfig:
     """Configuration for an Odoo development project."""