Odoo Management

class odoo_tools.api.management.ManagementApi(environment)

property config

connection_info(db_or_uri)

db(database)

Returns a DbApi instance.

Parameters:

database (str) – The database name

Returns:

The db api object to manage odoo with the

provided database name.

Return type:

DbApi

db_connect(db)

db_list(hostname=None, db_name=None, dbfilter=None, filter_missing=False, filter_version=False, filter_invalid=False, include_extra_dbs=False)

get_active_dbs(template=None)

get_db_version(dbname)

initialize_odoo()

Initialize the odoo environment.

This method will load entrypoints that can be declared in python packages or by explicitly creating them using the entrypoints utilities in odoo-tools.

The first entrypoint to be called is: odoo_tools.manage.before_config. This entrypoint is supposed to be used to prepare the odoo configuration by filling things like addons paths etc. Then the entrypoint odoo_tools.manage.initialize_odoo is called. This one is responsible for loading the rest of odoo, for example it would setup the AddonsHook to load odoo.addons modules. Or to initialize the odoo logger. Then the odoo_tools.manage.after_config would be called to load antyhing that you’d want after the odoo internal configuration is effectly loaded.

By default the entrypoints are undefined, this way you can adjust the way you want to have odoo loaded before starting http workers for example.

install_odoo(version, release=None, ref=None, repo='https://github.com/odoo/odoo.git', opts=None)

Install odoo in the current python environment.

Unfortunately, odoo doesn’t provide a standard way to setup odoo through pip using pypi repositories. As a result, many companies end up installing odoo in many different ways. Some ways are better than others, but most of those methods can’t be considered best practices.

Implementing odoo’s installation within this library is better in some ways as other methods available.

In short, it can currently install odoo from 2 types of sources.

Release Mode

The release it the release name used in Nightly builds of Odoo. It uses the format of the date of the build that you need.

Git Mode

The git mode will take a reference and a repository that needs to be fetched. The repository defaults to the odoo repository, but an alternative repository can be used if necessary.

Regardless of the mode, each mode can have their file cached in an alternate folder. So you can try to cache the fetch in a CI environment to speed up odoo installation. When odoo is installed, it will pre process the odoo environment to provide a consistant setup. By default, odoo will only install addons located in odoo/addons. But in the git repository, addons are located in /addons and /odoo/addons. If you want to install odoo with pip manually, you’d have to move all addons in the root to the odoo/addons folder. This library does that for you.

It’s also possible to strip language translations out of the source folder for odoo. Most people really don’t need to keep all translation files in their environment. It’s not a big issue, but it can make docker images drastically smaller when translations aren’t installed with odoo.

This can save a non negligable amount of storage and time to upload large images.

Then the source code used to install odoo gets automatically cleaned up to save even more space as .git data aren’t necessary in a statically built environment. Ironically, installing odoo from scratch without cache can be a lot faster than loading the whole repository in a cache then doing incremental fetch to keep the source up to date.

native_packages(distrib_override=None)

property options

Returns and odoo configparser.

This method is a simple shortcut around the odoo config. In case odoo isn’t installed, it will simply raise an exception that can be handled instead of having to handle in your code to handle if odoo can be imported.

Raises:

SystemError – If odoo cannot be imported.

Returns:

the original odoo config object.

Return type:

configparser

packages()

It will lookup all the native packages that needs to be installed.

Any file matching the name apt-packages.txt will be merge together to form the list of packages that needs to be installed.

For example, if you have a module that requires git to be installed. You’d create a file with the following content:

git

Then when calling this method with properly configured addons_paths, it will automatically find this file merge it with other files and then you’ll be able to use the output of this method and call the package manager of your choice with this list of package to install.

Returns:

list of package name.

Return type:

list(str)