Youca Setup for Odoo

Youca Setup for Odoo is a command-line tool that creates, configures and manages Odoo development environments backed by Docker and PostgreSQL. It turns a blank machine into a working Odoo project in one command.

Features

• youca-setup init — scaffold a full Odoo project (Compose file, odoo.conf, .env, addons directories); --odoo-version/--postgres-version pick the image majors (defaults: latest supported); --template reuses a custom template directory and a git repository is initialised by default
• youca-setup start / stop / restart — environment lifecycle via Docker Compose
• youca-setup status — running state, ports and health at a glance
• youca-setup logs — container logs without touching Docker directly
• youca-setup shell — interactive shell (/bin/bash or psql) inside a container
• youca-setup doctor — diagnose Docker, PostgreSQL, ports and configuration; --fix applies corrections
• youca-setup module create — scaffold Odoo addon modules with an optional base model
• youca-setup backup / restore — database + filestore + configuration archives
• youca-setup export / import — portable environment snapshots (config + .env + addons)
• youca-setup info / projects / remove — inspect, list or unregister known projects

Installation

Requires Python 3.10+ and Docker with Compose v2.

pip install youca-setup

Quick start

# Create a project (Odoo 18, PostgreSQL 16, a custom addons directory)
youca-setup init school --odoo-version 18 --postgres-version 16 --postgres docker --addons custom-addons

# Run the environment
cd school
youca-setup start        # http://localhost:8069

# Scaffold a module with a base model
youca-setup module create school_management --model student

# Check that everything is healthy
youca-setup doctor

Commands

Documentation

Full guides (user and developer) are available in docs/. Release notes are tracked in CHANGELOG.md.

Development

pip install -e ".[dev]"
pre-commit install
ruff check .
mypy src/youca_setup
pytest

License

Distributed under the MIT License.