Skip to content

Useful Odoo scripts and utility functions, based on click-odoo

License

Notifications You must be signed in to change notification settings

MindAndGo/click-odoo-contrib

 
 

Repository files navigation

click-odoo-contrib

License: LGPL-3

click-odoo-contrib is a set of useful Odoo maintenance functions. They are available as CLI scripts (based on click-odoo), as well as composable python functions.

Usage: click-odoo-copydb [OPTIONS] SOURCE DEST

  Create an Odoo database by copying an existing one.

  This script copies using postgres CREATEDB WITH TEMPLATE. It also copies
  the filestore.

Options:
  -c, --config FILE       ...
  ...
  -f, --force-disconnect  Attempt to disconnect users from the template
                          database.
  --unless-dest-exists    Don't report error if destination database already
                          exists.
  --if-source-exists      Don't report error if source database does not
                          exist.
  --filestore-copy-mode   [default|rsync|hardlink]
                          Mode for copying the filestore. Default uses
                          python shutil copytree which copies
                          everything. If the target filestore already
                          exists and just needs an update you can use
                          rsync to rsync the filestore instead. If both
                          filestores are on the same filesystem supporting
                          hardlinks you can use the option hardlink to hard
                          link the files to the inodes of the files of the
                          source directory which saves on space on the disk.
  --help                  Show this message and exit.
Usage: click-odoo-dropdb [OPTIONS] DBNAME

  Drop an Odoo database and associated file store.

Options:
  -c, --config FILE  ...
  ...
  --if-exists        Don't report error if database doesn't exist.
  --help             Show this message and exit.
Usage: click-odoo-initdb [OPTIONS]

  Create an Odoo database with pre-installed modules.

  Almost like standard Odoo does with the -i option, except this script
  manages a cache of database templates with the exact same addons
  installed. This is particularly useful to save time when initializing test
  databases.

  Cached templates are identified by computing a sha1 checksum of modules
  provided with the -m option, including their dependencies and
  corresponding auto_install modules.

Options:
  -c, --config FILE         ...
  ...
  -n, --new-database TEXT   Name of new database to create, possibly from
                            cache. If absent, only the cache trimming
                            operation is executed.
  -m, --modules TEXT        Comma separated list of addons to install.
                            [default: base]
  --demo / --no-demo        Load Odoo demo data.  [default: True]
  --cache / --no-cache      Use a cache of database templates with the exact
                            same addons installed. Disabling this option also
                            disables all other cache-related operations such
                            as max-age or size. Note: when the cache is
                            enabled, all attachments created during database
                            initialization are stored in database instead of
                            the default Odoo file store.  [default: True]
  --cache-prefix TEXT       Prefix to use when naming cache template databases
                            (max 8 characters). CAUTION: all databases named
                            like {prefix}-____________-% will eventually be
                            dropped by the cache control mechanism, so choose
                            the prefix wisely.  [default: cache]
  --cache-max-age INTEGER   Drop cache templates that have not been used for
                            more than N days. Use -1 to disable.  [default:
                            30]
  --cache-max-size INTEGER  Keep N most recently used cache templates. Use -1
                            to disable. Use 0 to empty cache.  [default: 5]
  --unless-exists           Don't report error if database already exists.
  --help                    Show this message and exit.
Usage: click-odoo-backupdb [OPTIONS] DBNAME DEST

  Create an Odoo database backup.

  This script dumps the database using pg_dump. It also copies the filestore.

  Unlike Odoo, this script allows you to make a backup of a database without
  going through the web interface. This avoids timeout and file size
  limitation problems when databases are too large.

  It also allows you to make a backup directly to a directory. This type of
  backup has the advantage that it reduces memory consumption since the
  files in the filestore are directly copied to the target directory as well
  as the database dump.

Options:
  -c, --config FILE           ...
  ...
  --force                       Don't report error if destination file/folder
                                already exists.  [default: False]

  --if-exists                   Don't report error if database does not exist.
  --format [zip|dump|folder]    Output format  [default: zip]
  --filestore / --no-filestore  Include filestore in backup  [default: True]
  --help                        Show this message and exit.
Usage: click-odoo-restoredb [OPTIONS] DBNAME SOURCE

  Restore an Odoo database backup.

  This script allows you to restore databses created by using the Odoo web
  interface or the backupdb script. This avoids timeout and file size
  limitation problems when databases are too large.

Options:
  -c, --config FILE  ...
  ...
  --copy / --move    This database is a copy. In order to avoid conflicts
                     between databases, Odoo needs to know if thisdatabase was
                     moved or copied. If you don't know, set is a copy.

  --force            Don't report error if destination database already
                     exists. If force and destination database exists, it will
                     be dropped before restore.  [default: False]

  --jobs INTEGER     Uses this many parallel jobs to restore. Only used to
                     restore folder format backup.

  --help             Show this message and exit.
Usage: click-odoo-makepot [OPTIONS]

  Export translation (.pot) files of addons installed in the database and
  present in addons_dir. Additionally, run msgmerge on the existing .po
  files to keep them up to date. Commit changes to git, if any.

Options:
  -c, --config FILE           ...
  -d, --database TEXT         ...
  ...
  --addons-dir TEXT           [default: .]
  -m, --modules TEXT          Comma separated list of addons to export
                              translation.
  --msgmerge / --no-msgmerge  Merge .pot changes into all .po files
                              [default: False]
  --msgmerge-if-new-pot / --no-msg-merge-if-new-pot
                              Merge .pot changes into all .po files, only
                              if a new .pot file has been created.
                              [default: False]
  --fuzzy-matching /  --no-fuzzy-matching
                              Use fuzzy matching when merging .pot changes
                              into .po files.
                              Only applies when --msgmerge
                              or --msgmerge-if-new-pot are passed.
                              [default: True]
  --purge-old-translations /  --no-purge-old-translations
                              Remove comment lines containing old
                              translations from .po files.
                              Only applies when --msgmerge
                              or --msgmerge-if-new-pot are passed.
                              [default: False]
  --commit / --no-commit      Git commit exported .pot files if needed.
                              [default: False]
  --help                      Show this message and exit.
Usage: click-odoo-uninstall [OPTIONS]

Options:
  -c, --config PATH    ...
  -d, --database TEXT  ...
  ...
  -m, --modules TEXT   Comma-separated list of modules to uninstall
                       [required]
  --help               Show this message and exit.
Usage: click-odoo-update [OPTIONS]

  Update an Odoo database (odoo -u), automatically detecting addons to
  update based on a hash of their file content, compared to the hashes
  stored in the database.

  It allows updating in parallel while another Odoo instance is still
  running against the same database, by using a watcher that aborts the
  update in case a DB lock happens.

Options:
  -c, --config FILE            Specify the Odoo configuration file. Other ways
                               to provide it are with the ODOO_RC or
                               OPENERP_SERVER environment variables, or
                               ~/.odoorc (Odoo >= 10) or ~/.openerp_serverrc.
  --addons-path TEXT           Specify the addons path. If present, this
                               parameter takes precedence over the addons path
                               provided in the Odoo configuration file.
  -d, --database TEXT          Specify the database name. If present, this
                               parameter takes precedence over the database
                               provided in the Odoo configuration file.
  --log-level TEXT             Specify the logging level. Accepted values
                               depend on the Odoo version, and include debug,
                               info, warn, error.  [default: info]
  --logfile FILE               Specify the log file.
  --i18n-overwrite             Overwrite existing translations
  --update-all                 Force a complete upgrade (-u base)
  --ignore-addons TEXT         A comma-separated list of addons to ignore.
                               These will not be updated if their checksum has
                               changed. Use with care.
  --ignore-core-addons         If this option is set, Odoo CE and EE addons
                               are not updated. This is normally safe, due the
                               Odoo stable policy.
  --if-exists                  Don't report error if database doesn't exist
  --watcher-max-seconds FLOAT  Max DB lock seconds allowed before aborting the
                               update process. Default: 0 (disabled).
  --list-only                  Log the list of addons to update without
                               actually updating them.
  --help                       Show this message and exit.

To run tests, type tox. Tests are made using pytest. To run tests matching a specific keyword for, say, Odoo 12 and python 3.6, use tox -e py36-12.0 -- -k keyword. For running tests you need a postgres server accessible for your user without a password at /var/run/postgresql/.s.PGSQL.5432.

This project uses black as code formatting convention, as well as isort and flake8. To make sure local coding convention are respected before you commit, install pre-commit and run pre-commit install after cloning the repository.

Contributors:

ACSONE SA/NV

This project is maintained by ACSONE SA/NV.

About

Useful Odoo scripts and utility functions, based on click-odoo

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%