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 — and keeps the day-to-day workflow (start, status, logs, shell, backup, export, …) in a single, consistent interface.

It is a thin orchestration layer over proven tools: you keep full control of your toolchain, while the repetitive setup is fully automated.

• Scaffold a complete project: docker-compose.yml, odoo.conf, .env, addons directories, git repository, validated youca-setup.yaml config.
• Manage the lifecycle with Docker Compose: start, stop, restart, status, logs.
• Develop: scaffold Odoo modules (module create), open interactive shells (shell), diagnose the environment (doctor).
• Protect data: timestamps backups and restores of database + filestore + configuration (backup / restore).
• Move around: portable environment snapshots (export / import) and multi-project management (projects, info, remove).

Features

• youca-setup init — full project scaffold with sensible defaults; pick the Odoo and PostgreSQL majors (--odoo-version, --postgres-version), the PostgreSQL backend (docker or system), extra addons directories (--addons), a custom Jinja2 template directory (--template) and git initialisation (on by default, --no-git). Interactive and fully scriptable (--no-interactive) modes.
• youca-setup start / stop / restart — environment lifecycle via Docker Compose, with automatic handling of an occupied HTTP port.
• youca-setup status — running state, ports and health at a glance (--verbose for details).
• youca-setup logs — container logs without touching Docker directly.
• youca-setup shell — interactive shell (/bin/bash) or database console (psql with credentials from .env) inside a container.
• youca-setup doctor — diagnose Python, Docker, PostgreSQL, ports and configuration; --fix applies corrections (destructive ones confirm).
• youca-setup module create — scaffold Odoo addon modules, optionally with a full model skeleton (--model).
• youca-setup backup / restore — database + filestore + configuration archives, restored with mandatory confirmation (--yes to force).
• youca-setup export / import — portable environment snapshots (config + .env + addons), sharing secrets with your team.
• youca-setup info / projects / remove — inspect, list or unregister known projects.

Requirements

• Python 3.10+
• Docker Engine with Docker Compose v2 (for the docker PostgreSQL backend)
• PostgreSQL 14+ (only for the system PostgreSQL backend)

Installation

pip install youca-setup

or with uv:

uv tool 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

The generated project looks like this:

school/
├── youca-setup.yaml          # validated project configuration
├── .env                 # local secrets (gitignored by default)
├── .gitignore
├── README.md
├── docker-compose.yml   # Odoo + PostgreSQL services
├── config/odoo.conf     # server configuration
├── addons/              # default addons mount
├── custom-addons/       # one directory per `--addons` entry
├── data/                # scratch data
└── backups/             # backup archives

Commands

Documentation

• Full documentation (user + developer guides)
• Release notes
• Issues and support

Development

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

The test suite is split into fast unit tests (mocked Docker and psycopg, no network) and integration tests (marked integration, require a running Docker daemon):

pytest -m "not integration"   # unit tests only
pytest -m integration         # real Docker

License

Distributed under the MIT License.