This is a template repository for development of modules in Odoo Community version.
To develop locally for this project, you need to pare your local setup. To do this, you just need to do a few things:
- update(if needed) the environment variable PROJECT_CODE, see the environment section for more details.
- run the following command to prepare your dev tools
./dev/setup.sh
- launch the docker containers to run the project
docker-compose up
This will create and run 3 containers:
- odoo: odoo server running under http://localhost:8069
- postgres: database server
- pgadmin: database administration tool running under http://localhost:8099
After docker finish the initialization of the containers, you can open a browser and go to http://localhost:8069 to start using odoo
This project uses git submodules to handle dependencies and track third party repos. They are tracked inside addons_repos_ext directory and initialized as part of the setup procedure described before but in case you need to get changes on the submodules repos you can use the following command.
git submodule update --recursiveFollow this doc more info on submodule.
Format for submodule code is:
git submodule add -b <branch> --depth 1 <git@yourprovider.com>:<username/repository.git> <path>Let's see how you can add l10n-germany and its dependency repos from oca as submodules.
- Go to project root directory
git submodule add -b 14.0 --depth 1 git@github.com:OCA/l10n-germany.git external-repos/OCA/.l10n-germany
git submodule add -b 14.0 --depth 1 git@github.com:OCA/partner-contact.git external-repos/OCA/.partner-contactLet's add l10n_de_country_states module and its dependency to our external-addons folder.
cd addons_ext
ln -s ../external-repos/OCA/.l10n-germany/l10n_de_country_states ./l10n_de_country_states
ln -s ../external-repos/OCA/.partner-contact/base_country_state_translatable ./base_country_state_translatableAnd now commit your changes.
git commit -a && git push -u <remote> <branch>Replace
<remote>by the repository on which you want to push your changes. For a standard Git setup, this is origin.<branch>by the branch on which you want to push your changes. Most likely the branch you used git checkout on in the first step.
If you’re adding a repository that contains a lot of modules, you may want to ignore some of them in case there are any that are installed automatically. To do so, you can prefix your submodule folder with a .. The platform will ignore this folder and you can hand pick your modules by creating symlinks to them from another folder.
Just to avoid any time wasting in a team who has different OSs. The symlinks created from either mac or linux system works in all but windows system. On the other hand, the symlinks created in windows system works only in itself.
To get direct access to the database content you can use the pgadmin tool with the following credentials
- url: http://localhost:8099
- user: dev@example.com
- password: 1234
Once you have logged in, you will see the Odoo server, if you are prompt for the password, type odoo
If you need to change any of the default configurations of the docker setup you can create a .env file in the root of the project and set the environment variables according to your needs.
- ODOO_PORT: to change the port where odoo will be running (default 8069)
- PGADMIN_PORT: to change the port where pgadmin will be running (default 8099)
- PROJECT_CODE: to define the string used to identify tickets of the project. This will be used to check git branches names and commit messages.
Just remember to rebuild the containers after changes the environment variables, for the changes to take effect.
You can change odoo configurations using the config file in config/odoo.conf.
Access into the pgadmin container if you want to import or export your configurations:
docker exec -it pgadmin sh
Access into the Odoo container:
docker exec -it odoo bash
To run unit tests of your code you can use the following command sequence:
docker-compose up -d
docker-compose stop
And then, if you want to test your module in a clean database you can use:
docker-compose run odoo --test-enable --stop-after-init -d new_database_name -i module_name
Otherwise, you can use the following:
docker-compose run odoo --test-enable --stop-after-init -d database_name -u module_name
$ pip install pre-commit
$ brew install pre-commit
$ pre-commit --version
pre-commit 2.10.0
$ pre-commit install
pre-commit run --all-files
To run pdb just run docker exec TEST-ODOO. Here put either container name or id.
If you are using Visual Studio Code you will be able to debug following this steps
- Create a launch.json file with the following configuration
{
"version": "0.2.0",
"configurations": [
{
"name": "Odoo: Attach",
"type": "python",
"request": "attach",
"port": 8879,
"debugServer": 8888,
"host": "localhost",
"pathMappings": [
{
"localRoot": "${workspaceFolder}/addons",
"remoteRoot": "/mnt/addons_custom", //path to custom addons inside docker
},
{
"localRoot": "${workspaceFolder}/addons_ext",
"remoteRoot": "/mnt/addons_ext", //path to external addons inside docker
}
],
"logToFile": true
}
]
}- Run docker with the following command sequence
docker-compose up -d
docker-compose stop
docker-compose run --rm -p 8888:3001 -p 8069:8069 odoo /usr/bin/python3 -m debugpy --listen 0.0.0.0:3001 /usr/bin/odoo --db_user=odoo --db_host=db --db_password=odoo
- Use the debug button in vscode