Modules - Odoo 8.0

Файл манифеста

Файл манифеста служит для объявления пакета python в качестве модуля Odoo и для указания метаданных модуля.

It is a file called __openerp__.py and contains a single Python dictionary, where each key specifies module metadatum.

{
    'name': "A Module",
    'version': '1.0',
    'depends': ['base'],
    'author': "Author Name",
    'category': 'Category',
    'description': """
    Description text
    """,
    # data files always loaded at installation
    'data': [
        'mymodule_view.xml',
    ],
    # data files containing optionally loaded demonstration data
    'demo': [
        'demo_data.xml',
    ],
}

Доступные поля манифеста:

name (str, обязательный параметр)

удобочитаемое имя модуля

version (str)

версия модуля должна соответствовать правилам semantic versioning

description (str)

расширенное описание модуля, в формате reStructuredText

author (str)

имя автора модуля

website (str)

URL веб-сайта автора модуля

license (str, defaults: AGPL-3)
distribution license for the module
category (str, по умолчанию: Uncategorized)

категория классификации в Odoo, примерная область бизнеса применения модуля.

Рекомендуется использовать существующие категории. Если введена произвольная категория, которой не существует, она создастся «на лету». Иерархия категорий может быть создана с использованием разделителя /, например Foo / Bar создаст категорию Foo, категорию Bar в качестве дочерней категории Foo, и установит Bar, как категорию модуля.

depends (list(str))

Модули Odoo, которые должны быть предварительно установлены для работы данного модуля, или потому, что этот модуль использует их функции, или потому, что он изменяет ресурсы, которые они определяют.

Когда модуль установлен, все его зависимости устанавливаются перед ним. Аналогично, зависимости загружаются до загрузки модуля.

data (list(str))

Список файлов данных, которые необходимо всегда устанавливать или обновлять с помощью модуля. В списке пути начинаются от корневого каталога модуля.

demo (list(str))

Список файлов данных, которые устанавливаются или обновляются только в демонстрационном режиме.

auto_install (bool, по умолчанию: False)

Если значение True, этот модуль будет автоматически установлен, если все его зависимости установлены.

Данный параметр обычно используется для установки «связующих модулей», реализующих интеграцию между двумя независимыми друг от друга модулями.

Например, sale_crm зависит от sale и crm и имеет значение auto_install. Когда установлены как sale, так и crm, он автоматически добавляет к Sale Order отслеживание кампаний в CRM