Enhance Odoo to automatically discover available addons without the need of
For Odoo 8 and 9, it works by looking at addons in the
odoo_addons namespace package. For Odoo 10 and 11, it
works by looking for
odoo/addons directories in PYTHONPATH.
Addons that install this way can be packaged with the help of setuptools-odoo.
How to install
- Create a virtualenv and make sure you have a recent version of pip
pip install -U pipor using get-pip.py).
- Install Odoo in your virtualenv with the standard Odoo installation procedure
(a good way is to run
pip install -e .from the Odoo root directory).
- Make sure Odoo is installed correctly:
pip listmust show
- for Odoo 8 and 9, running
python -c "import openerp.api"and
- for Odoo 10 and 11, running
python -c "import odoo.api"and
- Install this package (
pip install odoo-autodiscover).
How to use
- Create and/or install odoo addons in the
odoo/addonsnamespace (for Odoo 10 and 11) or the
odoo_addonsnamespace (for Odoo 8 and 9), possibly with the help of the setuptools-odoo package.
- Run odoo as usual and notice the addons path is extended automatically.
The following commands install Odoo 8.0 nightly, then
base_import_async pulling all required dependencies
It uses pre-built wheel packages for OCA addons from pypi.
# create and activate a virtualenv virtualenv venv . ./venv/bin/activate # install Odoo 8.0 nightly pip install -r https://raw.githubusercontent.com/odoo/odoo/8.0/requirements.txt pip install https://nightly.odoo.com/8.0/nightly/src/odoo_8.0.latest.zip # install odoo-autodiscover pip install odoo-autodiscover # install base_import_async from pypi pip install odoo8-addon-base_import_async --pre # start odoo openerp-server
At this point, you should see in the Odoo log that the site-packages directory appears in the addons path.
You can easily install additional addons. For example, should you like to have an Odoo 8 shell, using the OCA shell module, simply pip install the module:
pip install odoo8-addon-shell openerp-server shell
To view addon packages that are installed in your virtualenv,
pip list | grep odoo<8|9|10>-addon- (note official addons
are part of the
With Odoo 8 and 9 it's not possible to make
openerp.addons a namespace package
openerp/__init__.py contains code), we use a pseudo-package named
odoo_addons for the sole purpose of discovering addons installed with
setuptools in that namespace.
odoo_addons is not intended to be imported
as the Odoo import hook will make sure all addons can be imported from
openerp.addons as usual.
With Odoo 10, we attempted to use pkg_resource style namespace packages.
It worked fine until setuptools 31, at which point we had to cope with
https://github.com/acsone/setuptools-odoo/issues/10. Hence the workaround
For Odoo 11 under Python 3, we hope we can make
again, this is the purpose of https://github.com/odoo/odoo/pull/19517.
See https://packaging.python.org/guides/packaging-namespace-packages/ for more information about namespace packages.
- pypi page: https://pypi.python.org/pypi/odoo-autodiscover
- code repository: https://github.com/acsone/odoo-autodiscover
- report issues at: https://github.com/acsone/odoo-autodiscover/issues
- see also setuptools-odoo: https://pypi.python.org/pypi/setuptools-odoo
- Stéphane Bidoul (ACSONE)
Many thanks to Daniel Reis who cleared the path, and Laurent Mignon who convinced me it was possible to do it using standard Python setup tools and had the idea of the odoo_addons namespace package.