You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Specifies if the module should be considered as a fully-fledged application (``True``) or is just a technical module (``False``) that provides some extra functionality to an existing application module.
79
+
80
+
.. _assets:
81
+
82
+
**assets**
83
+
84
+
.. container:: ps-3 pb-3
85
+
86
+
:badge-primary:`dict`
87
+
88
+
Specifies how all static files are loaded in various assets bundles.
89
+
90
+
See the :ref:`assets <reference/assets>` page for more details on how to describe bundles.
91
+
92
+
.. _author:
93
+
94
+
**author**
95
+
96
+
.. container:: ps-3 pb-3
97
+
98
+
:badge-primary:`dict`
99
+
100
+
Specifies the person or entity that authored the module.
101
+
102
+
If you are an employee at Odoo, it should be ``Odoo S.A.``.
103
+
104
+
105
+
.. _auto_install:
106
+
107
+
**auto_install**
108
+
109
+
.. container:: ps-3 pb-3
110
+
111
+
:badge-primary:`bool` :badge-primary:`list(str)`
112
+
113
+
If it is a ``bool``, it specifies if the module should be automatically installed once all of its dependencies are installed (``True``).
114
+
115
+
If it is a ``list(str)``, it must contain a subset of dependencies. It specifies if the module should be automatically installed once all the subset dependencies are installed and install the remaining dependencies.
116
+
117
+
::
118
+
119
+
# Once the module 'crm' is installed, this module will be automatically installed as well as
120
+
# the modules 'sale', and 'web'.
121
+
122
+
{
123
+
'depends': ['crm', 'sale', 'web'],
124
+
'auto_install': ['crm'],
125
+
}
126
+
127
+
128
+
If the list of subset of dependencies is empty, the module will always be installed regardless of its dependencies and those will be installed as well.
129
+
130
+
::
131
+
132
+
# This module will always be automatically installed as well as the modules 'crm', 'sale',
133
+
# and 'web'.
134
+
135
+
{
136
+
'depends': ['crm', 'sale', 'web'],
137
+
'auto_install': [],
138
+
}
139
+
140
+
This key is generally used for bridge modules implementing synergistic integration between two otherwise independent modules.
141
+
142
+
For example, ``sale_crm`` depends on both ``sale`` and ``crm`` and is set to ``auto_install``. When both ``sale`` and ``crm`` are installed, it will automatically add CRM campaigns tracking to sale orders without either ``sale`` or ``crm`` being aware of one another.
Specifies the classification category (business domain) within Odoo.
153
+
154
+
Although using existing categories is recommended, the field is freeform and unknown categories are created on-the-fly. Category hierarchies can be created using the separator ``/`` e.g. ``Foo/Bar`` will create a category ``Foo``, a category ``Bar`` as a child category of ``Foo``, and will set ``Bar`` as the module’s category.
155
+
156
+
.. _data:
157
+
158
+
**data**
159
+
160
+
.. container:: ps-3 pb-3
161
+
162
+
:badge-primary:`list(str)`
163
+
164
+
Specifies the list of data files that are only installed or updated with the module.
165
+
166
+
The paths must be specified from the module root directory.
167
+
168
+
.. _demo:
169
+
170
+
**demo**
171
+
172
+
.. container:: ps-3 pb-3
173
+
174
+
:badge-primary:`list(str)`
175
+
176
+
Specifies the list of data files that are only installed or updated in *demonstration mode*.
177
+
178
+
.. _depends:
179
+
180
+
**depends**
181
+
182
+
.. container:: ps-3 pb-3
183
+
184
+
:badge-primary:`list(str)`
185
+
186
+
Specifies the list of modules that will be installed (or loaded) before installing (or loading) this module.
187
+
188
+
A module depends on another if it uses features from it or alter its resources.
189
+
190
+
The module base is always installed in any Odoo instance but it still needs to be specified as a dependency to make sure the module is updated when base is.
191
+
192
+
.. _description:
193
+
194
+
**description**
195
+
196
+
.. container:: ps-3 pb-3
197
+
198
+
:badge-primary:`str`
199
+
200
+
Specifies the extended description of the module in *reStructuredText*.
201
+
202
+
.. _external_dependencies:
203
+
204
+
**external_dependencies**
205
+
206
+
.. container:: ps-3 pb-3
207
+
208
+
:badge-primary:`dict(key=list(str))`
209
+
210
+
Specifies a dictionary containing python and/or binary dependencies.
211
+
212
+
::
213
+
214
+
{
215
+
'external_dependencies': {
216
+
'python': [...],
217
+
'bin': [...]
218
+
},
219
+
}
220
+
221
+
For python dependencies, the ``python`` key must be defined for this dictionary and a list of python modules to be imported should be assigned to it.
222
+
223
+
For binary dependencies, the ``bin`` key must be defined for this dictionary and a list of binary executable names should be assigned to it.
224
+
225
+
The module won’t be installed if either the python module is not installed in the host machine or the binary executable is not found within the host machine’s PATH environment variable.
0 commit comments