Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
Odoo Development Cookbook
Odoo Development Cookbook

Odoo Development Cookbook: Build effective applications by applying Odoo development best practices

Arrow left icon
Profile Icon Holger Brunn Profile Icon Fayolle Profile Icon Daniel Reis
Arrow right icon
$54.99
Full star icon Full star icon Full star icon Full star icon Half star icon 4.6 (5 Ratings)
Paperback Apr 2016 400 pages 1st Edition
eBook
$29.99 $43.99
Paperback
$54.99
Subscription
Free Trial
Renews at $19.99p/m
Arrow left icon
Profile Icon Holger Brunn Profile Icon Fayolle Profile Icon Daniel Reis
Arrow right icon
$54.99
Full star icon Full star icon Full star icon Full star icon Half star icon 4.6 (5 Ratings)
Paperback Apr 2016 400 pages 1st Edition
eBook
$29.99 $43.99
Paperback
$54.99
Subscription
Free Trial
Renews at $19.99p/m
eBook
$29.99 $43.99
Paperback
$54.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with Print?

Product feature icon Instant access to your digital copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Redeem a companion digital copy on all Print orders
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Table of content icon View table of contents Preview book icon Preview Book

Odoo Development Cookbook

Chapter 2. Managing Odoo Server Instances

In this chapter, we will learn about:

  • Configuring the addons path
  • Updating the addon modules list
  • Standardizing your instance directory layout
  • Installing and upgrading local addon modules
  • Installing addon modules from GitHub
  • Applying changes to addons
  • Applying and trying proposed pull requests

Introduction

In Chapter 1, Installing the Odoo Development Environment, we have seen how to set up an Odoo instance using only the standard "core" addons, which are shipped by the editor. This chapter focuses on adding noncore addons to an Odoo instance, be it your own addons, or third-party addons such as the ones maintained by the Odoo Community Association (OCA).

Note

About the terminology – addon versus module

In this book, we will use the term addon or addon module to refer to a Python package that respects the expected format to be installed in Odoo. The user interface often uses the word module for this, but we prefer keeping this term for Python modules or packages that are not necessarily Odoo addons.

Configuring the addons path

The addons path is a configuration parameter that lists the directories, which will be searched for addon modules by Odoo when it initializes a new database.

Directories listed in the addons path are expected to contain subdirectories, each of which is an addon module.

Getting ready

This recipe assumes you have an instance ready, with a configuration file generated as described in Chapter 1, Installing the Odoo Development Environment. The source code of Odoo is available in ~/odoo-dev/odoo, and the configuration file is in ~/odoo-dev/my-instance.cfg.

How to do it…

To add the directory ~/odoo-dev/local-addons to the addons path of the instance, follow these steps:

  1. Edit the configuration file for your instance ~/odoo-dev/my-instance.cfg
  2. Locate the line starting with addons_path =. By default, it should look like the following:
    addons_path = ~/odoo-dev/odoo/openerp/addons,~/odoo-dev/odoo/addons
    
  3. Modify the line by appending a comma followed by the name of the directory...

Updating the addon modules list

As we said in the previous recipe, when you add a directory to the addons path, just restarting the Odoo server is not enough to be able to install one of the new addon modules. A specific action is required for Odoo to scan the addons path and update the list of available addon modules.

Getting ready

Start your instance, and connect to the instance using the Administrator account and activate the developer mode (see Chapter 1, Installing the Odoo Development Environment).

How to do it…

To update the list of available addon modules in your instance, you need to perform the following steps:

  1. Open the Apps menu:
    How to do it…
  2. Click on Update Apps List:
    How to do it…
  3. In the dialog, click on the Update button.
  4. At the end of the update, you can click on the first Apps entry to see the updated list of available addon modules. You will need to remove the default filter on Apps in the search box to see all of them.

How it works…

When the Update button is clicked on, Odoo will read the addons...

Standardizing your instance directory layout

We recommend that your development and production environments all use a similar directory layout. This standardization will prove helpful when you have to perform maintenance operations, and it will also ease your day to day work.

This recipe creates a directory structure that groups files having similar life cycles or similar purpose together in standardized subdirectories. Feel free to alter this structure to suit your needs, but be sure to have this documented somewhere.

How to do it…

To create the proposed instance layout, you need to perform the following steps:

  1. Create one directory per instance:
    $ mkdir ~/odoo-dev/projectname
    $ cd ~/odoo-dev/projectname
    
  2. Create a Python virtualenv in a subdirectory called env/:
    $ virtualenv env
    
  3. Create some subdirectories, as follows:
    $ mkdir src local bin filestore logs
    

    The functions of the subdirectories are as follows:

    • src/: This contains the clone of Odoo itself and of the various third-party addons projects...

Installing and upgrading local addon modules

The core of the functionality of Odoo comes from the addon modules. You have a wealth of addons available as part of Odoo itself as well as addon modules that you can download from the Internet or write yourself.

In this recipe, we will show how to install and upgrade addon modules through the web interface and from the command line.

The main benefits of using the command line for these operations are being able to act on more than one addon at a time and having a clear view of the server logs as the installation or update progresses, which is very useful when in the development mode or when scripting the installation of an instance.

Getting ready

You have an Odoo instance with its database initialized, the addons path is properly set, and the addons list is up to date.

How to do it…

There are two possible methods to install or update addons—you can use the web interface or the command line.

From the web interface

To install a new addon...

Installing addon modules from GitHub

GitHub is a great source of third-party addons. A lot of Odoo partners use GitHub to share the addons they maintain internally, and the Odoo Community Association (OCA) collectively maintains several hundreds of addons on GitHub. Before starting to write your own addon, be sure to check that nothing already exists that you could use as is or as a starting point.

This recipe will show you how to clone the partner-contact project of the OCA from GitHub and make the addon modules it contains available in your instance.

Getting ready

Suppose you want to change the way addresses are handled in your instance; your customer needs a third field in addition to Odoo's two (street and street2) to store addresses. You could certainly write your own addon to add a field on res.partner, but the issue is a bit trickier than it seems if you want the address to be properly formatted on invoices. Fortunately, someone on a mailing list tells you about the partner_address_street3...

Introduction


In Chapter 1, Installing the Odoo Development Environment, we have seen how to set up an Odoo instance using only the standard "core" addons, which are shipped by the editor. This chapter focuses on adding noncore addons to an Odoo instance, be it your own addons, or third-party addons such as the ones maintained by the Odoo Community Association (OCA).

Note

About the terminology – addon versus module

In this book, we will use the term addon or addon module to refer to a Python package that respects the expected format to be installed in Odoo. The user interface often uses the word module for this, but we prefer keeping this term for Python modules or packages that are not necessarily Odoo addons.

Configuring the addons path


The addons path is a configuration parameter that lists the directories, which will be searched for addon modules by Odoo when it initializes a new database.

Directories listed in the addons path are expected to contain subdirectories, each of which is an addon module.

Getting ready

This recipe assumes you have an instance ready, with a configuration file generated as described in Chapter 1, Installing the Odoo Development Environment. The source code of Odoo is available in ~/odoo-dev/odoo, and the configuration file is in ~/odoo-dev/my-instance.cfg.

How to do it…

To add the directory ~/odoo-dev/local-addons to the addons path of the instance, follow these steps:

  1. Edit the configuration file for your instance ~/odoo-dev/my-instance.cfg

  2. Locate the line starting with addons_path =. By default, it should look like the following:

    addons_path = ~/odoo-dev/odoo/openerp/addons,~/odoo-dev/odoo/addons
    
  3. Modify the line by appending a comma followed by the name of the directory...

Left arrow icon Right arrow icon
Download code icon Download Code

Key benefits

  • 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

Description

Odoo is a full-featured open source ERP with a focus on extensibility. The flexibility and sustainability of open source is also a key selling point of Odoo. It is built on a powerful framework for rapid application development, both for back-end applications and front-end websites. The book starts by covering Odoo installation and administration, and provides a gentle introduction to application development. It then dives deep into several of the areas that an experienced developer will need to use. You’ll learn implement business logic, adapt the UI, and extend existing features.

Who is this book for?

If you are a Python developer who wants to learn or consolidate your Odoo development skills, then this book is for you! Some experience with the JavaScript programming language and web development is required to fully benefit from the front-end chapters.

What you will learn

  • Install and manage Odoo environments and instances
  • Use Models to define your application s data structures
  • Add business logic to your applications
  • Implement automated tests and debug Odoo apps
  • Use back-end views to create a user interface
  • Get to know about the access security model and internationalization features
  • Develop front-end website features
  • Extend the web client with new widgets and features
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Apr 29, 2016
Length: 400 pages
Edition : 1st
Language : English
ISBN-13 : 9781785883644
Vendor :
Odoo S.A
Category :
Languages :
Tools :

What do you get with Print?

Product feature icon Instant access to your digital copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Redeem a companion digital copy on all Print orders
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Publication date : Apr 29, 2016
Length: 400 pages
Edition : 1st
Language : English
ISBN-13 : 9781785883644
Vendor :
Odoo S.A
Category :
Languages :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 136.97
Odoo Development Cookbook
$54.99
Odoo 10 Development Essentials
$48.99
Odoo Development Essentials
$32.99
Total $ 136.97 Stars icon

Table of Contents

17 Chapters
1. Installing the Odoo Development Environment Chevron down icon Chevron up icon
2. Managing Odoo Server Instances Chevron down icon Chevron up icon
3. Creating Odoo Modules Chevron down icon Chevron up icon
4. Application Models Chevron down icon Chevron up icon
5. Basic Server Side Development Chevron down icon Chevron up icon
6. Advanced Server Side Development Techniques Chevron down icon Chevron up icon
7. Debugging and Automated Testing Chevron down icon Chevron up icon
8. Backend Views Chevron down icon Chevron up icon
9. Module Data Chevron down icon Chevron up icon
10. Access Security Chevron down icon Chevron up icon
11. Internationalization Chevron down icon Chevron up icon
12. Automation and Workflows Chevron down icon Chevron up icon
13. Web Server Development Chevron down icon Chevron up icon
14. CMS Website Development Chevron down icon Chevron up icon
15. Web Client Development Chevron down icon Chevron up icon
16. Server Deployment Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.6
(5 Ratings)
5 star 60%
4 star 40%
3 star 0%
2 star 0%
1 star 0%
N. Demarco Aug 16, 2016
Full star icon Full star icon Full star icon Full star icon Full star icon 5
I always want to know know who is writing the computer software book review, so I'll start there. I'm pretty comfortable in Linux. I'm not really a developer or DevOp. I have a lot of manufacturing and ERP experience. Let's get into the book review.The book is written for Odoo v9. v10 comes out ~October 2016. Most info will still apply. v8 was a bit different, and v7 was wholly different. This book should work for quite a while.What it won't do:This won't teach you Linux, Python, or XML syntax, but it shouldn't. You should have a reasonable understanding of git (like GitHub). You should have already played with Odoo a bit to learn how it comes together. You should also know about your business processes.What it will do:Teach you by doing first, explaining second. Chapters are organized with the _how it works_ following the procedural _recipe_. This works well because you're curious to see how a certain bit you just typed works. Brunn et.al. have done well referring to related recipes, including those you haven't seen yet.You'll learn, by example, how to set up a new Odoo instance. The authors give good tips for building a maintanable infrastructure to run your Odoo project.You'll learn how to create and extend Odoo modules. After building out some basic functionality, the authors explain more broad concepts. Don't expect your pace through the book to be linear. The first few chapters may take 1-2 days. Mastering later chapters could take months or more. In this way, Cookbook is instructional and a reference.If you're building out an Odoo instance, or if you develop Odoo modules professionally, this is definitely worth the small price.
Amazon Verified review Amazon
Wilton Beltre Aug 08, 2016
Full star icon Full star icon Full star icon Full star icon Full star icon 5
I'm just half of the book and am very surprised with the details which it covers, terrific book!
Amazon Verified review Amazon
Jaidev Shah Nov 28, 2016
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This is the book to buy for practically any reference for Odoo. Great book!!
Amazon Verified review Amazon
Ravi Bhattarai May 10, 2016
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
This is one of the detailed and widely covered book on Odoo Development. I liked the simplicity and coverage made in the book. It was one of the long awaited and need for the market for new and experienced developers alike.
Amazon Verified review Amazon
shrek Jan 25, 2017
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Nice one but not much in use for odoo 10. Odoo 10 has major syntax change
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the digital copy I get with my Print order? Chevron down icon Chevron up icon

When you buy any Print edition of our Books, you can redeem (for free) the eBook edition of the Print Book you’ve purchased. This gives you instant access to your book when you make an order via PDF, EPUB or our online Reader experience.

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela