{"id":16669226,"url":"https://github.com/katyukha/odoo-helper-scripts","last_synced_at":"2025-04-07T05:14:31.756Z","repository":{"id":32252113,"uuid":"35826459","full_name":"katyukha/odoo-helper-scripts","owner":"katyukha","description":"The easiest way to install and manage development odoo instances / projects.","archived":false,"fork":false,"pushed_at":"2025-03-24T19:54:04.000Z","size":1486,"stargazers_count":75,"open_issues_count":1,"forks_count":23,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-31T04:06:43.645Z","etag":null,"topics":["install","install-script","odoo","odoo-10","odoo-11","odoo-12","odoo-13","odoo-14","odoo-15","odoo-16","odoo-17","odoo-8","odoo-9","odoo-development","odoo-helper","odoo-install","odoo-installation","odoo-installs","odoo-scripts","openerp"],"latest_commit_sha":null,"homepage":"https://katyukha.gitlab.io/odoo-helper-scripts/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"saandeep/apijam","license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/katyukha.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-18T15:37:20.000Z","updated_at":"2025-03-26T12:37:52.000Z","dependencies_parsed_at":"2023-01-14T20:50:38.566Z","dependency_job_id":"2c77a0a2-8fd8-400f-9c09-9fe03d71b86f","html_url":"https://github.com/katyukha/odoo-helper-scripts","commit_stats":null,"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katyukha%2Fodoo-helper-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katyukha%2Fodoo-helper-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katyukha%2Fodoo-helper-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katyukha%2Fodoo-helper-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/katyukha","download_url":"https://codeload.github.com/katyukha/odoo-helper-scripts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595335,"owners_count":20963943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["install","install-script","odoo","odoo-10","odoo-11","odoo-12","odoo-13","odoo-14","odoo-15","odoo-16","odoo-17","odoo-8","odoo-9","odoo-development","odoo-helper","odoo-install","odoo-installation","odoo-installs","odoo-scripts","openerp"],"created_at":"2024-10-12T11:30:32.236Z","updated_at":"2025-04-07T05:14:31.733Z","avatar_url":"https://github.com/katyukha.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Odoo helper scripts collection\n\n| Master        | [![pipeline status](https://gitlab.com/katyukha/odoo-helper-scripts/badges/master/pipeline.svg)](https://gitlab.com/katyukha/odoo-helper-scripts/commits/master) |  [![coverage report](https://gitlab.com/katyukha/odoo-helper-scripts/badges/master/coverage.svg)](https://gitlab.com/katyukha/odoo-helper-scripts/commits/master)| [![CHANGELOG](https://img.shields.io/badge/CHANGELOG-master-brightgreen.svg)](https://gitlab.com/katyukha/odoo-helper-scripts/blob/master/CHANGELOG.md)              |\n| ------------- |:---------------|:--------------|:------------|\n| Dev           | [![pipeline status](https://gitlab.com/katyukha/odoo-helper-scripts/badges/dev/pipeline.svg)](https://gitlab.com/katyukha/odoo-helper-scripts/commits/dev) | [![coverage report](https://gitlab.com/katyukha/odoo-helper-scripts/badges/dev/coverage.svg)](https://gitlab.com/katyukha/odoo-helper-scripts/commits/dev) | [![CHANGELOG](https://img.shields.io/badge/CHANGELOG-dev-yellow.svg)](https://gitlab.com/katyukha/odoo-helper-scripts/blob/dev/CHANGELOG.md) |\n\n## Overview\n\nThis project aims to simplify development process of Odoo addons as much as possible.\n\nodoo-helper-scripts will do all routine operations for you:\n- install odoo with ALL dependencies (even those not mentioned in odoo's requirements.txt like [python-slugify](https://pypi.org/project/python-slugify/))\n- manage local development databases\n- install custom addons\n- check if versions of modules are updated before pushing changes.\n- generate / regenerate translations\n- run tests\n- and a lot more\n\nIf you have any routine operation that you would like to automate with odoo-helper-scripts,\njust fill an issue or do pull request, and may be that feature will be available in one of next releases.\n\n***WARNING***: If you want to deploy production-ready odoo server,\nplease, read carefully [Usage notes](#usage-note) section.\n\n## The War in Ukraine\n\n2022-02-24 Russia invaded Ukraine...\n\nIf you want to help or support Ukraine to stand against russian inavasion,\nplease, visit [the official site of Ukraine](https://war.ukraine.ua/)\nand find the best way to do it.\n\nThanks.\n\n## Canonical source\n\nThe canonical source of odoo-helper-scripts is hosted on [GitLab](https://gitlab.com/katyukha/odoo-helper-scripts).\n\n## Features\n\n- Easily manage multiple instances of Odoo that ran on same machine\n- Wide usage of [virtualenv](https://virtualenv.pypa.io/en/stable/) for isolation purpose\n- Use [nodeenv](https://pypi.python.org/pypi/nodeenv) to install [node.js](https://nodejs.org/en/), [phantom.js](http://phantomjs.org/), etc in isolated [virtualenv](https://virtualenv.pypa.io/en/stable/)\n- The easiest way to install Odoo for development purposes (but not limited to development)\n    - single command to install odoo\n    - ability to build custom python for odoo\n- Powerful testing capabilities, including support for:\n    - *python* and *js* code check via [pylint\\_odoo](https://pypi.python.org/pypi/pylint-odoo) (which uses [ESLint](https://eslint.org/) to check JS files)\n    - *python* code check via [flake8](https://pypi.python.org/pypi/flake8)\n    - styles (*.css*, *.scss*, *.less* files) check via [stylelint](https://stylelint.io/)\n    - compute test code coverage via [coverage.py](https://coverage.readthedocs.io)\n    - Test web tours via [phantom.js](http://phantomjs.org/) or *chromium browser* (Odoo 12.0+)\n- Easy addons installation\n    - Automatiacly resolve and fetch dependencies\n        - oca\\_dependencies.txt ([sample](https://github.com/OCA/maintainer-quality-tools/blob/master/sample_files/oca_dependencies.txt), [mqt tool code](https://github.com/OCA/maintainer-quality-tools/blob/master/sample_files/oca_dependencies.txt))\n        - [requirements.txt](https://pip.readthedocs.io/en/stable/user_guide/#requirements-files)\n    - Own file format to track addon dependencies: [odoo\\_requirements.txt](https://katyukha.gitlab.io/odoo-helper-scripts/odoo-requirements-txt/)\n    - installation directly from [Odoo Market](https://apps.odoo.com/apps) (**experimental**)\n        - Only free addons\n        - Including dependencies\n        - Semi-automatic upgrade when new version released\n    - installation from *git* repositories\n    - installation of python dependencies from [PyPI](pypi.python.org/pypi) or any [vcs supported by setuptools](https://setuptools.readthedocs.io/en/latest/setuptools.html?highlight=develop%20mode#dependencies-that-aren-t-in-pypi)\n    - automatically processing of [requirements.txt](https://pip.pypa.io/en/stable/user_guide/#requirements-files) files located inside repository root and addon directories.\n    - shortcuts that simplifies fetching addons from [OCA](https://github.com/OCA) or [github](https://github.com)\n    - works good with long recursive dependencies.\n      One of the reasons for this script collection development was,\n      ability to automaticaly install more that 50 addons,\n      that depend on each other, and where each addon have it's own git repo.\n- Easy database management\n    - easily create / drop / backup / rename / copy databases\n- Continious Integration related features\n    - ensure addon version changed\n    - ensure repository version changed\n    - ensure each addon have icon\n    - ensure all changed addon has correct versions\n    - simplify forward-port process (move changes from older serie to newer (for example from 11.0 to 12.0))\n- Translation management from command line\n    - import / export translations by command from shell\n    - test translation rate for specified language\n    - regenerate translations for specified language\n    - generate *.pot* files for modules\n    - load language (for one db or for old databases)\n- Supported odoo versions:\n    - *8.0*\n    - *9.0*\n    - *10.0*\n    - *11.0*\n    - *12.0*\n    - *13.0*\n    - *14.0*\n    - *15.0*\n    - *16.0*\n    - *17.0*\n    - *18.0* (**Experimental**)\n- OS support:\n    - On *Ubuntu* should work nice (auto tested on *Ubuntu 20.04, 22.04*)\n    - Also should work on *Debian* based systems, but some troubles may happen with installation of system dependencies.\n    - Other linux systems - in most cases should work, but system dependecies must be installed manualy.\n- Missed feature? [Fill an issue](https://gitlab.com/katyukha/odoo-helper-scripts/issues/new)\n\n\n## Documentation\n\n***Note*** Documentaion in this readme, or in other sources, may not be up to date!!!\nSo use ``--help`` option, which is available for most of commands.\n\n- [Documentation](https://katyukha.gitlab.io/odoo-helper-scripts/)\n- [Installation](https://katyukha.gitlab.io/odoo-helper-scripts/installation/)\n- [Frequently used commands](https://katyukha.gitlab.io/odoo-helper-scripts/frequently-used-commands/)\n- [Command Reference](https://katyukha.gitlab.io/odoo-helper-scripts/command-reference/)\n\n\n## Usage note\n\nThis script collection is designed to simplify life of addons developer.\nThis project ***is not designed, to install and configure production ready Odoo instances***, unless you know what you do!\n\nFor **production-ready** installations take a look at [crnd-deploy](http://github.com/crnd-inc/crnd-deploy) project - just a single command allows you to get production-ready odoo instance with configured [PostgreSQL](https://www.postgresql.org/) and [Nginx](https://nginx.org/).\n\nAlso take a look at [Yodoo Cockpit](https://crnd.pro/yodoo-cockpit) project, and discover the easiest way to manage your production Odoo installations with automated billing and support of custom addons.\n\n[![Yodoo Cockpit](https://crnd.pro/web/image/18846/banner_2_4_gif_animation_cut.gif)](https://crnd.pro/yodoo-cockpit)\n\nJust short notes about [Yodoo Cockpit](https://crnd.pro/yodoo-cockpit):\n- start new production-ready odoo instance in 1-2 minutes.\n- add custom addons to your odoo instances in 5-10 minutes.\n- out-of-the-box email configuration: just press button and add some records to your DNS, and get a working email\n- make your odoo instance available to external world (internet) in 30 seconds (just add single record in your DNS)\n\n\n## Level up your service quality\n\nLevel up your service quality with [Helpdesk](https://crnd.pro/solutions/helpdesk) / [Service Desk](https://crnd.pro/solutions/service-desk) / [ITSM](https://crnd.pro/itsm) solution by [CR\u0026D](https://crnd.pro/).\n\nJust test it at [yodoo.systems](https://yodoo.systems/saas/templates): choose template you like, and start working.\n\nTest all available features of [Bureaucrat ITSM](https://crnd.pro/itsm) with [this template](https://yodoo.systems/saas/template/bureaucrat-itsm-demo-data-95).\n\n\n## Installation\n\nFor full list of installation options look at [installation documentation](https://katyukha.gitlab.io/odoo-helper-scripts/installation/)\n\nBasically, odoo-helper could be installed in two way:\n- Traditional installation via shell script\n- Installation via deb package (still experimental)\n\n### Traditional installation\n\nTo install *odoo-helper-scripts* system-wide (the recommended way) do folowing:\n\n```bash\n# Install odoo-helper-scripts\nwget -O - https://gitlab.com/katyukha/odoo-helper-scripts/raw/master/install-system.bash | sudo bash -s\n\n# Install system dependencies required for odoo-helper-scripts\n# NOTE: Works only on debian-based systems\nodoo-helper install pre-requirements\n```\n\nor more explicit way:\n\n```bash\n# Download installation script\nwget -O /tmp/odoo-helper-install.bash https://gitlab.com/katyukha/odoo-helper-scripts/raw/master/install-system.bash;\n\n# Install odoo-helper-scripts\nsudo bash /tmp/odoo-helper-install.bash;\n\n#  Intall system pre-requirements for odoo-helper-scripts\n# NOTE: Works only on debian-based systems\nodoo-helper install pre-requirements\n```\n\n### Installation as deb package\n\nAlso, you can install *odoo-helper-scripts* as debian package. See [releases](https://gitlab.com/katyukha/odoo-helper-scripts/-/releases) page.\nTo install the latest **stable** version just download and install following deb package: [odoo-helper-scripts_master.deb](https://gitlab.com/api/v4/projects/6823247/packages/generic/odoo-helper-scripts/master/odoo-helper-scripts_master.deb)\n\n\n## Test your OS support\n\nIt is possible to run basic tests via docker.\nFor this task, odoo-helper-scripts repo contains script `scripts/run_docker_test.bash`.\nRun `bash scripts/run_docker_test.bash --help` to see all available options for that script.\n\nFor example to test, how odoo-helper-scripts will work on debian:stretch, do following:\n\n```bash\ncd $ODOO_HELPER_ROOT\nbash scripts/run_docker_test.bash --docker-ti --docker-image debian:stretch\n```\n\nNote, running tests may take more then 1:30 hours.\n\n\n## Usage\n\nAnd after install you will have available folowing scripts in your path:\n\n- odoo-install\n- odoo-helper\n\nEach script have `-h` or `--help` option which display most relevant information\nabout script and all possible options and subcommands of script\n\nAlso there are some aliases for common commands:\n\n- odoo-helper-addons\n- odoo-helper-db\n- odoo-helper-fetch\n- odoo-helper-log\n- odoo-helper-restart\n- odoo-helper-server\n- odoo-helper-test\n\nFor more info look at [documentation](https://katyukha.gitlab.io/odoo-helper-scripts/). (currently documentation status is *work-in-progress*).\nAlso look at [Frequently used commands](https://katyukha.gitlab.io/odoo-helper-scripts/frequently-used-commands/) and [Command reference](https://katyukha.gitlab.io/odoo-helper-scripts/command-reference/)\n\nAlso look at [odoo-helper-scripts tests](./tests/test.bash) to get complete usage example (look for *Start test* comment).\n\n## Support\n\nHave you any quetions? Just [fill an issue](https://gitlab.com/katyukha/odoo-helper-scripts/issues/new) or [send email](mailto:incoming+katyukha/odoo-helper-scripts@incoming.gitlab.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatyukha%2Fodoo-helper-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkatyukha%2Fodoo-helper-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatyukha%2Fodoo-helper-scripts/lists"}