setuptools-odoo

License: LGPL-3 https://badge.fury.io/py/setuptools-odoo.svg pre-commit.ci status https://coveralls.io/repos/acsone/setuptools-odoo/badge.svg?branch=master&service=github

⚠️ This project is progressively being deprecated. Please consider using whool for packaging individual Odoo addons, and hatch-odoo to build complete projects that include Odoo addons. ⚠️

setuptools-odoo is a library to help packaging Odoo addons with setuptools. It mainly populates the usual setup.py keywords from the Odoo manifest files.

It enables the packaging and distribution of Odoo addons using standard python infrastructure (ie setuptools, pip, wheel, and pypi).

Contents

Requirements

The following prerequisites apply:

  • Odoo version 8, 9, 10, 11, 12, 13, 14, 15 and 16 are supported (see notes in the documentation for implementation differences).
  • To install addons packaged with this tool, any pip version that supports the wheel package format should work (ie pip >= 1.4).
  • For any advanced use such as installing from source, installing from git, packaging wheels etc, you need a recent version of pip (>= 9.0.1).
  • Finally, if you are using Odoo 8, 9 or 10, you need to install odoo-autodiscover (pip install odoo-autodiscover) to provide automatic extension of the addons path (and workaround a bug with setuptools > 31 and Odoo 10). odoo-autodiscover is not necessary for Odoo >= 11.

Packaging a single addon

To be packaged with this library, the addon source code must have the following structure (assuming the addon is named <addon_name>):

# Odoo >= 11
setup.py
odoo/
odoo/addons/
odoo/addons/<addon_name>/
odoo/addons/<addon_name>/__manifest__.py
odoo/addons/<addon_name>/...

# Odoo 10
setup.py
odoo/
odoo/__init__.py
odoo/addons/
odoo/addons/__init__.py
odoo/addons/<addon_name>/
odoo/addons/<addon_name>/__manifest__.py
odoo/addons/<addon_name>/...

# Odoo 8, 9
setup.py
odoo_addons/
odoo_addons/__init__.py
odoo_addons/<addon_name>/
odoo_addons/<addon_name>/__openerp__.py
odoo_addons/<addon_name>/...

where odoo/__init__.py, odoo/addons/__init__.py, and odoo_addons/__init__.py are standard python namespace package declaration __init__.py (note __init__.py is absent for Odoo >= 11):

__import__('pkg_resources').declare_namespace(__name__)

and where setup.py has the following content:

import setuptools

setuptools.setup(
    setup_requires=['setuptools-odoo'],
    odoo_addon=True,
)

The usual setup() keyword arguments are computed automatically from the Odoo manifest file (__manifest__.py or __openerp__.py) and contain:

  • name: the package name, odoo<series>-addon-<addon_name>
  • version: the version key from the manifest
  • description: the summary key from the manifest if it exists otherwise the name key from the manifest
  • long_description: the content of the README.rst file if it exists, otherwise the description key from the manifest
  • url: the website key from the manifest
  • license: the license key from the manifest
  • packages: autodetected packages
  • namespace_packages: ['odoo', 'odoo.addons'] (Odoo 10) or ['odoo_addons'] (Odoo 8, 9), absent for Odoo 11
  • zip_safe: False
  • include_package_data: True
  • install_requires: dependencies to Odoo, other addons (except official odoo community and enterprise addons, which are brought by the Odoo dependency) and python libraries.
  • python_requires

Then, the addon can be deployed and packaged with usual pip commands such as:

pip install odoo<8|9|10|11|12|13|14>-addon-<addon name>
pip install "git+https://github.com/OCA/<repo>#subdirectory=setup/<addon name>"
pip install "git+https://github.com/OCA/<repo>@<branch or reference>#subdirectory=setup/<addon name>"
pip install -e .
pip wheel .
python -m build

Note

Please make sure to use the latest pip version.

Note

When using Python 2 (Odoo 8, 9, 10), please install odoo-autodiscover>=2 so the addons-path is automatically populated with all places providing odoo addons installed with this method.

It is of course highly recommanded to run in a virtualenv.

Note

Odoo 8, 9 namespace.

Although the addons are packaged in the odoo_addons namespace, the code can still import them using import odoo.addons..... odoo_addons must never appear in the code, it is just a packaging peculiarity for Odoo 8 and 9 only, and does not require any change to the addons source code.

Packaging multiple addons

Addons that are intended to be reused or depended upon by other addons MUST be packaged individually. When preparing a project for a specific customer, it is common to prepare a collection of addons that are not intended to be depended upon by addons outside of the project. setuptools-odoo provides tools to help you do that.

To be packaged with this library, your project must be structured according to the following structure:

# Odoo >= 11
setup.py
odoo/
odoo/addons/
odoo/addons/<addon1_name>/
odoo/addons/<addon1_name>/__manifest__.py
odoo/addons/<addon1_name>/...
odoo/addons/<addon2_name>/
odoo/addons/<addon2_name>/__manifest__.py
odoo/addons/<addon2_name>/...

# Odoo 10
setup.py
odoo/
odoo/__init__.py
odoo/addons/
odoo/addons/__init__.py
odoo/addons/<addon1_name>/
odoo/addons/<addon1_name>/__manifest__.py
odoo/addons/<addon1_name>/...
odoo/addons/<addon2_name>/
odoo/addons/<addon2_name>/__manifest__.py
odoo/addons/<addon2_name>/...

# Odoo 8, 9
setup.py
odoo_addons/
odoo_addons/__init__.py
odoo_addons/<addon1_name>/
odoo_addons/<addon1_name>/__openerp__.py
odoo_addons/<addon1_name>/...
odoo_addons/<addon2_name>/
odoo_addons/<addon2_name>/__openerp__.py
odoo_addons/<addon2_name>/...

where setup.py has the following content:

import setuptools

setuptools.setup(
    name='<your project package name>',
    version='<your version>',
    # ...any other setup() keyword
    setup_requires=['setuptools-odoo'],
    odoo_addons=True,
)

The following setup() keyword arguments are computed automatically from the Odoo manifest files (__manifest__.py or __openerp__.py) and contain:

  • packages: autodetected packages
  • namespace_packages: ['odoo', 'odoo.addons'] (Odoo 10) or ['odoo_addons'] (Odoo 8, 9), absent for Python 3 (Odoo 11 and later)
  • zip_safe: False
  • include_package_data: True
  • install_requires: dependencies on Odoo, any depending addon not found in the addons directory, and external python dependencies.
  • python_requires

Installing Odoo CE and EE addons

setuptools-odoo has built-in knowledge of the addons that are part of the Odoo Community and Enterprise editions. Dependencies on these addons are condidered to be satisfied by the odoo distribution.

This means Odoo must be installed in your python environment.

As of Odoo 8 to 16, a good way to install Odoo is in a virtual environment. There are several possibilities, but the following bash commands should get you started:

$ python3 -m venv ./venv
$ source ./venv/bin/activate
(venv) $ python3 -m pip install --upgrade pip wheel
(venv) $ python3 -m pip install -r ./odoo/requirements.txt
(venv) $ python3 -m pip install -e ./odoo

After that, ./venv/bin/pip list will show odoo as part of the installed projects, and running ./venv/bin/odoo will start Odoo with a proper addons path.

If you need to add the Odoo Enterprise addons, you can make them visible to Odoo using the --addons-path Odoo option, or package them in a multi-addons project that you pip install, as explained above.

Controlling setuptools-odoo behaviour

It is possible to use a dictionary instead of True for the odoo_addon and odoo_addons keywords, in order to control their behaviour.

The following keys are supported:

  • depends_override, used to precisely control odoo addons dependencies. Its value must be a dictionary mapping addon names to a package requirement string.
  • external_dependencies_override, used to precisely control python external dependencies. Its value must be a dictionary with one python key, with value a dictionary mapping python external dependencies to a python package requirement specifier or list of specifiers.
  • odoo_version_override, used to specify which Odoo series to use (8.0, 9.0, 10.0, 11.0, …) in case an addon version does not start with the Odoo series number. Use this only as a last resort, if you have no way to correct the addon version in its manifest.
  • post_version_strategy_override, used to specify how the git commits are used to amend the version found in the manifest (see the Versioning section below).

For instance, if your module requires at least version 10.0.3.2.0 of the connector addon, as well as at least version 0.5.5 of py-Asterisk, your setup.py would look like this:

import setuptools

setuptools.setup(
    setup_requires=['setuptools-odoo'],
    odoo_addon={
        'depends_override': {
            'connector': 'odoo10-addon-connector>=10.0.3.2.0',
        },
        'external_dependencies_override': {
            'python': {
                'Asterisk': 'py-Asterisk>=0.5.5',
                'somepkg': [
                  'somepkg<3 ; python_version < "3"',
                  'somepkg>=3 ; python_version > "3"',
                ]
            },
        },
    },
)

setuptools-odoo-make-default helper script

Since reusable addons are generally not structured using the namespace package but instead collected in a directory with each subdirectory containing an addon, this package provides the setuptools-odoo-make-default script which creates a default setup.py for each addon according to the following structure:

# Odoo >= 11
setup/
setup/addon1/
setup/addon1/setup.py
setup/addon1/odoo/
setup/addon1/odoo/addons/
setup/addon1/odoo/addons/<addon1_name> -> ../../../../<addon1_name>
setup/addon2/setup.py
setup/addon1/odoo/
setup/addon2/odoo/addons/
setup/addon2/odoo/addons/<addon2_name> -> ../../../../<addon2_name>
<addon1_name>/
<addon1_name>/__manifest__.py
<addon1_name>/...
<addon2_name>/
<addon2_name>/__manifest__.py
<addon2_name>/...

# Odoo 10
setup/
setup/addon1/
setup/addon1/setup.py
setup/addon1/odoo/
setup/addon1/odoo/__init__.py
setup/addon1/odoo/addons/
setup/addon1/odoo/addons/__init__.py
setup/addon1/odoo/addons/<addon1_name> -> ../../../../<addon1_name>
setup/addon2/setup.py
setup/addon1/odoo/
setup/addon1/odoo/__init__.py
setup/addon2/odoo/addons/
setup/addon2/odoo/addons/__init__.py
setup/addon2/odoo/addons/<addon2_name> -> ../../../../<addon2_name>
<addon1_name>/
<addon1_name>/__manifest__.py
<addon1_name>/...
<addon2_name>/
<addon2_name>/__manifest__.py
<addon2_name>/...

# Odoo 8, 9
setup/
setup/addon1/
setup/addon1/setup.py
setup/addon1/odoo_addons/
setup/addon1/odoo_addons/__init__.py
setup/addon1/odoo_addons/<addon1_name> -> ../../../<addon1_name>
setup/addon2/setup.py
setup/addon2/odoo_addons/
setup/addon2/odoo_addons/__init__.py
setup/addon2/odoo_addons/<addon2_name> -> ../../../<addon2_name>
<addon1_name>/
<addon1_name>/__openerp__.py
<addon1_name>/...
<addon2_name>/
<addon2_name>/__openerp__.py
<addon2_name>/...

Available options:

usage: setuptools-odoo-make-default [-h] --addons-dir ADDONS_DIR [--force]
                                    [--odoo-version-override ODOO_VERSION_OVERRIDE]
                                    [--metapackage METAPACKAGE] [--clean]
                                    [--commit]

Generate default setup.py for all addons in an Odoo addons directory

optional arguments:
  -h, --help            show this help message and exit
  --addons-dir ADDONS_DIR, -d ADDONS_DIR
  --force, -f
  --odoo-version-override ODOO_VERSION_OVERRIDE
                        Force Odoo version for situations where some addons
                        versions do not start with the odoo version.
  --metapackage METAPACKAGE, -m METAPACKAGE
                        Create a metapackage using the given name. This
                        package depends on all installable addons in
                        ADDONS_DIR.
  --clean, -c           Clean the setup directory: remove setups of
                        uninstallable addons, remove files corresponding to
                        other Odoo versions, remove metapackage setup if there
                        are no installable addons.
  --commit              Git commit changes, if any.

setuptools-odoo-make-default is also available as a pre-commit hook. To use it, you can add such an entry in your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/acsone/setuptools-odoo
    rev: 2.5.2
    hooks:
      - id: setuptools-odoo-make-default

setuptools-odoo-get-requirements helper script

Since it is a common practice in the Odoo world to have a file named requirements.txt at the repository root, this script helps generating it from the external dependencies declared in addons manifests.:

usage: setuptools-odoo-get-requirements [-h] [--addons-dir ADDONS_DIR] [--output OUTPUT]

Print external python dependencies for all addons in an Odoo addons directory.
If dependencies overrides are declared in setup/{addon}/setup.py, they are
honored in the output.

optional arguments:
  -h, --help            show this help message and exit
  --addons-dir ADDONS_DIR, -d ADDONS_DIR
                        addons directory (default: .)
  --output OUTPUT, -o OUTPUT
                        output file (default: stdout)
  --header HEADER       output file header
  --include-addons      Include addons and odoo requirements in addition to
                        python external dependencies (default: false).

Versioning

By default, setuptools-odoo does its best to detect if an addon has changed compared to the version indicated in it’s manifest. To this end it explores the git log of the addon subtree.

If the last change to the addon corresponds to the version number in the manifest, it is used as is for the python package version. Otherwise a counter is incremented for each commit and the resulting version number includes that counter.

The default strategy depends on the Odoo series. It has the following form, N being the number of git commits since the version change.

  • Strategy .99.devN is the default for series 8 to 12 and yields [8|9|10|11|12].0.x.y.z.99.devN.
  • Strategy +1.devN is the default for series 13 and 14 and yields [13|14].0.x.y.z+1.devN.
  • Strategy .N is the default for series 15 and later, and adds a digit, typically yielding [series].0.x.y.z.N.
  • Strategy none is not used by default and disables the post versioning mechanism, yielding the version found in the manifest.

These schemes are compliant with the accepted python versioning scheme documented in PEP 440.

The default strategy can be overridden using the post_version_strategy_override keyword or the SETUPTOOLS_ODOO_POST_VERSION_STRATEGY_OVERRIDE environment variable. If set and not empty, the environment variable has priority over the setup.py keyword.

Note

For pip to install a developmental version, it must be invoked with the --pre option.

Public API

The setuptools_odoo package exposes a provisional public API.

Credits

Author:

Contributors

  • Benjamin Willig
  • Matteo Bilotta

Many thanks to Daniel Reis who cleared the path, and Laurent Mignon who convinced me it was possible to do it using standard Python packaging tools and had the idea of the odoo_addons namespace package.

Changes

3.2.0 (2023-09-20)

Features

  • Generate python metadata version 2.1 instead 2.2. We are compatible with 2.1, and while PyPI does not support 2.2 packages generated with such metadata can’t be uploaded to PyPI. (#112)
  • Update core addon lists. (#115)

Bugfixes

  • Open README.rst using utf-8 encoding to avoid decoding issues on platform where the default encoding is not utf-8. (#108)

3.1.12 (2023-03-29)

Features

  • Update core addon lists. (#107)

3.1.11 (2023-03-15)

Features

  • Update core addon lists. (#106)

3.1.10 (2022-12-28)

Features

  • Update core addon lists. (#105)

3.1.9 (2022-11-24)

Features

  • Update core addon lists. (#100)

3.1.8 (2022-11-01)

Features

  • Update core addon lists. (#97)

3.1.7 (2022-10-16)

Features

  • Update core addon lists. (#96)

3.1.6 (2022-10-02)

Features

  • Require python 3.10 for Odoo 16. (#93)
  • Update core addon lists. (#94)

3.1.5 (2022-09-21)

Features

  • Update Odoo base addons list.

3.1.4 (2022-09-14)

Features

  • Update Odoo base addons list.

3.1.3 (2022-09-01)

Bug fixes

  • Properly handle odoo_version_override in setuptools-odoo-makedefault metapackage generation. (#89)

Features

  • Update Odoo base addons list.

3.1.1 (2022-05-17)

Features

  • Better error message when the Odoo version cannot be detected. (#85)
  • Update Odoo base addons list.

3.1.0 (2022-05-06)

  • Support overriding external dependencies with a list of requirements, enabling more advanced use cases such as declaring environment markers. (#81 <https://github.com/acsone/setuptools-odoo/pull/81>)
  • Preliminary Odoo 16 support (#83)
  • Update Odoo base addons list.

3.0.7 (2022-02-26)

  • setuptools-odoo-get-requirements: fixed a regression when using --include-addons, where the addons of the local directory where reported as requirements. (#67)
  • Update Odoo base addons list.

3.0.6 (2022-01-11)

  • Update Odoo base addons list.

3.0.5 (2021-12-17)

  • Fix reading PKG-INFO metadata for Odoo >= 15. (#70)

3.0.4 (2021-12-04)

  • Update Odoo base addons list.

3.0.3 (2021-10-18)

  • Odoo 15 addons now require python >= 3.8 by default. (#65)

3.0.2 (2021-10-09)

  • setuptools-odoo-make-default now uses the new naming scheme for the metapackage name. (#64)

3.0.1 (2021-10-06)

  • Generate Metada-Version 2.2. Since metadata obtained from a sdist with PKG-INFO is directly read from the PKG-INFO, all metadata is static by definition.
  • Add a precomputed_metadata_path argument to get_addon_metadata.
  • Support Odoo 15, with new odoo-addon-{addon_name} package name structure. This leverages the new pip dependency resolver to correctly install the correct version, depending on the installed Odoo version. The default git postversion strategy for Odoo 15 addons is now .N, which means it adds a 6th digit to the version number with the number of commit since the last version bump in the addon manifest.
  • Add support for the new Odoo series trove classifers.
  • Update Odoo base addons list.

2.7.1 (2021-03-15)

  • setuptools-odoo-get-requirements --include-addons does not output local addons, as it is meant to list third party dependencies

2.7.0 (2021-03-13)

  • [ADD] add new .N git post version strategy that adds a 6th digit with the number of commit since the latest manifest version change
  • [ADD] implement the post_version_strategy_override keyword that was documented but not effective
  • [ADD] allow overriding the post version strategy using the SETUPTOOLS_ODOO_POST_VERSION_STRATEGY_OVERRIDE environment variable
  • [ADD] add --include-addons option to setuptools-odoo-get-requirements, to output addon packages and odoo in addition to python external dependencies
  • [UPD] update base addons lists

2.6.3 (2021-01-29)

  • [UPD] update base addons lists

2.6.2 (2021-01-13)

  • Fixed build system by opting-in to PEP 517

2.6.1 (unreleased)

  • [UPD] update base addons lists

2.6.0 (2020-10-21)

  • [ADD] Support for post version strategy override
  • [ADD] setuptools-odoo-get-requirements to extract the list of external python dependencies from addon manifests

2.5.10 (2020-09-29)

  • [UPD] update base addons lists
  • [ADD] Odoo 14 support

2.5.9 (2020-05-25)

  • [FIX] further avoid depending on broken setuptools_scm 4.0.0

2.5.8 (2020-05-25)

  • [FIX] avoid depending on broken setuptools_scm 4.0.0
  • [UPD] update base addons lists

2.5.7 (2020-05-07)

  • [UPD] update base addons lists

2.5.6 (2020-04-24)

  • [UPD] update base addons lists

2.5.5 (2020-03-06)

  • [UPD] update base addons lists

2.5.4 (2020-02-16)

  • [UPD] update base addons lists

2.5.3 (2020-01-16)

  • [IMP] update documentation for Odoo 12 and 13

2.5.2 (2020-01-16)

  • [UPD] update base addons lists
  • [ADD] pre-commit hook for setuptools-odoo-make-default

2.5.1 (2019-12-13)

  • [FIX] Better detection of git repo root
  • [UPD] update base addons lists

2.5.0 (2019-10-04)

  • [ADD] new git autoversioning strategy (increase last digit instead of appending .99), will be used for Odoo 13
  • [ADD] preliminary Odoo 13 support
  • [ADD] new provisional public API that returns Python Package Metada 2.1 for and Odoo addon

2.4.1 (2018-11-05)

  • [FIX] issue with make-default-setup metapackage generator now honors .setuptools-odoo-make-default-ignore

2.4.0 (2018-10-04)

  • [IMP] update base addons lists, including Odoo 12

2.3.0 (2018-05-13)

  • [FIX] remove tests from sdist (they work only within a proper git clone)
  • [IMP] support development_status manifest key to generate corresponding pypi classifers
  • [IMP] use pypa/setuptools_scm instead of the unmaintained setuptools-git as git file finder

2.2.1 (2018-05-08)

  • [FIX] issue with make-default-setup –commit in empty directory

2.2.0 (2018-04-30)

  • [IMP] silence some useless git warnings when looking for manifst in git history
  • [IMP] when searching for manifest, look for __manifest__.py before __openerp__.py, this should slightly improve performance for what is becoming the most common case in recent Odoo versions
  • [IMP] update base addons list for Odoo 8, 9, 10
  • [IMP] load base addons list from resource files, making it easier to maintain these lists (using the udpated mk_base_addons script)
  • [IMP] add OpenSSL and suds in external dependencies map

2.1.0 (2018-04-22)

  • [FIX] give precedence to PKG-INFO over manifest to get version, so the git post version obtained when generating an sdist is preserved (before it would fall back in the manifest version when trying to build from an sdist outside of git)
  • [IMP] update base addons list for Odoo 11.0

2.0.4 (2018-04-18)

  • [FIX] setuptools-odoo-make-default: make metapackage a universal wheel for Odoo 11

2.0.3 (2018-04-18)

  • [IMP] add –clean, –commit and –metapackage options to setuptools-odoo-make-default

2.0.2 (2017-10-07)

  • [IMP] update base addons list for Odoo 11 (CE and EE)

2.0.1 (2017-10-02)

  • [FIX] fix issue when odoo/addons has no __init__.py.

2.0.0 (2017-09-19)

  • [IMP] update base addons list for Odoo 10.0
  • [IMP] when setuptools extends a list-type keyword, prevent duplicate items
  • [IMP] make tests pass with python 3
  • [ADD] preliminary Odoo 11 support
  • [IMP] BREAKING: remove LEGACY_MODE support
  • [IMP] python_requires is now part of the generated keywords
  • [CHG] In the classifiers, use Python instead of Python :: 2.7 since we now have python_requires that is more precise

1.0.1 (2017-04-08)

  • [ADD] add license classifier for the licenses commonly used in OCA

1.0.0 (2017-04-07)

  • [ADD] support the brand new Framework :: Odoo classifier

1.0.0rc4 (2017-02-21)

  • [FIX] avoid setuptools-git version 1.2 as it is broken for our use case

1.0.0rc3 (2017-01-14)

  • [FIX] git based automatic postversioning was not working in situations where the manifest was renamed (eg when renaming __openerp__.py to __manifest__.py)
  • [IMP] support author email: since the Odoo manifest has no such concept this is currently just a special case when OCA is in the authors

1.0.0rc2 (2016-10-07)

  • [IMP] 10.0 addons now depend on the specific Odoo version again (>=10.0, <10.1dev)

1.0.0rc1 (2016-10-03)

  • [IMP] Odoo 10.0 support with addons in the odoo.addons namespace.
  • [IMP] update base addons list for Odoo 9.0 and 10.0rc1

1.0.0b7 (2016-09-22)

  • [IMP] add __manifest__.py support for Odoo 10, drop __odoo__.py support which has never been supported by Odoo.
  • [IMP] BREAKING: package names are now constructed along the following scheme: odoo{series}-addon-{addon_name} where series is 8, 9 or 10.

1.0.0b6 (2016-08-23)

  • [IMP] the odoo_addon and odoo_addons keyword now extend list keywords such as install_requires if they are present in setup.py (previously, it left them alone); this is useful to create a package that contains odoo addons in addition to other python packages
  • [IMP] allow None as value for depends_override to disable the addition of an addon present in __openerp__.py ‘depends’ key to setup.py ‘install_requires’
  • [IMP] check if Odoo version is supported also in presence of odoo_version_override
  • [ADD] preliminary OpenErp 7.0 support
  • [ADD] –odoo-version-override to setuptools-odoo-make-default to use when there is no practical way to normalize addons versions
  • [FIX] when using odoo_version_override, make sure the package version starts with the Odoo version, otherwise dependencies from other packages do not work
  • [UPD] refresh base addons list for odoo 9c with new modules added over the last months

1.0.0b5 (2016-05-03)

  • [FIX] fix bug of previous release that prevented the packaging of a single auto_install addon

1.0.0b4 (2016-04-06)

  • [UPD] pycrypto in external dependencies map
  • [ADD] setuptools-odoo-make-default now ignores addons listed in .setuptools-odoo-make-default-ignore; this is useful when some addons are manually included in another package (such as autoinstallable glue modules)
  • [ADD] setuptools-odoo-make-default now generates README and .setuptools-odoo-make-default-ignore files at the root of the setup directory
  • [IMP] the odoo_addon setup keyword now accepts several addons in the odoo_addons namespace, provided exactly one is installable and not auto installable. This is meant to package an addon together with one or more auto_installable glue modules.

1.0.0b3 (2016-02-10)

  • [ADD] mechanism to specify which Odoo version to use in dependencies (8.0, 9.0) in case some addons to be packaged have non-standard version numbers
  • [ADD] support for addons without version number in their manifest (unfortunately there are some in the wild…)

1.0.0b2 (2016-01-26)

  • [ADD] mechanism to override dependencies, to allow addon authors to require minimal versions of dependent odoo addons, and to control external python dependencies

1.0.0b1 (2015-12-29)

  • [FIX] fix postversioning when running outside git directory
  • [IMP] additional mappings for python external dependencies
  • [ADD] make_pkg_name public api to convert an addon name to a python package name
  • [ADD] make_pkg_requirement public api to obtain a valid package requirement for a given addon (same as make_pkg_name but includes requirement for the correct Odoo series)
  • [FIX] crash in case a previous commit had a bad __openerp__.py

Developer instructions

How to run tests

  • run tox (if not installed apt-get install tox)

How to build the documentation

Documentation is built automatically at http://setuptools-odoo.readthedocs.io/.

To build it locally:

  • pip install -e .
  • pip install sphinx
  • cd docs
  • make html

How to release

  • in the setuptools_odoo directory, run ../mk_base_addons`
  • update changelog in CHANGES.rst, by running towncrier --version <version>
  • python setup.py check –restructuredtext
  • commit everything
  • make sure tests pass!
  • create a release with a tag on GitHub, the CI will build and publish to PyPI

Uploading of tagged versions to pypi will be taken care of by travis.