How to create a module in Odoo

Create a new Odoo module

Odoo is a web-based, open-source, and modular business software platform.

It includes multiple integrated applications such as CRM, POS, E-Commerce, ERP, Manufacturing, Inventory Management, Accounting, and Project Management.

Introduction to the Odoo module

Describe the importance of the module in Odoo

Odoo module is a set of business logic that helps to enhance the existing functionality or add new functionality in Odoo.

Where to create a new module in Odoo?

Odoo is a modular framework, and all core modules are present within the Odoo Apps.

You can find the addons path inside the Odoo configuration file(If you are managing), and inside the configuration file, you can find the “addons_path”

Or you can use the below command to find the Odoo addons path,

-> ps  aux | grep odoo

Odoo Module Structure

• models – Python business logic and database models
• views – XML UI definitions (form, tree, kanban, menus, actions)
• data – Default data, sequences, cron jobs
• report – QWeb PDF reports and report actions
• demo – Demo/sample data (optional)
• security – Access rights and record rules
• static – Web assets (CSS, JS, images, XML templates)
• controllers – HTTP routes, website, and API logic
• wizard – Transient models (pop-ups)
• tests – Automated test cases
• manifest.py – Module metadata
• init.py – Python initialization

Now, for example, we are creating a module whose technical name is “‘webkul_elearning_module”

Required Files to Create a Basic Module

• __manifest__.py
• __init__.py

What is a Manifest file?

The __manifest__.py file defines the metadata of an Odoo module. It tells Odoo how the module should be loaded, its dependencies, and whether it should appear as an application in the Apps menu.

• Name (Module Name)
• Description (Contains the module’s long description)
• Depends (Contains the list of dependent modules)
• And there are many more.

So to make your module installable, you also need to define the “__init__.py” file.

What is an __init__.py file?

__init__.py is a Python package initialization file. It is used to import Python files and submodules so that Odoo can recognize and load them when required.

These two files are enough to make modules installable in Odoo.

Steps to create/install the module at Odoo

• Create a folder, then set the technical name for the module.
  • Make sure the module technical name does not contain any spaces, e.g., “webkul_elearning_module”.
• Then create an “__init__.py” file inside the folder,
  • You can define Python packages/files inside this file.
• Then create a “__manifest__.py” file,
  • You can define the module name(If not defined, the name will be ‘Unnamed’) and some other metadata.
• Then restart your Odoo server.
• Now login to your Odoo.
• Then open developer mode in your Odoo from Odoo “settings”.
• Also, you can press CTRL + K and then type debug. After that, press enter on “activate debug mode”(It will support the latest versions of Odoo).

• Then go to the “Apps” menu.
• Inside the “Apps” menu, you will see a button “Update App List”.

• Click on that button.
• Then check the module using the module name.
• After that, you will find your module inside the app list.
• Then click on the “install” button to install your module at Odoo’s end.

So this is how you can create a new module in Odoo and install modules at Odoo’s end.

You can also check some other informative blogs

We Would Love to Hear From You!

Hope you find the blog informative! Please feel free to share your feedback in the comments below.

Also, check webkul store page to go through our Odoo apps. As an Odoo Partner, we also provide odoo customization services, You may Hire Odoo Developers for odoo ERP development services.

If you still have any issues/queries, then please raise a ticket at https://webkul.uvdesk.com/en/customer/create-ticket/

For any doubt, contact us at [email protected].

Thanks for paying attention!!

🙂 😊