Rating: 5 out of 5 stars
5/5
Ebook1,053 pages6 hours
Odoo Development Cookbook
By Holger Brunn, Alexandre Fayolle and Daniel Reis
Rating: 0 out of 5 stars
()
About this ebook
About This Book
- Each recipe stands by itself as much as possible, so that you can jump straight into the topics you prefer
- The recipes included cover all the major development areas of Odoo and the most important techniques explained through real-life projects
- From seasoned authors, learn the tricks of becoming a productive developer with the Odoo framework
This book is targeted at Python developers who want to learn Odoo development or consolidate their Odoo skills. Some experience with the JavaScript programming language and web development in general is required to fully benefit from the frontend chapters.
This book focuses on core application development. It does not cover how to use the business applications provided by Odoo. You may want to refer to Working with Odoo, by Greg Moss, for this.
This book does not provide explanations about how the internals of the enterprise management applications work. To understand this, you will have to read the source code and experiment for yourself. Being familiar with the contents of the Odoo Development Cookbook should make your life easier, as it contains pointers to parts of the code you can read to learn about a specific topic.Related to Odoo Development Cookbook
Related ebooks
Flask Framework Cookbook Talend Open Studio Cookbook Rating: 2 out of 5 stars2/5OData Programming Cookbook for .NET Developers Rating: 0 out of 5 stars0 ratingsWindows Application Development Cookbook Rating: 0 out of 5 stars0 ratingsRedmine Cookbook Rating: 0 out of 5 stars0 ratingsMongoDB Cookbook - Second Edition Rating: 0 out of 5 stars0 ratingsNode Cookbook: Second Edition Rating: 3 out of 5 stars3/5Odoo 10 Development Essentials Rating: 0 out of 5 stars0 ratingsWorking with Odoo Rating: 5 out of 5 stars5/5Odoo Development Essentials Rating: 0 out of 5 stars0 ratingsWorking with Odoo 10 - Second Edition Rating: 4 out of 5 stars4/5Odoo A Complete Guide - 2020 Edition Rating: 0 out of 5 stars0 ratingsOdoo A Complete Guide - 2021 Edition Rating: 0 out of 5 stars0 ratingsOdoo A Complete Guide - 2019 Edition Rating: 0 out of 5 stars0 ratingsNative Docker Clustering with Swarm Rating: 0 out of 5 stars0 ratingsLearning Dynamics NAV Patterns Rating: 0 out of 5 stars0 ratingsDjango Unleashed: Building Web Applications with Python's Framework Rating: 0 out of 5 stars0 ratingsWebSocket Essentials – Building Apps with HTML5 WebSockets Rating: 0 out of 5 stars0 ratingsMastering jQuery UI Rating: 0 out of 5 stars0 ratingsRuby on Rails Web Mashup Projects Rating: 0 out of 5 stars0 ratingsPython for Google App Engine Rating: 0 out of 5 stars0 ratingsMicroservices Deployment Cookbook Rating: 0 out of 5 stars0 ratingsuse case A Complete Guide - 2019 Edition Rating: 0 out of 5 stars0 ratingsRestlet in Action: Developing RESTful web APIs in Java Rating: 0 out of 5 stars0 ratingsDjango Admin Cookbook Rating: 0 out of 5 stars0 ratingsOpenNebula 3 Cloud Computing Rating: 0 out of 5 stars0 ratingsMastering Apache Camel Rating: 0 out of 5 stars0 ratingsUML: A Beginner's Guide Rating: 3 out of 5 stars3/5Software Design Pattern A Complete Guide - 2020 Edition Rating: 0 out of 5 stars0 ratings
Enterprise Applications For You
Learn Windows PowerShell in a Month of Lunches Rating: 0 out of 5 stars0 ratingsAgile Project Management: Scrum for Beginners Rating: 4 out of 5 stars4/5Excel Formulas That Automate Tasks You No Longer Have Time For Rating: 5 out of 5 stars5/5Creating Online Courses with ChatGPT | A Step-by-Step Guide with Prompt Templates Rating: 4 out of 5 stars4/5Notion for Beginners: Notion for Work, Play, and Productivity Rating: 4 out of 5 stars4/550 Useful Excel Functions: Excel Essentials, #3 Rating: 5 out of 5 stars5/5Bitcoin For Dummies Rating: 4 out of 5 stars4/5Excel : The Ultimate Comprehensive Step-By-Step Guide to the Basics of Excel Programming: 1 Rating: 5 out of 5 stars5/5Excel Formulas and Functions 2020: Excel Academy, #1 Rating: 4 out of 5 stars4/5Excel 2019 Bible Rating: 4 out of 5 stars4/5The Basics of Hacking and Penetration Testing: Ethical Hacking and Penetration Testing Made Easy Rating: 4 out of 5 stars4/5Learning Python Rating: 5 out of 5 stars5/5Enterprise AI For Dummies Rating: 3 out of 5 stars3/5QuickBooks 2021 For Dummies Rating: 0 out of 5 stars0 ratingsExcel 2019 For Dummies Rating: 3 out of 5 stars3/5101 Ready-to-Use Excel Formulas Rating: 4 out of 5 stars4/5Excel 2016 For Dummies Rating: 4 out of 5 stars4/5Excel Tips and Tricks Rating: 0 out of 5 stars0 ratingsCreate Income through Self-Publishing: An Author's Approach on Generating Wealth by Self-Publishing Rating: 5 out of 5 stars5/5Essential Office 365 Third Edition: The Illustrated Guide to Using Microsoft Office Rating: 3 out of 5 stars3/5Experts' Guide to OneNote Rating: 5 out of 5 stars5/5ChatGPT Ultimate User Guide - How to Make Money Online Faster and More Precise Using AI Technology Rating: 0 out of 5 stars0 ratingsUsing Word 2019: The Step-by-step Guide to Using Microsoft Word 2019 Rating: 0 out of 5 stars0 ratingsThe Ridiculously Simple Guide To Numbers For Mac Rating: 0 out of 5 stars0 ratingsQuickBooks Online For Dummies Rating: 0 out of 5 stars0 ratings
Related podcast episodes
Node.js with Myles Borins: Myles Borins joins the podcast to share all his knowledge about Node.js! 0% found this document useful#71 - Strategic Monoliths and Microservices - Vaughn Vernon 0% found this document usefulEpisode 326: JSJ 322: Building SharePoint Extensions with JavaScript with Vesa Juvonen LIVE at Microsoft Build 0% found this document usefulEpisode 199: AiA 198: Building SharePoint Extensions with JavaScript with Vesa Juvonen LIVE at Microsoft Build 0% found this document usefulFirst Impressions of Fresh Books: First Impressions of Fresh Books 0% found this document usefulThe Cloudcast #346 - What is Observability? 0% found this document usefulOpsLevel and The Need for a Developer Portal with Kenneth Rose 0% found this document useful5 Important "Systems" That Instructional Coaches Should Setup for their Coaching Programs 0% found this document usefulEpisode #55: Using Systems To Create Time - With David Jenyns 0% found this document usefulEpisode 217: AiA 216: Building a Complete Web Application from Scratch Alone with Amir Tugendhaft 0% found this document useful
Related articles
How This Startup is Making Mobile App Development Easier EntrepreneurArticle
How This Startup is Making Mobile App Development Easier
Apr 1, 2016
1 min readKAFKA Build Utilities With The Kafka Server Linux FormatArticle
KAFKA Build Utilities With The Kafka Server
Jul 2, 2019
Nowadays, quite a few data architectures involve both a database and Apache Kafka, which is a distributed streaming platform and the subject of this tutorial. You can also find Kafka described as a publish-subscribe message system, which is a fancy w
7 min readAccess Your Mac Anywhere MacLifeArticle
Access Your Mac Anywhere
Nov 8, 2022
2 min readHelp Yourself To Avoid These Pitfalls MacLifeArticle
Help Yourself To Avoid These Pitfalls
Dec 11, 2018
GETTING UP TO full speed with the Shortcuts app takes time, and you’ll inevitably make a few mistakes along the way. Having to troubleshoot your efforts doesn’t mean you’ve failed — with years of experience, even professional programmers do this. Tak
2 min readCode An Admin Back-end In Django Linux FormatArticle
Code An Admin Back-end In Django
Dec 13, 2022
Credit: www.djangoproject.com OUR EXPERT Matt Holder has been a fan of the open source methodology for over two decades and uses Linux and other tools where possible. More featurepacked source code for this project can be downloaded from https://
6 min readGoogle Answer Box Strategy TechfastlyArticle
Google Answer Box Strategy
Sep 21, 2020
Leveraging the Google PAA (People Also Ask) element on a Search Results Page for Targeted Content Creation with a Python Scraper All businesses that are online today are creating content at a furious pace. According to Technavio, a research firm, con
7 min readScan And Scrape Websites Using Python Linux FormatArticle
Scan And Scrape Websites Using Python
Nov 14, 2023
David Bolton once accidentally boosted the traffic for his firm’s website by 25% in one day by running a web scraper on it. Luckily, they never found out! Ever since the web made an appearance back in the mid-’90s, programmers have been writing softw
6 min readEnterprise-grade Monitoring Made Easy Linux FormatArticle
Enterprise-grade Monitoring Made Easy
Mar 10, 2020
9 min readEmbed An Excel File On Your Site ComputeractiveArticle
Embed An Excel File On Your Site
Jul 20, 2022
When you need to share data in an Excel spreadsheet, you could choose to extract it and then send it to members. An easier way is to embed it on your site for everyone to see. In our example, our local history club wants to share details of its yearl
2 min readFinish Your Cataloguing App Linux FormatArticle
Finish Your Cataloguing App
Jan 10, 2023
Matt Holder has been a fan of the open source methodology for over two decades and uses Linux and other tools where possible. In his spare time, Matt enjoys listening to music and reading. More featurepacked source code for this project can be downlo
7 min readCode A Cataloguing Application In Python Linux FormatArticle
Code A Cataloguing Application In Python
Nov 15, 2022
Credit: www.djangoproject.com Matt Holder has been a fan of the open source methodology for over two decades and uses Linux and other tools where possible. More featurepacked source code for this project can be downloaded from https://github.com/mat
8 min read“There’s Something About Online Meetings That Makes People More Willing To Engage With Each Other” PC Pro MagazineArticle
“There’s Something About Online Meetings That Makes People More Willing To Engage With Each Other”
Oct 8, 2020
9 min readObservability Of The Kernel And Containers Linux FormatArticle
Observability Of The Kernel And Containers
Apr 4, 2023
Mihalis Tsoukalos is currently working on Time Series. You can reach him at: @mactsouk. For our final delve into eBPF, we’re tackling applications, the kernel and Docker containers. At the end of the day, all Linux machines execute code for applicat
10 min readAssessing Ease Of Use Linux FormatArticle
Assessing Ease Of Use
Jul 28, 2020
3 min readA Place For Everything Outdoor PhotographerArticle
A Place For Everything
Aug 10, 2019
9 min readDJANGO Create A Database-driven Website Linux FormatArticle
DJANGO Create A Database-driven Website
Jun 4, 2019
The Django web framework was named after the famous guitarist Django Reinhardt and was first created by web developers at a small newspaper in Kansas. The main goals of Django is to enable fast development of complex websites with database needs. It
7 min readDiscover Easy-to -build Desktop Apps Linux FormatArticle
Discover Easy-to -build Desktop Apps
Oct 22, 2019
Electron is actually a browser packaged with node.js and a few APIs. Because it’s built on top of the Chromium browser, you have everything available from there to add to your application. GitHub developed it as part of the Atom editor; it was open-s
7 min readManipulate Data Like A Pro With Pandas Linux FormatArticle
Manipulate Data Like A Pro With Pandas
Jul 27, 2021
7 min read“There’s No Single ‘Best’ Language To Learn. I Think The Real Key Is To Learn How To Write Code” PC Pro MagazineArticle
“There’s No Single ‘Best’ Language To Learn. I Think The Real Key Is To Learn How To Write Code”
Oct 8, 2022
9 min readMARIADB Optimise And Control Your Databases Linux FormatArticle
MARIADB Optimise And Control Your Databases
Jul 30, 2019
9 min readMailserver Linux FormatArticle
Mailserver
Jun 27, 2023
4 min readFLASK Web Frameworks Linux FormatArticle
FLASK Web Frameworks
Jun 4, 2019
The main focus of Python has always been to get you cracking on with your coding – the language was never made for web programming. However, this has just made it more interesting to extend the language for the web, or to create an interface to web-b
9 min readBuild A Self-hosted Productivity Hub Linux FormatArticle
Build A Self-hosted Productivity Hub
Jul 30, 2019
10 min readSites For Sore Eyes The Best Website Options For Photographers Australian PhotographyArticle
Sites For Sore Eyes The Best Website Options For Photographers
Jul 21, 2022
6 min readContributing For Non - Coders Linux FormatArticle
Contributing For Non - Coders
Jan 10, 2023
9 min readMac 911 MacWorldArticle
Mac 911
Sep 18, 2018
5 min read5 Safari Alternatives Worth Trying Macworld UKArticle
5 Safari Alternatives Worth Trying
Mar 13, 2020
4 min readHow To Use Mojolicious For Web Scraping Linux FormatArticle
How To Use Mojolicious For Web Scraping
Mar 8, 2022
Part One Don’t miss next issue! Subscribe on page 16 Mark Gardner is a software developer and blogger with over 25 years of IT experience. You can reach him at www.phoenixtrap.com and @markjgardner. The map function is designed to transform a list or
5 min readHow To Use Mojolicious For Web Scraping Linux FormatArticle
How To Use Mojolicious For Web Scraping
Mar 8, 2022
Part One Don’t miss next issue! Subscribe on page 16 Mark Gardner is a software developer and blogger with over 25 years of IT experience. You can reach him at www.phoenixtrap.com and @markjgardner. The map function is designed to transform a list or
5 min readTweaking System Components Linux FormatArticle
Tweaking System Components
Nov 19, 2019
4 min read
Reviews for Odoo Development Cookbook
Rating: 0 out of 5 stars
0 ratings
0 ratings0 reviews
Book preview
Odoo Development Cookbook - Holger Brunn
Table of Contents
Odoo Development Cookbook
Credits
About the Authors
About the Reviewers
www.PacktPub.com
eBooks, discount offers, and more
Why subscribe?
Preface
What this book covers
Who this book is for
What you need for this book
Sections
Getting ready
How to do it…
How it works…
There's more…
See also
Conventions
Reader feedback
Customer support
Downloading the example code
Downloading the color images of this book
Errata
Piracy
Questions
1. Installing the Odoo Development Environment
Introduction
Easy installation of Odoo from source
Getting ready
How to do it...
How it works...
Virtual environments
PostgreSQL configuration
Git configuration
Downloading the Odoo source code
Starting the instance
There is more…
Managing Odoo environments using the start command
Getting ready
How to do it...
How it works...
There's more
Managing Odoo server databases
Getting ready
How to do it...
Access the Database Management interface
Set or change the master password
Creating a new database
Duplicating a database
Removing a database
Backing up a database
Restoring a database backup
How it works...
There is more...
Storing the instance configuration in a file
How to do it...
How it works...
There is more...
Activating the Odoo developer tools
How to do it...
How it works...
Updating Odoo from source
Getting ready
How to do it...
How it works...
2. Managing Odoo Server Instances
Introduction
Configuring the addons path
Getting ready
How to do it…
How it works…
There's more…
Updating the addon modules list
Getting ready
How to do it…
How it works…
Standardizing your instance directory layout
How to do it…
How it works…
See also
Installing and upgrading local addon modules
Getting ready
How to do it…
From the web interface
From the command line
How it works…
Addon installation
Addon update
There's more…
Installing addon modules from GitHub
Getting ready
How to do it…
How it works…
There's more…
Applying changes to addons
Getting ready
How to do it…
How it works…
See also
Applying and trying proposed pull requests
Getting ready
How to do it…
How it works…
There's more…
3. Creating Odoo Modules
Introduction
Creating and installing a new addon module
Getting ready
How to do it…
How it works…
Completing the addon module manifest
Getting ready
How to do it…
How it works…
There's more
Organizing the addon module file structure
Getting ready
How to do it…
How it works…
Adding models
Getting ready
How to do it…
How it works…
Adding Menu Items and Views
Getting ready
How to do it…
How it works…
Using scaffold to create a module
Getting ready
How to do it…
How it works…
There's more…
4. Application Models
Introduction
Defining the Model representation and order
Getting ready
How to do it…
How it works…
There's more…
Adding data fields to a model
Getting ready
How to do it…
How it works…
There's more…
Using a float field with configurable precision
Getting ready
How to do it…
How it works…
Adding a monetary field to a Model
Getting ready
How to do it…
How it works…
Adding relational fields to a Model
Getting ready
How to do it…
How it works…
There's more…
Adding a hierarchy to a Model
Getting ready
How to do it…
How it works…
There's more…
Adding constraint validations to a Model
Getting ready
How to do it…
How it works…
Adding computed fields to a Model
Getting ready
How to do it…
How it works…
Exposing Related fields stored in other models
Getting ready
How to do it…
How it works…
There's more…
Adding dynamic relations using Reference fields
Getting ready
How to do it…
How it works…
Adding features to a Model using inheritance
Getting ready
How to do it…
How it works…
There's more…
Using Abstract Models for reusable Model features
Getting ready
How to do it…
How it works…
There's more…
Using Delegation inheritance to copy features to another Model
Getting ready
How to do it…
How it works…
There's more…
5. Basic Server Side Development
Introduction
Defining model methods and use the API decorators
Getting ready
How to do it…
How it works…
There's more…
Hiding methods from the RPC interface
The @api.one decorator
See also
Reporting errors to the user
Getting ready
How to do it…
How it works…
There's more…
Obtaining an empty recordset for a different model
Getting ready
How to do it…
How it works…
See also
Creating new records
Getting ready
How to do it…
How it works…
There's more
Updating values of recordset records
Getting ready
How to do it…
How it works…
There's more…
Searching for records
Getting ready
How to do it…
How it works…
There's more…
Combining recordsets
Getting ready
How to do it…
How it works…
There's more…
Filtering recordsets
Getting ready
How to do it…
How it works…
There's more…
Traversing recordset relations
Getting ready
How to do it…
How it works…
There's more…
See also
Extending the business logic defined in a Model
Getting ready
How to do it…
How it works…
There's more…
Extending write() and create()
Getting ready
How to do it…
How it works…
There's more…
Customizing how records are searched
Getting ready
How to do it…
How it works…
There's more…
See also
6. Advanced Server Side Development Techniques
Introduction
Change the user performing an action
Getting ready
How to do it…
How it works…
There is more…
See also
Call a method with a modified context
Getting ready
How to do it…
How it works…
There's more…
See also
Execute raw SQL queries
Getting ready
How to do it…
How it works…
There's more…
See also
Write a wizard to guide the user
Getting ready
How to do it…
How it works…
There's more…
Using the context to compute default values
Wizards and code reuse
Redirecting the user
Define onchange methods
Getting ready
How to do it…
How it works…
There's more…
Call onchange methods on the server side
Getting ready
How to do it…
How it works…
There's more…
See also
Port old API code to the new API
Getting ready
How to do it…
How it works
7. Debugging and Automated Testing
Introduction
Producing server logs to help debug methods
Getting ready
How to do it…
How it works…
There's more…
Using the Odoo shell to interactively call methods
Getting ready
How to do it…
How it works…
Using the Python debugger to trace method execution
Getting ready
How to do it…
How it works…
There's more…
See also
Writing tests for your module using YAML
Getting ready
How to do it…
How it works…
There's more…
Writing tests for your module using Python unit tests
Getting ready
How to do it…
How it works…
There's more…
Running server tests
Getting ready
How to do it…
How it works…
There's more…
Using the Odoo Community Association maintainer quality tools
Getting ready
How to do it…
How it works…
8. Backend Views
Introduction
Adding a menu item and window action
How to do it...
How it works...
There's more...
See also
Having an action open a specific view
How to do it...
How it works...
ir.actions.act_window.view
Adding content and widgets to a form view
How to do it...
How it works...
Form
Header
Button
Group
Field
General attributes
Other tags
There's more...
See also
Adding buttons to forms
How to do it...
How it works...
There's more...
Passing parameters to forms and actions: Context
Getting ready
How to do it...
How it works...
There's more...
See also
Defining filters on record lists: Domain
How to do it...
How it works...
There's more...
Operators
Pitfalls
See also
List views
How to do it...
How it works...
There's more...
Search views
How to do it...
How it works...
There's more...
See also
Changing existing views: View inheritance
How to do it...
How it works...
There's more...
Order of evaluation in view inheritance
See also
Document-style forms
How to do it...
How it works...
Dynamic form elements using attrs
How to do it...
How it works...
There's more...
Embedded views
How to do it...
How it works...
There's more...
Kanban views
How to do it...
How it works...
There's more...
Show kanban cards in columns according to their state
Getting ready
How to do it...
How it works...
There's more...
Calendar views
How to do it...
How it works...
There's more...
Graph and pivot views
Getting ready
How to do it...
How it works...
There's more...
QWeb reports
Getting ready
How to do it...
How it works...
There's more...
9. Module Data
Introduction
Using external IDs and namespaces
How to do it...
How it works...
There's more...
See also
Loading data using XML files
How to do it...
How it works...
There's more...
Using the noupdate and forcecreate flags
How to do it...
How it works...
There's more...
See also
Loading data using CSV files
How to do it...
How it works...
There's more...
Loading data using YAML files
How to do it...
How it works...
There's more...
See also
Addon updates and data migration
How to do it...
How it works...
There's more...
See also
10. Access Security
Create security groups and assign them to users
Getting ready
How to do it...
How it works...
There's more...
Add security access to models
Getting ready
How to do it...
How it works...
There's more...
Limit access to fields in models
How to do it...
How it works...
There's more...
Limit record access using record rules
Getting ready
How to do it...
How it works...
There's more...
Using security group to activate features
Getting ready
How to do it...
How it works...
There's more...
11. Internationalization
Installing a language and configure user preferences
Getting ready
How to do it...
How it works...
There's more...
See also
Configure language-related settings
Getting ready
How to do it...
How it works...
There's more...
Translate texts through the web client user interface
Getting ready
How to do it...
How it works...
There's more...
Exporting translation strings to a file
Getting ready
How to do it...
How it works...
There's more...
Use gettext tools to ease translations
How to do it...
How it works...
There's more...
Import translation files
Getting ready
How to do it...
How it works...
12. Automation and Workflows
Introduction
Using Kanban stages and features
Getting ready
How to do it...
How it works...
There's more...
Creating server actions
Getting ready
How to do it...
How it works...
There's more...
Adding messaging and tracking features
Getting ready
How to do it...
How it works...
There's more...
Using Python code server actions
Getting ready
How to do it...
How it works...
There's more...
Using automated actions on time conditions
Getting ready
How to do it...
How it works...
There's more...
Using automated actions on event conditions
Getting ready
How to do it...
How it works...
There's more...
Inspecting built-in workflows
Getting ready
How to do it...
How it works...
See also
13. Web Server Development
Introduction
Make a path accessible from the network
Getting ready
How to do it…
How it works…
openerp.http.route
Return values
openerp.http.request
There's more…
See also
Restrict access to web accessible paths
Getting ready
How to do it…
How it works…
There's more…
Consume parameters passed to your handlers
How to do it…
How it works…
There's more…
See also
Modify an existing handler
Getting ready
How to do it…
How it works
There's more…
See also
Using the RPC API
How to do it…
How it works…
XMLRPC
JSONRPC
There's more…
See also
14. CMS Website Development
Introduction
Extending CSS and JavaScript for the website
Getting ready
How to do it...
How it works...
There's more...
Creating or modifying templates - QWeb
Getting ready
How to do it...
How it works...
Loops
Attributes
Fields
Conditionals
Inline editing
There's more...
See also
Offering snippets to the user
Getting ready
How to do it...
How it works...
There's more...
15. Web Client Development
Introduction
Creating custom widgets
Getting ready
How to do it...
How it works...
There's more...
See also
Using client-side QWeb templates
Getting ready
How to do it...
How it works...
There's more...
See also
Making RPC calls to the server
Getting ready
How to do it...
How it works...
There's more...
See also
Writing tests for client side code
Getting ready
How to do it...
How it works...
There's more...
See also
Debugging your client side code
Getting ready
How to do it...
How it works...
There's more...
16. Server Deployment
Introduction
Installing Odoo for production
Getting ready
How to do it…
How it works…
There's more…
Server dimensioning
PostgreSQL tuning
Source code version
Backups
See also
Adapting the configuration file for production
Getting ready
How to do it…
How it works…
There's more…
Set up Odoo as a system service
Getting ready
How to do it…
Configuring systemd to start Odoo
Configuring sysvinit or upstart to start Odoo
How it works…
There's more…
Configure a reverse proxy and SSL
Getting ready
How to do it…
How it works…
There's more…
See also
Use buildout for repeatable builds
Getting ready
How to do it…
How it works…
There's more…
Temporary merges
Freezing a buildout
See also
Index
Odoo Development Cookbook
Odoo Development Cookbook
Copyright © 2016 Packt Publishing
All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.
Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the authors, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.
Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.
First published: April 2016
Production reference: 1260416
Published by Packt Publishing Ltd.
Livery Place
35 Livery Street
Birmingham B3 2PB, UK.
ISBN 978-1-78588-364-4
www.packtpub.com
Credits
Authors
Holger Brunn
Alexandre Fayolle
Daniel Reis
Reviewers
Guewen Baconnier
Stefan Rijnhart
Acquisition Editor
Manish Nainani
Content Development Editor
Mehvash Fatima
Technical Editors
Menza Mathew
Deepti Tuscano
Copy Editors
Merilyn Pereira
Alpha Singh
Project Coordinator
Kinjal Bari
Proofreader
Safis Editing
Indexer
Monica Ajmera Mehta
Production Coordinator
Arvindkumar Gupta
Cover Work
Arvindkumar Gupta
About the Authors
Holger Brunn has been a fervent open source advocate since he came in to contact with the open source market sometime in the nineties. With an academic background in philosophy and sociology, he turned his interest to generalized logic, which proves helpful in many aspects of his IT work. Turning into a professional programmer was a side effect of his hobbyist interest, combined with a part-time job with a very open-minded mentor to whom he owes a lot of gratitude.
He has programmed for ERP and similar systems in different positions since 2001. For the last eight years, he has dedicated his time to TinyERP, which became OpenERP and evolved into Odoo. Currently, he works at Therp BV in the Netherlands as a developer and is an active member of the Odoo Community Association (OCA). He's most interested in fundamental work on technical modules, but also enjoys contributing to other projects, with a focus on UI and website widgets, CRM, and knowledge management.
Alexandre Fayolle started working with Linux and free software in the mid 1990s and quickly became interested in the Python programming language. Between 1999 and 2012, he helped manage Logilab, a company he cofounded, he specialized in Python development, and had the opportunity to work on projects for large companies such as EDF, Arcelor-Mittal, and GdF Suez (now Engie) using the Cubicweb framework.
He also tackled fun projects involving machine learning, natural language processing, and multi-agent systems. In 2012, he joined Camptocamp to share his expertise on Python, PostgreSQL, and Linux with the team implementing Odoo (OpenERP at the time). He currently manages projects for Camptocamp and is strongly involved in the Odoo Community Association. In his spare time, he likes to play the vibraphone in a jazz quartet, but has recently been known for writing a book about Odoo, which he hopes you'll enjoy.
Daniel Reis has been working in the IT industry for over 15 years in developer, consultant, and management roles. Most of this work was at the Capgemini multinational consultancy firm, implementing proprietary business solutions for reference companies in a variety of sectors, such as industry, telecommunications, and banking. Daniel has a BSc in applied mathematics and a master's in business administration from the ISCTE Business School.
He's worked with Odoo solutions (formerly OpenERP) since 2010, and he is an active contributor in the Odoo community association projects. He has been a speaker at the Open Days annual conference and other open source events. He is the author of the first Odoo development book: Odoo Development Essentials, also by Packt Publishing.
He currently works at Securitas, the global security services company, where he has introduced Python, Odoo, and other open source solutions into the company's IT applications portfolio.
I thank my wife, Maria José, for all the support and patience that made this book possible.
About the Reviewers
Guewen Baconnier is a discrete guy who does not enjoy being put forward. He works at Camptocamp where he's been a TinyERP programmer before moving to OpenERP and now Odoo. He is a free software enthusiast and an active member of the Odoo Community Association (OCA), where his responsibilities involve, among others, being the lead developer of the OCA Connector Framework. Guewen also loves books so should you come across him, there is a good chance he may have his nose in one, either reading a technical book to keep up with his boundless curiosity and hunger to learn, or reading a novel to journey in some fictional universe, or whatever good read fell into his hands. He likes to hike in the countryside with his beloved wife. He is also the happy father of two nice kids, with whom he enjoys spending time, strolling, going to the library, reading books, and playing Kerbal Space Program.
I would like to thank my wife and kids for supporting my tiredness on the morrows of long evenings of reviewing. And I would like to thank Alexandre Fayolle who helped me shape this short biography. Finally, thanks to my colleagues and to all contributors of the OCA from whom I learn every day.
Stefan Rijnhart is a life-long open source advocate and has been a full time Odoo consultant and developer since 2010. He enjoys collaborating in the Odoo Community Association (OCA), which he finds to be mutually beneficial to his customers' projects. In the OCA, Stefan played a key role in the creation of the OpenUpgrade migration project for Odoo and in the Odoo Community Backports project (OCB). Offline, you can find him riding a carrier bicycle through the streets of Amsterdam with his son on the front seat, or playing music with his band. Get in touch with Stefan at http://opener.amsterdam.
www.PacktPub.com
eBooks, discount offers, and more
Did you know that Packt offers eBook versions of every book published, with PDF and ePub files available? You can upgrade to the eBook version at www.PacktPub.com and as a print book customer, you are entitled to a discount on the eBook copy. Get in touch with us at
At www.PacktPub.com, you can also read a collection of free technical articles, sign up for a range of free newsletters and receive exclusive discounts and offers on Packt books and eBooks.
https://www2.packtpub.com/books/subscription/packtlibDo you need instant solutions to your IT questions? PacktLib is Packt's online digital book library. Here, you can search, access, and read Packt's entire library of books.
Why subscribe?
Fully searchable across every book published by Packt
Copy and paste, print, and bookmark content
On demand and accessible via a web browser
Preface
Odoo, formerly known as OpenERP, is a great platform for developers. The framework at its core is very rich and allows building client–server applications from scratch as well as adapting existing applications to your needs through a clever extension mechanism and a very modular design. The latest versions have brought a wealth of new possibilities with the addition of a full-featured website development stack. The scope is huge and it is easy for newcomers to feel lost.
For years, Odoo developers have been learning their craft by reading the code of the addon modules, which are built on top of the framework to provide enterprise management features. While effective, the process is long and error prone, since it is difficult to know whether the source code you are learning from is using the latest possibilities offered by the framework, or if you are looking at an older module that has not been updated to use these features. To make things worse, some code flows are intrinsically hard to follow because they're partly in the business logic layer, partly in the database layer, partly in the request handling layer, and partly in the client side code. The introduction of a new API in version 8 has made things even more confusing, since most of the code base was not immediately ported to this new API.
This book is meant to save you time by tapping in to the years of experience accumulated by long-time Odoo contributors to learn the current best practices in Odoo development by focusing on the new features of version 9, and also giving a solid base in the existing mature functionality of the framework. Since Odoo has a long tradition of guaranteeing backward compatibility, most of the presented material should still work with the upcoming versions.
What this book covers
This book contains 16 chapters. We tried hard to make each chapter as independent as possible, and to make the various recipes in each chapter self-contained.
Chapter 1, Installing the Odoo Development Environment, explains how to create a development environment for Odoo, start Odoo, create a configuration file, and activate the developer tools of Odoo.
Chapter 2, Managing Odoo Server Instances, is about addon installation and upgrading. It provides useful tips for working with addons installed from GitHub, and organizing the source code of your instance.
Chapter 3, Creating Odoo Modules, explains the structure of an Odoo addon module and gives a step-by-step guide for creating a simple module from scratch.
Chapter 4, Application Models, focuses on Odoo model descriptions, and explains the various field types and the different inheritance models available in Odoo.
Chapter 5, Basic Server Side Development, introduces the v8 API of Odoo, presents the commonly used methods of the Model class, and explains how to write business logic methods.
Chapter 6, Advanced Server Side Development Techniques, deals with more advanced topics useful when writing business methods such as writing wizards to walk the user through a process or writing onchange methods. It also covers porting code from the old API to the v8 API.
Chapter 7, Debugging and Automated Testing, proposes some strategies for server-side debugging and an introduction to the Python debugger. It also explains how to write and run automated tests using YAML or Python for your addon modules.
Chapter 8, Backend Views, explains how to write business views for your data models and how to call server-side methods from these views. It covers the usual views (list view, form view, and search view) as well as the views introduced in recent versions of Odoo (Kanban, graph, calendar, pivot, and so on)
Chapter 9, Module Data, shows how to ship data along with the code of your module. It also explains how to write a migration script when a data model provided by an addon is modified in a new release.
Chapter 10, Access Security, explains how to control who has access to what in your Odoo instance, by creating security groups, writing access control lists to define what operations are available to each group on a given model, and, if necessary, by writing record level rules.
Chapter 11, Internationalization, deals with the translation of the user interfaces of your addons.
Chapter 12, Automation and Workflows, illustrates the different tools available in Odoo to implement business process for your records. It also shows how server actions and automated rules can be used to support business rules.
Chapter 13, Web Server Development, deals with the core of the web server in Odoo. It explains how to map URLs to methods and how to control who can access these URLs.
Chapter 14, CMS Website Development, shows how to customize websites built with Odoo, by writing your own templates and providing new snippets for use in the website builder.
Chapter 15, Web Client Development, dives into the JavaScript part of Odoo and explains how you can provide new widgets and make RPC calls to the server. It also gives tips about debugging and testing this part of your code.
Chapter 16, Server Deployment, provides advice on how to install and configure Odoo for production, including setting up a reverse proxy to encrypt network communications over HTTPS and ensuring that Odoo starts when the server boots.
Who this book is for
This book is targeted at Python developers who want to learn Odoo development or consolidate their Odoo skills. Some experience with the JavaScript programming language and web development in general is required to fully benefit from the frontend chapters.
This book focuses on core application development. It does not cover how to use the business applications provided by Odoo. You may want to refer to Working with Odoo, by Greg Moss, for this.
This book does not provide explanations about how the internals of the enterprise management applications work. To understand this, you will have to read the source code and experiment for yourself. Being familiar with the contents of the Odoo Development Cookbook should make your life easier, as it contains pointers to parts of the code you can read to learn about a specific topic.
What you need for this book
The set up recipes in Chapter 1, Installing the Odoo Development Environment, and Chapter 15, Web Client Development, expect that you are working on a server running Debian GNU/Linux, or a derivative distribution such as Ubuntu, in a reasonably up-to-date release. If you are running another distribution, things should be fairly straightforward; the main differences should be in the names of the packages to install, and possibly the location of the configuration files of PostgreSQL and Nginx.
If your workstation is running Windows or MacOS, we advise you to set up a Debian virtual machine to work with Odoo. While it is possible to develop natively on Windows or Mac, having a development environment as close as possible to the deployment environment is a good way to avoid nasty surprises and GNU/Linux is the recommended deployment platform for Odoo.
Is there a recommended Integrated Development Environment (IDE) for Odoo? This is a frequently asked question by newcomers. The best answer is to use whatever tool you are familiar with. Popular choices include Eclipse or PyCharm, but a very high number of experimented developers, including the core Odoo developers, use just a programming text editor such as vim, GNU emacs, or Sublime Text to have syntax highlighting and useful helpers such as automatic indentation, while using the Python debugger for debugging. It is recommended to start with the basic tools because IDEs have a tendency to hide complexity you should be familiar with in order to fix the harder problems.
Sections
In this book, you will find several headings that appear frequently (Getting ready, How to do it, How it works, There's more, and See also).
To give clear instructions on how to complete a recipe, we use these sections as follows:
Getting ready
This section tells you what to expect in the recipe, and describes how to set up any software or any preliminary settings required for the recipe.
How to do it…
This section contains the steps required to follow the recipe.
How it works…
This section usually consists of a detailed explanation of what happened in the previous section.
There's more…
This section consists of additional information about the recipe in order to make the reader more knowledgeable about the recipe.
See also
This section provides helpful links to other useful information for the recipe.
Conventions
In this book, you will find a number of text styles that distinguish between different kinds of information. Here are some examples of these styles and an explanation of their meaning.
Code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles are shown as follows: The parsing of the configuration file by Odoo is done using the Python ConfigParser module.
A block of code is set as follows:
[DEFAULT]
project = /home/odoo/projects/project1
env = dev
prefix = %(project)s/%(env)s
[options]
addons-path = %(prefix)s/odoo/addons,%(prefix)s/OCA/server-tools
data_dir = %(prefix)s/data_dir
When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:
{ 'name': 'Chapter 03 code', 'depends': ['base', 'decimal_precision],
'data': ['views/library_book.xml'] }
Any command-line input or output is written as follows:
$ sudo apt-get install git python2.7 postgresql nano python-virtualenv
New terms and important words are shown in bold. Words that you see on the screen, for example, in menus or dialog boxes, appear in the text like this: Click on the Manage Databases link.
Note
Warnings or important notes appear in a box like this.
Tip
Tips and tricks appear like this.
Reader feedback
Feedback from our readers is always welcome. Let us know what you think about this book—what you liked or disliked. Reader feedback is important for us as it helps us develop titles that you will really get the most out of.
To send us general feedback, simply e-mail <feedback@packtpub.com>, and mention the book's title in the subject of your message.
If there is a topic that you have expertise in and you are interested in either writing or contributing to a book, see our author guide at www.packtpub.com/authors.
Customer support
Now that you are the proud owner of a Packt book, we have a number of things to help you to get the most from your purchase.
Downloading the example code
You can download the example code files for this book from your account at http://www.packtpub.com. If you purchased this book elsewhere, you can visit http://www.packtpub.com/support and register to have the files e-mailed directly to you.
You can download the code files by following these steps:
Log in or register to our website using your e-mail address and password.
Hover the mouse pointer on the SUPPORT tab at the top.
Click on Code Downloads & Errata.
Enter the name of the book in the Search box.
Select the book for which you're looking to download the code files.
Choose from the drop-down menu where you purchased this book from.
Click on Code Download.
You can also download the code files by clicking on the Code Files button on the book's webpage at the Packt Publishing website. This page can be accessed by entering the book's name in the Search box. Please note that you need to be logged in to your Packt account.
Once the file is downloaded, please make sure that you unzip or extract the folder using the latest version of:
WinRAR / 7-Zip for Windows
Zipeg / iZip / UnRarX for Mac
7-Zip / PeaZip for Linux
Downloading the color images of this book
We also provide you with a PDF file that has color images of the screenshots/diagrams used in this book. The color images will help you better understand the changes in the output. You can download this file from http://www.packtpub.com/sites/default/files/downloads/Bookname_ColorImages.pdf.
Errata
Although we have taken every care to ensure the accuracy of our content, mistakes do happen. If you find a mistake in one of our books—maybe a mistake in the text or the code—we would be grateful if you could report this to us. By doing so, you can save other readers from frustration and help us improve subsequent versions of this book. If you find any errata, please report them by visiting http://www.packtpub.com/submit-errata, selecting your book, clicking on the Errata Submission Form link, and entering the details of your errata. Once your errata are verified, your submission will be accepted and the errata will be uploaded to our website or added to any list of existing errata under the Errata section of that title.
To view the previously submitted errata, go to https://www.packtpub.com/books/content/support and enter the name of the book in the search field. The required information will appear under the Errata section.
Piracy
Piracy of copyrighted material on the Internet is an ongoing problem across all media. At Packt, we take the protection of our copyright and licenses very seriously. If you come across any illegal copies of our works in any form on the Internet, please provide us with the location address or website name immediately so that we can pursue a remedy.
Please contact us at <copyright@packtpub.com> with a link to the suspected pirated material.
We appreciate your help in protecting our authors and our ability to bring you valuable content.
Questions
If you have a problem with any aspect of this book, you can contact us at <questions@packtpub.com>, and we will do our best to address the problem.
Chapter 1. Installing the Odoo Development Environment
In this chapter, we will cover the following topics:
Easy installation of Odoo from source
Managing Odoo environments using the start command
Managing Odoo server databases
Storing the instance configuration in a file
Activating the Odoo developer tools
Updating Odoo from source
Introduction
There are lots of ways to set up an Odoo development environment. This chapter
Enjoying the preview?
Page 1 of 1