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.1.0.tar.gz (50.7 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.1.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: odoo_dev-0.1.0.tar.gz
  • Upload date:
  • Size: 50.7 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.1.0.tar.gz
Algorithm Hash digest
SHA256 00d8d9d7cfad5515c646d4a5de0d98bb695dd374da76094a33c87a46a2950c5d
MD5 467ff8bacd27b1a136b71eb83a5fb615
BLAKE2b-256 0e4969e448eafb2d4be343fd5d07c6ace292563880ee5e6702914570831a9d89

See more details on using hashes here.

File details

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

File metadata

  • Download URL: odoo_dev-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.4 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5aa3014c107661b186aa5fda22f02f608a7f0cbae33d2c798bd4d6b952e3cb45
MD5 d7eed2057656d0d152695fe375893af2
BLAKE2b-256 cfa838a18cc918bee7cc9b2922402c70dff4191e6d2809777fa30420769440a0

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