Odoo

https://www.odoo.com/documentation/master
Admin
Odoo is an open-source suite of integrated business applications including CRM, accounting,...
Tokens:1,619,191
Snippets:13,419
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Numbered list (starting at 6)

Source: https://www.odoo.com/documentation/master/contributing/documentation/rst_guidelines.html

Example of a numbered list starting with a specific number (6) and then using autonumbering.

```reStructuredText
6. Use this format to start the numbering
   with a number other than one.
#. The numbering is automatic from there.

```

--------------------------------

### Populate CLI usage examples

Source: https://www.odoo.com/documentation/master/developer/reference/backend/populate.html

Examples of running the populate command with various options: scaling, fixed seed, resuming sessions, and profiling.

```bash
# Run a blueprint at 10x scale using all CPU cores
$ odoo-bin populate -d mydb -b project.fake_project_demo --scale 10 -j auto

# Run with a fixed seed for reproducibility
$ odoo-bin populate -d mydb -b my_module.my_blueprint --seed 42

# Resume the last interrupted session
$ odoo-bin populate -d mydb --resume

# Resume a specific session by ID
$ odoo-bin populate -d mydb --resume 7

# Save profiler traces for the generated workload
$ odoo-bin populate -d mydb -b project.fake_project_demo --profile

```

--------------------------------

### Install PostgreSQL on Fedora

Source: https://www.odoo.com/documentation/master/administration/on_premise/packages.html

Install and initialize PostgreSQL server on Fedora using dnf, then enable and start the service.

```bash
$ sudo dnf install -y postgresql-server
$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql

```

--------------------------------

### Directory Structure Example

Source: https://www.odoo.com/documentation/master/developer/reference/upgrades/upgrade_utils.html

Example directory structure for upgrade test files.

```text
myupgrades/
└── mymodule1/
    ├── 18.0.1.1.2/
    │   └── pre-myupgrade.py

```

--------------------------------

### start

Source: https://www.odoo.com/documentation/master/developer/reference/external_rpc_api.html

Creates a test database on demo.odoo.com and returns connection details (host, database, user, password).

```APIDOC
## start

### Description
Creates a test database on demo.odoo.com and returns connection details (host, database, user, password).

### Method
XML-RPC call

### Endpoint
https://demo.odoo.com/start

### Parameters
None

### Request Example
```python
import xmlrpc.client
info = xmlrpc.client.ServerProxy('https://demo.odoo.com/start').start()
```

### Response
#### Success Response
- **host** (string) - The URL of the Odoo server.
- **database** (string) - The name of the test database.
- **user** (string) - The username for authentication.
- **password** (string) - The password for authentication.

#### Response Example
```json
{
  "host": "https://example.odoo.com",
  "database": "testdb",
  "user": "admin",
  "password": "secret"
}
```
```

--------------------------------

### Install Odoo deb package on Ubuntu

Source: https://www.odoo.com/documentation/master/administration/on_premise/packages.html

Install the downloaded Odoo deb package as root. This installs Odoo as a service, creates the PostgreSQL user, and starts the server.

```bash
# apt update
# apt install <path_to_installation_package>

```

--------------------------------

### Launch Odoo server with odoo-bin

Source: https://www.odoo.com/documentation/master/developer/tutorials/setup_guide.html

Starts the Odoo server with the specified add-ons path and database. Use the -d option to select the database and --addons-path to list module directories.

```bash
$ cd $HOME/src/odoo/
$ ./odoo-bin --addons-path="addons/,../enterprise/,../tutorials" -d rd-demo

```

--------------------------------

### Install modules with odoo-bin module install

Source: https://www.odoo.com/documentation/master/developer/reference/cli.html

Installs the specified modules immediately. The Odoo database must already be created and initialized on PostgreSQL, for example using the db init command.

```bash
$ odoo-bin module install <modules>

```

--------------------------------

### Install Odoo rpm package on Fedora

Source: https://www.odoo.com/documentation/master/administration/on_premise/packages.html

Install the downloaded Odoo rpm package using dnf localinstall, then enable and start the service.

```bash
$ sudo dnf localinstall odoo_master.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo

```

--------------------------------

### Subscribe to WEB_CLIENT_READY event on env.bus

Source: https://www.odoo.com/documentation/master/developer/reference/frontend/framework_overview.html

Shows how to listen for a global event on the env.bus. The example subscribes to the WEB_CLIENT_READY event, which is triggered when the web client has been mounted.

```javascript
// for example, in some service code:
env.bus.on("WEB_CLIENT_READY", null, doSomething);

```

--------------------------------

### Install upgrade-util via --upgrade-path, pip, or requirements.txt

Source: https://www.odoo.com/documentation/master/developer/reference/upgrades/upgrade_utils.html

Install the upgrade-util library by cloning the repository and prepending its src directory to the --upgrade-path option, or via pip. On Odoo.sh, add the odoo_upgrade line to requirements.txt.

```bash
$ ./odoo-bin --upgrade-path=/path/to/upgrade-util/src,/path/to/other/upgrade/script/directory [...]
```

```bash
$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master
```

```text
odoo_upgrade @ git+https://github.com/odoo/upgrade-util@master
```

--------------------------------

### Example of a field declaration with generator attributes

Source: https://www.odoo.com/documentation/master/developer/reference/backend/populate.html

Shows a `<field/>` declaration using the `scalar.integer` generator with start, end, and distribution attributes. This is the only code example on the page.

```xml
<field name="age" generator="scalar.integer" start="18" end="65"
       distribution="normal(mean=35, std=12)"/>

```

--------------------------------

### report_with_list example

Source: https://www.odoo.com/documentation/master/developer/reference/upgrades/upgrade_utils.html

Example usage of report_with_list to report a list of records. It uses cr.rowcount and cr.fetchmany(20) to get data, then calls util.report_with_list with summary, data, columns, row_format, links, total, and category.

```python
total = cr.rowcount
data = cr.fetchmany(20)
util.report_with_list(
    summary="The following records were altered.",
    data=data,
    columns=("id", "name", "city", "comment", "company_id", "company_name"),
    row_format="Partner with id {partner_link} works at company {company_link} in {city}, ({comment})",
    links={"company_link": ("res.company", "company_id", "company_name"), "partner_link": ("res.partner", "id", "name")},
    total=total,
    category="Accounting"
)

```

--------------------------------

### Initialize a database with odoo-bin db init

Source: https://www.odoo.com/documentation/master/developer/reference/cli.html

Initializes a new database and installs the base module. The database name is required. Use --with-demo to install demo data, --force to delete an existing database first, and --country, --language, --username, and --password to set the main company country, default language (en_US), and default admin credentials.

```shell
$ odoo-bin db init <database>

```

--------------------------------

### Use setup instead of constructor in Owl component

Source: https://www.odoo.com/documentation/master/developer/reference/frontend/owl_components.html

Owl components should use the setup method for initialization instead of the constructor, which is not overridable in JavaScript. The example shows both the correct usage and the incorrect usage to avoid.

```javascript
// correct:
class MyComponent extends Component {
    setup() {
        // initialize component here
    }
}

// incorrect. Do not do that!
class IncorrectComponent extends Component {
    constructor(parent, props) {
        // initialize component here
    }
}

```

--------------------------------

### Applying Extensions Separately (Valid Example)

Source: https://www.odoo.com/documentation/master/developer/reference/frontend/patching_code.html

Demonstrates the correct approach: patch the base extension first, then a new extension that does not copy from the first one.

```javascript
const valid_ext2 = {
  method2() {
    super.method2();
    doOtherThings();
  },
};

patch(object, ext1); // first patch base extension
patch(object, valid_ext2); // then the new one
object.method1(); // works as expected
```
Tokens:
Raw