OdooLS for PyCharm

Language server support for Odoo projects in PyCharm.

This PyCharm plugin integrates the OdooLS language server for Odoo projects.

It provides advanced language features, including:

• Hover information

• Go to definition

• Autocompletion

• Diagnostics

For installation instructions and configuration details, see the OdooLS

Installation

Warning: OdooLS for PyCharm is only available in "unified version" of PyCharm. If you use the Community Edition, you have to update your program to the unified version (it's free and will be automatic starting from 2025.3). See https://blog.jetbrains.com/pycharm/2025/04/unified-pycharm/

• Using the IDE built-in plugin system (Soon):

  Settings/Preferences > Plugins > Marketplace > Search for "OdooLS-Pycharm" > Install

• Using JetBrains Marketplace (Soon):

  Go to JetBrains Marketplace and install it by clicking the Install to ... button in case your IDE is running.

  You can also download the latest release from JetBrains Marketplace and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

• Manually:

  Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Build the plugin manually

To build the plugin, first clone the repository and setup the submodules:

$ git clone git@github.com:odoo/odoo-ls-pycharm.git
$ cd odoo-ls-pycharm
$ git submodule init
$ git submodule update

Then retrieve an actual changelog to replace the placeholder:

$ curl -o CHANGELOG.md https://raw.githubusercontent.com/odoo/odoo-ls/refs/heads/release/changelog.md

Then put OdooLs binaries (and .pdb for windows) in src/main/resources/odools-binaries.

Finally, you can launch ./gradlew clean buildPlugin. Note that as of this writing you need at least the JRE 17.

Your plugin will be in build/distributions

---

Plugin based on the IntelliJ Platform Plugin Template.