Setup Odoo 17 in Pycharm Community Edition

Setup Odoo 17 In Pycharm 

To set up Odoo 17 in PyCharm Community Edition for development and debugging, follow these detailed steps:

 Prerequisites    

• Install Odoo 17: Ensure that Odoo 17 is installed on your local machine. If not, you can follow Odoo installation instructions to set it up. 
  

• Install Python 3.8+: Odoo 17 requires Python 3.8 or higher.
  
• Install PostgreSQL: Ensure PostgreSQL is installed and running.
• Install PyCharm Community Edition: Download and install PyCharm from here.

 Step-by-Step Process:

         1. Clone Odoo 17 Source Code:

                   git clone https://github.com/odoo/odoo.git -b 17.0 --depth=1 cd odoo

 

 

         2. Set Up Virtual Environment:

                 

               It's best to work with a virtual environment to manage dependencies. 

              

                Navigate to your Odoo directory and create a virtual environment: 

                       

                          python3 -m venv odoo17-venv

                 Activate the virtual environment:  

                     On Linux/macOS:

                        source odoo17-venv/bin/activate

                     On Windows:

                         odoo17-venv\Scripts\activate
          

          3. Install Odoo Dependencies:

                With your virtual environment activated, install Odoo dependencies:

                 pip install -r requirements.txt

          This will install all the necessary Python packages that Odoo depends on.
 

         4. Install PostgreSQL Dependencies:

                  Install the required PostgreSQL packages:

                          sudo apt-get install postgresql libpq-dev

             
        5. Configure PostgreSQL for Odoo          

                 Create a PostgreSQL user for Odoo:

                         sudo -u postgres createuser -s odoo

                   Create a database (optional, if you need a new one):

                          sudo -u postgres createdb odoo_db

       

         6. Configure PyCharm Project:

              

                Open PyCharm and choose "Open" to select the Odoo 17 directory as the project.

               Configure the Python interpreter:

               1. Go to File > Settings > Project: [Project Name] > Python Interpreter 
                

               2. Click the gear icon next to the interpreter and select "Add".
             

               3. Choose Existing environment and browse for the python  executable in  your virtual environment (odoo17-venv/bin/python).
 

                4. Apply the changes.

 

        7. Add Odoo Configuration File (odoo.conf)

                  In the root of your Odoo directory, create an odoo.conf file:

                 [options]

addons_path = addons,custom_addons
db_host = localhost
db_port = 5432
db_user = odoo
db_password = odoo_password
db_name = odoo_db
logfile = odoo.log

                 Ensure that the addons_path is pointing to the directories where your    custom  and default addons are located.

8. Configure Run/Debug Configuration in PyCharm

1. Go to Run > Edit Configurations.
2. Click the + icon to add a new configuration, then choose Python.
3. Configure it as follows:
   • Name: Odoo 17
   • Script Path: Choose the odoo-bin file from the Odoo directory (e.g., ~/odoo/odoo-bin).
   • Parameters: Add necessary startup parameters like:

     -c odoo.conf             

Python Interpreter: Select the virtual environment you created earlier.

Working Directory: Set the Odoo project folder as the working directory.

 

9. Install Required Odoo Modules

       Start your Odoo instance with:

                 python odoo-bin -c odoo.conf

       Navigate to localhost:8069 in your browser to access Odoo, set up the database, and install the necessary modules for development.

10. Debugging Odoo in PyCharm

• Set breakpoints in the Python files you want to debug.
• To debug, select the Odoo 17 run configuration you created, and click the Debug button (the bug icon).
• PyCharm will stop execution at your breakpoints, allowing you to inspect variables, step through the code, and diagnose issues.

11. Optional: External Python Packages

          If your development requires additional Python packages, install them using:

                  pip install <package_name>

Troubleshooting Tips:

• Database Access Issues: Ensure that the PostgreSQL server is running and the user/database configuration in odoo.conf matches your PostgreSQL setup.
• Dependency Issues: Double-check the Python version and the libraries in requirements.txt.
• Port Conflicts: If another service is using port 8069, change the port in odoo.conf:

                                xmlrpc_port = 8070

By following these steps, you will have Odoo 17 set up in PyCharm Community Edition for development and debugging purposes.