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

odoo_dev-0.3.3/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: odoo-dev
+Version: 0.3.3
+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` installs
+PostgreSQL but does **not** start it or create the role, so 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:**
+
+```bash
+sudo systemctl start postgresql
+sudo -u postgres createuser -s odoo
+```
+
+You can change the DB user/password in `conf/odoo.conf` if you prefer a different role.
+
+## 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
+```
+
+## 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.3/README.md

@@ -0,0 +1,169 @@
+# 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` installs
+PostgreSQL but does **not** start it or create the role, so 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:**
+
+```bash
+sudo systemctl start postgresql
+sudo -u postgres createuser -s odoo
+```
+
+You can change the DB user/password in `conf/odoo.conf` if you prefer a different role.
+
+## 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
+```
+
+## 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.3.3}/pyproject.toml

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

{odoo_dev-0.3.2 → odoo_dev-0.3.3}/src/odoo_dev/__init__.py

@@ -1,3 +1,3 @@
 """Odoo Development Environment Helper."""
 
-__version__ = "0.3.2"
+__version__ = "0.3.3"

odoo_dev-0.3.2/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.4
-Name: odoo-dev
-Version: 0.3.2
-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
-
-> **This repository has moved to GitHub: https://github.com/bemade/odoo-dev**
->
-> This GitLab repository is archived and no longer maintained.

odoo_dev-0.3.2/README.md

@@ -1,5 +0,0 @@
-# odoo-dev
-
-> **This repository has moved to GitHub: https://github.com/bemade/odoo-dev**
->
-> This GitLab repository is archived and no longer maintained.

odoo_dev-0.3.2/tests/fixtures/odoo-empty/.git

@@ -1 +0,0 @@
-gitdir: ../../../.git/modules/tests/fixtures/odoo-empty