Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Odoo Development Cookbook
  • Table Of Contents Toc
  • Feedback & Rating feedback
Odoo Development Cookbook

Odoo Development Cookbook

By : Daudi, Vora, Gajjar, Fayolle, Holger Brunn, Daniel Reis
4.2 (12)
Buy this Book
close
close
Odoo Development Cookbook

Odoo Development Cookbook

4.2 (12)
By: Daudi, Vora, Gajjar, Fayolle, Holger Brunn, Daniel Reis
Buy this Book

Overview of this book

The latest version of the powerful Odoo framework uncovers a wide variety of features for rapid application development. Written by seasoned Odoo experts, this updated Odoo Development Cookbook will help you explore Odoo 17’s new features and use them to develop applications from scratch. You'll learn about website development concepts and get to grips with the Odoo Web Library (OWL), as well as create a new Odoo module from the ground up before progressing to advanced framework concepts. The book also shows you how to modify existing applications, including Point of Sale (POS) applications. Going beyond backend development, you'll discover advanced JavaScript recipes for creating new views and widgets. You'll get a clear understanding of website development and be on your way to becoming a proficient Odoo developer by studying performance optimization, debugging, and automated testing. By the end of this book, you'll have the knowledge you need to build impressive applications and be well-versed in Odoo development best practices.
Table of Contents (28 chapters)
close
close
close
Preface
Preface
Who this book is for
What this book covers
To get the most out of this book
Download the example code files
Conventions used
Sections
Get in touch
Share your thoughts
Download a free PDF copy of this book
Free Chapter
1
Chapter 1: Installing the Odoo Development Environment
Chapter 1: Installing the Odoo Development Environment
Technical requirements
Understanding the Odoo ecosystem
Installing Odoo from the source
Managing Odoo server databases
Storing the instance configuration in a file
Activating Odoo developer tools
Updating the add-on modules list
2
Chapter 2: Managing Odoo Server Instances
Chapter 2: Managing Odoo Server Instances
Configuring the add-ons path
Standardizing your instance directory layout
Installing and upgrading local add-on modules
Installing add-on modules from GitHub
Applying changes to add-ons
Applying and trying proposed PRs
3
Chapter 3: Creating Odoo Add-On Modules
chevron up
Chapter 3: Creating Odoo Add-On Modules
Technical requirements
What is an Odoo add-on module?
Creating and installing a new add-on module
Completing the add-on module manifest
Organizing the add-on module file structure
Adding models
Adding access security
Adding menu items and views
Using the scaffold command to create a module
4
Chapter 4: Application Models
Chapter 4: Application Models
Technical requirements
Defining the model representation and order
Adding data fields to a model
Adding a float field with configurable precision
Adding a monetary field to a model
Adding relational fields to a model
Adding a hierarchy to a model
Adding constraints validations to a model
Adding computed fields to a model
Exposing related fields stored in other models
Adding dynamic relations using reference fields
Adding features to a model using inheritance
Copying the model definition using inheritance
Using delegation inheritance to copy features to another model
Using abstract models for reusable model features
5
Chapter 5: Basic Server-Side Development
Chapter 5: Basic Server-Side Development
Technical requirements
Specifying model methods and using API decorators
Reporting errors to the user
Obtaining an empty recordset for a different model
Creating new records
Updating values of recordset records
Searching for records
Combining recordsets
Filtering recordsets
Traversing recordset relations
Sorting recordsets
Extending the business logic defined in a model
Extending write() and create()
Customizing how records are searched
Fetching data in groups using read_group()
6
Chapter 6: Managing Module Data
Chapter 6: Managing Module Data
Technical requirements
Using external IDs and namespaces
Loading data using XML files
Using the noupdate and forcecreate flags
Loading data using CSV files
Add-on updates and data migration
Deleting records from XML files
Invoking functions from XML files
7
Chapter 7: Debugging Modules
Chapter 7: Debugging Modules
The auto-reload and --dev options
Producing server logs to help debug methods
Using the Odoo shell to interactively call methods
Using the Python debugger to trace method execution
Understanding the debug mode options
8
Chapter 8: Advanced Server-Side Development Techniques
Chapter 8: Advanced Server-Side Development Techniques
Technical requirements
Changing the user that performs an action
Calling a method with a modified context
Executing raw SQL queries
Writing a wizard to guide the user
Defining onchange methods
Calling onchange methods on the server side
Defining onchange with the compute method
Defining a model based on a SQL view
Adding custom Settings options
Implementing init hooks
9
Chapter 9: Backend Views
Chapter 9: Backend Views
Technical requirements
Adding a menu item and window actions
Having an action open a specific view
Adding content and widgets to a form view
Adding buttons to forms
Passing parameters to forms and actions – context
Defining filters on record lists – domain
Defining list views
Defining search views
Adding a search filter side panel
Changing existing views – view inheritance
Defining document-style forms
Dynamic form elements using attributes
Defining embedded views
Displaying attachments on the side of the form view
Defining kanban views
Showing kanban cards in columns according to their state
Defining calendar views
Defining graph view and pivot view
Defining the cohort view
Defining the gantt view
Defining the activity view
Defining the map view
10
Chapter 10: Security Access
Chapter 10: Security Access
Technical requirements
Creating security groups and assigning them to users
Adding security access to models
Limiting access to fields in models
Limiting record access using record rules
Activating features with security groups
Accessing recordsets as a superuser
Hiding view elements and menus based on groups
11
Chapter 11: Internationalization
Chapter 11: Internationalization
Setting up a language installation and user preference settings
Setting up options relating to language
Text translation using a web client user interface
Exporting translation strings to a file
Using gettext tools to make translations easier
Importing translation files into Odoo
Altering a website’s custom language URL code
12
Chapter 12: Automation, Workflows, Emails, and Printing
Chapter 12: Automation, Workflows, Emails, and Printing
Technical requirements
Managing dynamic record stages
Managing Kanban stages
Adding a quick create form to a Kanban card
Creating interactive Kanban cards
Adding a progress bar to Kanban views
Creating server actions
Using Python code server actions
Using automated actions on time conditions
Using automated actions on event conditions
Creating QWeb-based PDF reports
Managing activities from a Kanban card
Adding a stat button to a form view
Enabling the archive option for records
13
Chapter 13: Web Server Development
Chapter 13: Web Server Development
Technical requirements
Restricting access to web-accessible paths
Consuming parameters passed to your handlers
Modifying an existing handler
Serving static resources
14
Chapter 14: CMS Website Development
Chapter 14: CMS Website Development
Managing assets
Adding CSS and JavaScript for a website
Creating or modifying templates
Managing dynamic routes
Offering static snippets to the user
Offering dynamic snippets to the user
Getting input from website users
Managing SEO options
Managing sitemaps for the website
Getting a visitor’s country information
Tracking a marketing campaign
Managing multiple websites
Redirecting old URLs
Publish management for website-related records
15
Chapter 15: Web Client Development
Chapter 15: Web Client Development
Technical requirements
Creating custom widgets
Using client-side QWeb templates
Making RPC calls to the server
Creating a new view
Debugging your client-side code
Improving onboarding with tours
Mobile app JavaScript
16
Chapter 16: The Odoo Web Library (OWL)
Chapter 16: The Odoo Web Library (OWL)
Technical requirements
Creating an OWL component
Managing user actions in an OWL component
Making OWL components with hooks
Understanding the OWL component life cycle
Adding an OWL field to the form view
17
Chapter 17: In-App Purchasing with Odoo
Chapter 17: In-App Purchasing with Odoo
IAP concepts
Odoo IAP
18
Chapter 18: Automated Test Cases
Chapter 18: Automated Test Cases
Technical requirements
Adding Python test cases
Running tagged Python test cases
Setting up Headless Chrome for client-side test cases
Adding client-side QUnit test cases
Adding tour test cases
Running client-side test cases from the UI
Debugging client-side test cases
Generating videos/screenshots for failed test cases
Populating random data for testing
19
Chapter 19: Managing, Deploying, and Testing with Odoo.sh
Chapter 19: Managing, Deploying, and Testing with Odoo.sh
Exploring some basic concepts of Odoo.sh
Creating an Odoo.sh account
Adding and installing custom modules
Managing branches
Accessing debugging options
Getting a backup of your instance
Checking the status of your builds
All Odoo.sh options
20
Chapter 20: Remote Procedure Calls in Odoo
Chapter 20: Remote Procedure Calls in Odoo
Technical requirements
Logging in to/connecting Odoo with XML-RPC
Searching/reading records using XML-RPC
Creating/updating/deleting records using XML-RPC
Calling methods using XML-RPC
Logging in to/connecting Odoo with JSON-RPC
Fetching/searching records using JSON-RPC
Creating/updating/deleting records using JSON-RPC
Calling methods using JSON-RPC
The OCA odoorpc library
Generating API keys
21
Chapter 21: Performance Optimization
Chapter 21: Performance Optimization
The prefetching pattern for recordsets
The in-memory cache – ormcache
Generating images in different size
Accessing grouped data
Creating or writing multiple records
Accessing records through database queries
Profiling
22
Chapter 22: Point of Sale
Chapter 22: Point of Sale
Technical requirements
Adding custom JavaScript/SCSS files
Adding an action button to the keyboard
Making RPC calls
Modifying the Point of Sale screen UI
Modifying existing business logic
Modifying customer receipts
23
Chapter 23: Managing Emails in Odoo
Chapter 23: Managing Emails in Odoo
Technical requirements
Configuring incoming and outgoing email servers
Managing chatter on documents
Managing activities on documents
Sending emails using the Jinja template
Sending emails using the QWeb template
Managing the email alias
Logging user changes in a chatter
Sending periodic digest emails
24
Chapter 24: Managing the IoT Box
Chapter 24: Managing the IoT Box
Technical requirements
Flashing the IoT Box image for Raspberry Pi
Connecting the IoT Box with a network
Adding the IoT Box to Odoo
Loading drivers and listing connected devices
Taking input from devices
Accessing the IoT Box through SSH
Configuring a POS
Sending PDF reports directly to a printer
25
Chapter 25: Web Studio
Chapter 25: Web Studio
Installing Odoo Web Studio
Suggested features
Components
Field properties
Views
Building a new app
Customizing an existing app
Built-in functions
Reports
26
Index
Index
Why subscribe?
27
Other Books You May Enjoy
Other Books You May Enjoy
Packt is searching for authors like you
Share your thoughts
Download a free PDF copy of this book

Organizing the add-on module file structure

An add-on module contains code files and other assets, such as XML files and images. For most of these files, we are free to choose where to place them inside the module directory.

However, Odoo uses some conventions on the module structure, so it is advisable to follow them. Proper code improves readability, eases maintenance, helps debugging, lowers complexity, and promotes reliability. These apply to every new module and all new developments.

Getting ready

We are expected to have an add-on module directory with only the __init__.py and __manifest__.py files. In this recipe, we assume this is local-addons/my_hostel.

How to do it...

To create a basic skeleton for the add-on module, perform the following steps:

  1. Create directories for the code files:
    $ cd local-addons/my_hostel
$ mkdir models
$ touch models/__init__.py
$ mkdir controllers
$ touch controllers/__init__.py
$ mkdir views
$ touch views/views.xml
$ mkdir security...

Unlock full access

Continue reading for free

A Packt free trial gives you instant online access to our library of over 7000 practical eBooks and videos, constantly updated with the latest in tech
Start a 7-day FREE trial
End of Section 6
Next Section
bookmark search playlist download
font-size

Change the font size

margin-width

Change margin width

day-mode

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Delete Bookmark

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY