Skip to content
Snippets Groups Projects
Select Git revision
  • branch/default default protected
  • topic/default/odoo-16-17-broken-websocket
  • topic/default/docker_translate
  • topic/default/jingtrang
  • topic/default/buildkit
  • topic/default/force-compilation-option
  • topic/default/more-mypy
  • topic/default/TG-407
  • topic/default/slower-ci
  • topic/default/Odoo-13.0
  • topic/default/flake8_error
  • topic/default/py3o
  • 10.0.0
  • 10.0.1
  • 11.0.0
  • 11.0.1
  • 11.1.0
  • 12.0.0
  • 12.0.1
  • 13.0.0
  • 13.1.0
  • 13.2.0
  • 13.3.0
  • 14.0.0
  • 15.0.0
  • 15.1.0
  • 15.2.0
  • 15.2.1
  • 15.3.0
  • 15.3.1
  • 16.0.0
  • 16.1.0
  • 16.10.0
  • 16.2.0
  • 16.3.0
  • 16.4.0
  • 16.5.0
  • 16.5.1
  • 16.6.0
  • 16.7.0
  • 16.7.1
  • 16.7.2
  • 16.7.3
  • 16.8.0
  • 16.8.1
  • 16.9.0
  • 17.0.0
  • 17.1.0
  • 18.0.0
  • 18.0.1
  • 18.1.0
  • 19.0.0
  • 19.0.0.post1
  • 19.0.1
  • 19.0.2
  • 19.1.0
  • 20.0.0
  • 20.0.1
  • 20.1.0
  • 20.10.0
  • 20.10.1
  • 20.11.0
  • 20.12.0
  • 20.12.1
  • 20.12.2
  • 20.13.0
  • 20.14.0
  • 20.2.0
  • 20.3.0
  • 20.3.1
  • 20.4.0
  • 20.5.0
  • 20.5.1
  • 20.6.0
  • 20.7.0
  • 20.8.0
  • 20.8.1
  • 20.8.2
  • 20.9.0
  • 21.0.0
  • 21.0.1
  • 21.0.2
  • 21.0.3
  • 21.0.4
  • 21.0.5
  • 21.0.6
  • 21.0.7
  • 21.0.8
  • 21.1.0
  • 21.10.0
  • 21.10.1
  • 21.10.2
  • 21.11.0
  • 21.12.0
  • 21.13.0
  • 21.14.0
  • 21.14.1
  • 21.14.2
  • 21.14.3
  • 21.15.0
  • 21.15.1
  • 21.15.2
  • 21.16.0
  • 21.16.1
  • 21.2.0
  • 21.2.1
  • 21.2.2
  • 21.2.3
  • 21.2.4
  • 21.3.0
  • 21.4.0
  • 21.4.1
  • 21.5.0
  • 21.5.1
  • 21.6.0
  • 21.7.0
  • 21.7.1
  • 21.7.2
  • 21.7.3
  • 21.8.0
  • 21.8.1
  • 21.8.2
  • 21.8.3
  • 21.9.0
  • 21.9.1
  • 22.0.0
  • 22.0.1
  • 23.0.0
  • 23.0.1
  • 23.0.2
  • 23.1.0
  • 23.2.0
  • 23.3.0
  • 23.4.0
  • 23.4.1
  • 23.4.2
  • 23.5.0
  • 24.0.0
  • 24.1.0
  • 24.2.0
  • 3.1
  • 3.2
  • 3.3
  • 4.0
  • 4.1
  • 4.2.0
  • 4.2.1
  • 5.0.0
  • 6.0.0
  • 7.0.0
  • 7.0.1
  • 7.0.2
  • 7.0.3
  • 7.0.4
  • 7.0.5
  • 8.0.0
  • 8.0.1
  • 9.0.0
  • 9.0.1
159 results
Blame Permalink
README.rst 12.49 KiB

Odoo Scripts

Installation

Most commands can be run directly or with the image build from Dockerfile (xcgd/odoo_scripts) by indicating the command to run, but the best way to use this module is to install it. Installing will also install dependencies.

pip need to be more recent than version 10.0 to use it to install.

The recommend way to install this module is to run python3 -m pip install odoo_scripts==19.0.2 --extra-index-url https://orus.io/api/v4/groups/9/-/packages/pypi/simple.

Some scripts are in other sections, because they need some specialized library, in that case you need to indicate the name of section as in python3 -m install "odoo_scripts[docker]==19.0.2" --extra-index-url https://orus.io/api/v4/groups/9/-/packages/pypi/simple. The prerequisites for this module or one of its section can be installed by using pip3 or the package manager; the requirements are defined in pyproject.toml.

To upgrade Odoo scripts, just add --upgrade to the end of the command.

It can also be cloned before running python3 -m pip install . in the clone directory, and with pip version 21.3+ and a recent setuptools, it can use the cloned repository by adding --editable/-e.

Important

As there is no way of indicating sections (worse, it is handling them incorrectly), do not use python3 setup.py install.

Note that shell scripts are not installed, as they are meant to be replaced with more easily maintanable python scripts.

Scripts

Those scripts are available when installing the package, and can also be run directly.

docker_black

Run dockerized black on provided directory. black must be present in the project image.

This is part of the docker section.

docker_build_doc

Build documentation in docker. It runs make html so could potentially be used to do something else.

This is part of the docker section.

docker_isort

Run dockerized isort on current directory. This uses a configuration file that is adapted to OCA guidelines for imports.

This is part of the docker section.

docker_pylint

Run dockerized pylint on provided module name. Pylint must be present in the project image.

This is part of the docker section.

docker_prettier

Run dockerized prettier on provided directory. prettier must be present in the project image.

This is part of the docker section.

conf2reST.py

This script is used to produce a reST file from setup.cfg, the Dockerfile and the .hgconf/nest.yaml file.

When the package is installed, the executable for this script is conf2reST. This is part of the conf2reST section.

update_duplicate_sources.py

This script will update a project that only contain the sources of the one it is launched from.

It expect the configuration file (setup.cfg) to have the following keys:

  • modules: list of directories and files to include (also used by another script)
  • dependencies: list of directories and files to include (also used by another script)
  • other_sources: list of directories and files to include (only used by this script, used for README, ReleaseNotes, script directories, etc.)
  • duplicate_repo: target repository, if none are specified, uses the same URL and append _sources to it.

No change are made to the name of the directories/files included.

When the package is installed, the executable for this script is update_duplicate_sources. This is part of the source_control section.

docker_dev_start.py

This script starts an odoo from a docker but with the local addons modules mounted, and eventually a local copy of the odoo sources mounted too.

Using it avoids having to create a virtual environment for every project.

Prerequisites:

  • Your user needs to be in the docker group.

  • It expects the configuration file to have the following keys:

    modules

    list of directories and files to include

    …

    …

When the package is installed, the executable for this script is docker_dev_start. This is part of the docker section.

docker_pg.py

This script start a postgresql server the same way docker_dev_start.py does.

By default it provides an interactive psql shell, but can also be used to run SQL commands, use an interactive shell or a shell command.

Prerequisites:

  • Your user needs to be in the docker group.
  • It uses the configuration file’s keys: postgresql_version.

This is part of the docker section.

docker_rednerd.py

This script is used to start a rednerd server.

It runs the migration on the database before setting values if provided the argument to do so while the server is live.

Prerequisites:

  • Your user needs to be in the docker group.
  • It uses the configuration file’s keys: rednerd_repository and rednerd_version (defaults to latest).

This is part of the docker section. When the package is installed, the executable for this script is docker_rednerd.

docker_build.py

This script builds a docker image of the project.

It uses the super project’s setup.cfg and Dockerfile.

When the package is installed, the executable for this script is docker_build. This is part of the docker section.

do_tests.py

This scripts launches the tests, but with more options than do_tests. It uses docker by default, similar to docker_dev_start.py.

When the package is installed, the executable for this script is do_tests.

import_base_import and import_jsonrpc

Import CSV files into an odoo.

import_base_import uses odoo base_import module to import the CSV file.

import_jsonrpc uses jsonrpc calls to import the files. The format is the same as the one used with the import module, with a couple more restrictions: