Skip to main content

Odoo Development Environment Helper

Project description

odoo-dev

A CLI tool for managing Odoo development environments. Handles local Python setup, Docker containers, database operations, and more.

Installation

# Install with uv (recommended)
uv tool install odoo-dev

# Or with pip
pip install odoo-dev

Quick Start

# In your Odoo project directory
cd my-odoo-project

# Full setup: clone Odoo repos, create venv, configure VSCode
odoo-dev setup

# Or for community edition only
odoo-dev setup --community

Commands

Local Development (default)

odoo-dev run                      # Start Odoo locally
odoo-dev run -d mydb --dev reload # With hot reload
odoo-dev run --debug              # With debugpy (VSCode attach)
odoo-dev shell mydb               # Open Odoo shell
odoo-dev update base -d mydb      # Update modules
odoo-dev test my_module           # Run tests with coverage
odoo-dev scaffold my_module       # Create new module

Database Operations

odoo-dev db list                  # List databases
odoo-dev db restore backup.zip    # Restore from backup
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)

odoo-dev docker start             # Start containers
odoo-dev docker stop              # Stop 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

odoo-dev setup                    # Full setup
odoo-dev setup --community        # Community edition only
odoo-dev setup-venv               # Just create venv
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:

ODOO_VERSION=18.0
PYTHON_VERSION=3.12

Requirements

  • Python 3.12+
  • uv (recommended) or pip
  • Git
  • PostgreSQL (for local development)
  • Docker (optional, for containerized development)

Development

# Clone and install for development
git clone git@git.bemade.org: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

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odoo_dev-0.2.0.tar.gz (51.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_dev-0.2.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file odoo_dev-0.2.0.tar.gz.

File metadata

  • Download URL: odoo_dev-0.2.0.tar.gz
  • Upload date:
  • Size: 51.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pop!_OS","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for odoo_dev-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1454e0223abf1b712b6d61c32d382ff7035bd538fef3e7a8055d1dec2c53a1f3
MD5 1cff72a38d730636321b577c20537fae
BLAKE2b-256 6d4137a4147f196f44dfd8276ac29f92887c5a8142b748a36f6410dc1d7a12ec

See more details on using hashes here.

File details

Details for the file odoo_dev-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: odoo_dev-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pop!_OS","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for odoo_dev-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5249120fece0cc009b860cc34af730dddbd97b84c1b38ec1dde57eb9d62cf207
MD5 56f4656822c65e80454a33fee28169b4
BLAKE2b-256 d89bfce98a2998e08cf8d5fd0d972185454b6c59a06fdff5e2c9379e70e18028

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page