ODEV

Automate common tasks relative to working with Odoo development databases.

About

Odev is a multi-purpose tool designed for making the life of Odoo developers and support analysts easier.

It provides wrapper scripts around common tasks, speeding up the whole process of working with databases and allowing shortcuts to otherwise lengthy commands.

Documentation

Full documentation for all commands and features is available in the Odev Wiki.

Requirements

Before you can run this tool, make sure the below requirements are set on your system:

• Python 3.10.12 or higher (3.12+ is recommended)
• Python's virtualenv module (this is not python3-venv)
• PostgreSQL as from Odoo's source install requirements
• Other Odoo dependencies

Make sure git is properly setup with SSH key authentication before using commands, as Odev will try to connect to the Odoo Community and Enterprise repositories to pull sources when required.

Installation

Clone the odev repository to your computer and navigate to the odev folder:

git clone https://github.com/odoo-odev/odev.git && cd odev

Run the install script:

./install.sh

Run odev setup to configure odev:

odev setup

That's it! You are ready to go, use odev from anywhere in your terminal to use it.

Odev will update itself automatically when new versions are available.

Contributing

Submit a pull request to merge your development to the main branch. After review and proper testing, your feature will be made available to all.

You have ideas to share but you don't want to dive in odev's source code? No worries, you can also create a new issue with the tags bug or enhancement to request a new feature.

Check the Contribution Guide for more details about the contribution process.