Odoo - scaffolding?

Question

I read here that you can scaffold a module using a command, so you won't need to manually create some initial files. But such command does not work on master (on Odoo development branch):

./oe scaffold Academy ../my-modules

Because there is no such file called oe in openerp directory. Did this thing change in the newest version? How can I scaffold a module in Odoo?

Please tell me on which path you are writing this command. Because previously it was written on server directory but now oe file is available in the odoo directory so if you have downloaded from github.com/odoo/odoo then it will show you oe file in odoo itself. — Bazzinga..., Jun 24 '14 at 12:09
Yeah, I downloaded from there. And tried to run from odoo, but there is no such file called oe. How should I run from odoo directory? — Andrius, Jun 24 '14 at 12:27
Sorry to say but it is not yet updated in odoo/odoo, but if you want to just learn then you can use old openerp from here, Server:https://code.launchpad.net/~openerp/openobject-server/trunk Addons:https://code.launchpad.net/~openerp/openobject-addons/trunk Web:https://code.launchpad.net/~openerp/openerp-web/trunk — Bazzinga..., Jun 24 '14 at 13:05
Thanks for update. Well the point is I want to learn all new stuff that is in Odoo :). So I guess I'll need to manually create initial files or write some script myself. — Andrius, Jun 24 '14 at 13:12

score 31 · Accepted Answer · edited Apr 20 '18 at 07:50

Now odoo 10 or later version use odoo-bin insted of odoo.py

On the shell or terminal, change directory to your odoo folder. Maybe it's in /opt/odoo, or maybe it's in /home/odoo :
```
cd /opt/odoo
```
Create a new module using the odoo.py script:
```
./odoo.py scaffold my_new_module ./addons/
```

(where my_new_module is a name of your new module, and ./addons/ is the Odoo addons directory)

Edit the ./addons/my_new_module/__openerp__.py file.
```
nano ./addons/my_new_module/__openerp__.py
```
Change the name field to set a user friendly name of your module (for example "Andrius's New Module"). Change description and fields also. And add your needed modules, such as 'mail', to the to the list of module dependencies depends.
```
'depends': ['base', 'mail'],
```
Edit models.py
```
nano ./addons/my_new_module/models.py
```
Add code in your my_new_module/models.py file, for example:

from openerp import models, api

class FooterlessNotification(models.Model)
    _inherit = 'mail.notification'

    @api.model
    def get_signature_footer(self, user_id, res_model=None, res_id=None, context=None, user_signature=True):
        return ""

(As an example, this code will extend the 'mail.notification' model and replace its get_signature_footer method with one that returns an empty footer.)

Install your module via Odoo settings.

To find it there you may need to use the "Update Module List" option.

If you can't find the option "Update Module List" either, you may need to enable the "Technical Features" checkbox in your current user's settings.

To display Modules, not just the Applications, remove the tag "Applications" from the search box filter, by clicking the small "x" before the tag.

The filename `__openerp__.py` may be changed for Odoo CE v11+ It's should be: `__manifest__.py` — Ismail H Rana, Mar 11 '21 at 16:29

score 8 · Answer 2 · edited Mar 11 '21 at 01:17

8

You can use ./odoo-bin scaffold MODULE_NAME PATH_TO_STORE_YOUR_MODULE_OR_ADDONS

For example: ./odoo-bin scaffold module_name /odoo/odoo-server/custom_addons/

Here custom_addons is your directory in odoo-server/

cmd in Odoo10:

./odoo-bin scaffold <module_name> <destination path where you want to create>

edited Mar 11 '21 at 01:17

Ismail H Rana

352
1
9

answered Jul 08 '17 at 11:14

Madhur Gupta

104
1
8

Just needed Sudo – Floggedhorse Aug 23 '17 at 17:11

score 5 · Answer 3 · answered May 01 '15 at 15:32

5

Use odoo.py instead of oe:

./path/to/odoo/odoo.py scaffold my-module

answered May 01 '15 at 15:32

Daniel Reis

11,890
5
41
69

score 1 · Answer 4 · answered Mar 11 '16 at 08:35

From odoo documentation correct way to create a module is following:

odoo.py scaffold [name of module] [desired path of module]

Also I recommend you to use different addons path for your module and don't use odoo/addons, you can create a new directory where you want and then add this directory to odoo configuration or execute odoo with this addon from launch

odoo.py --addons-path=[full path to your dir]

score 1 · Answer 5 · answered Jun 01 '16 at 09:30

1

I have installed ODOO 9 in AWS in the directory /opt/odoo.

So first I change directory:

 cd /opt/odoo

then executed:

 odoo.py scaffold modulename ./addons/

gives the following error msg:

 odoo.py command not found

the correct command that works for me is:

 sudo python odoo.py scaffold modulename ./addons/

Hope this helps.

answered Jun 01 '16 at 09:30

Jaf Faizal

51
4

or ./odoo.py scaffold modulename ./addons/ – mocak Aug 15 '16 at 15:49

score 1 · Answer 6 · answered Nov 08 '16 at 03:56

1

./"path to odoo.py file"/odoo.py scaffold my-module ./"path for your new addon"/

replace qoutes with your path

answered Nov 08 '16 at 03:56

score 0 · Answer 7 · edited Aug 24 '14 at 22:22

0

Another version

\###### begin ########

import sys

from openerp.cli import scaffold

sf = scaffold.Scaffold()

sf.run (sys.argv[1:])

\####### end #########

Save the script at the top to your openerp folder. Then execute with:

$ python (your-script-name) --help

or:

$ python (the-script-name) --init Academy --dest my-modules --model academy --controller academy --web --theme

edited Aug 24 '14 at 22:22

JustinJDavies

2,552
2
28
50

answered Aug 24 '14 at 21:59

sombatsombat

11
3

JustinJDavies, thanks for editing. Please also remove the \ at the begining of the comments line. – sombatsombat Aug 25 '14 at 00:16

maharshi · Answer 8 · 2016-08-02T14:37:38.637

Did you install as source or package.

For source you need to do

./odoo.py scaffold [module_name] [where_to_put_it]

if from package you need to do

 odoo.py scaffold [module_name] [where_to_put_it]

[where_to_put_it] usually is your addons path, your addons path may vary according to your install method.

It is not necessary to create the module in the addons folder. But it is recommended to do so.You can add the new addons path by

odoo.py --addons-path=[where_to_put_it]

For Module structure reference and for building a module.

score 0 · Answer 9 · answered Sep 14 '16 at 22:15

0

In some cases, it is necessary to pass the Odoo python file to the Python application to execute.

python odoo.py scaffold modulename addons-path

answered Sep 14 '16 at 22:15

IronHorseCowboy

33
5

score 0 · Answer 10 · edited Nov 28 '17 at 03:40

0

Goto Terminal and enter the following command:

cd path/to/your/odoo-version/

./odoo-bin scaffold new_module /path/to/your/odoo-version/addons

Then goto /path/to/your/odoo-version/addons and refresh, you can see the "new_module" will be present.

edited Nov 28 '17 at 03:40

Alex Butenko

3,347
3
30
51

answered Jan 15 '17 at 09:00

Pravitha V

3,140
4
26
50

score 0 · Answer 11 · edited May 25 '17 at 02:57

0

I suggest you for the first step to Git clone odoo. Create a directory/folder and you Git clone odoo on your directory/folder. After that run, Python odoo.py scaffold addons test123. Put or module on directory/folder addons for make sure, odoo can be read your module.

edited May 25 '17 at 02:57

Idan

4,819
6
33
45

answered May 25 '17 at 02:34

Stefani Johnsson

175
1
4
13

score 0 · Answer 12 · answered Jul 25 '18 at 04:14

Ifyou are using odoo-10 or 11 then intead of using ./oe scaffold Academy ../my-modules use : ./odoo-bin scaffold new_module /path/to/your/odoo-version/addons

and if you are using odoo8 i.e. openerp8 then use odoo.py scaffold <module name> <where to put it>

but make sure you are on the correct location in the directory. Also find tutorial here in the link : https://www.odoo.com/documentation/8.0/howtos/backend.html

--Thanks

ABhay S

score 0 · Answer 13 · answered Oct 25 '18 at 14:54

0

Here is my answer

cd path/to/odoo/odoo-server/

then

./odoo-bin scaffold new_module_name /path/to/custom/addons

now check /path/to/custom/addons, you will see new module where you can start adding you things.

answered Oct 25 '18 at 14:54

Rajnish

1

score 0 · Answer 14 · answered Mar 03 '20 at 12:02

0

First Change the directory where your odoo source: /opt/odoo

Then write this command: ./odoo-bin scaffold my_module_name /path-where-to-create

Example: ./odoo-bin scaffold odoo_module /Desktop/Repository

answered Mar 03 '20 at 12:02

Divya Maheshwari

23
5

score 0 · Answer 15 · answered Nov 02 '20 at 17:16

My file structure :-

To use the scaffold, you have to cd to (Odoo) folder then use this command

python3 odoo-bin scaffold name_of_your_module path_of_your_module

if i want to create a module named test at odoo/addons

i would just use the command :-

python3 odoo-bin scaffold test odoo/addons

Note:-

I haven't included every folder in the file structure, it was just to give you an idea
(python3) here depends on your python version

score 0 · Answer 16 · answered Apr 18 '21 at 23:59

0

In Odoo v14 istalled on ubuntu 20.04 I use

odoo scaffold module_name /opt/extra-addons

answered Apr 18 '21 at 23:59

Nacho Cano

1

Please add necessary details with your answer. https://stackoverflow.com/help/how-to-ask – Muhammad Tariq Apr 19 '21 at 08:17

sombatsombat · Answer 17 · 2014-08-25T00:45:36.533

-2

May be this code would help. Save it as moe.py or whatever you wanted.

from openerp.cli import scaffold

sf = scaffold.Scaffold()

#sf.run(["--help"])

sf.run (["--init","Academy","--model","academy","--controller","academy","--web","--theme"])

I'm still new to Python programming. If someone could improve the way to send arguments to the run() function, that would be great.

edited Aug 25 '14 at 00:45

answered Aug 24 '14 at 21:37

sombatsombat

11
3

Could I have the reason for not being useful of this script? – sombatsombat Aug 25 '14 at 00:17
Just guessing... you posted this as an answer, but then you had to ask if it was correct or efficient. You probably should *not* have answered. Or, you probably should have vetted the code on [Code Review Stack Exchange](http://codereview.stackexchange.com/). Once you know the code is correct, then offer it as an answer here. – jww Aug 25 '14 at 00:20
I offered the best answer that I could (at that time) and it run correctly in my environment. I did not asking for the correction. So it should be an answer for someone asking or seeking for help (or may be just some hints). But yes, as I mentioned about my exerience of Python programming, this code is not efficient because the way I send arguments to the function. That's it. – sombatsombat Aug 25 '14 at 00:47
*"If someone could improve the way to send arguments to the run() function, that would be great"*. It sounds like to me the answer *is not* ready to be used. But again, I'm just speculating why you were down voted. It could have been because of the missing formatting, too (or some combination). – jww Aug 25 '14 at 00:50

Odoo - scaffolding?

17 Answers17

Now odoo 10 or later version use odoo-bin insted of odoo.py