https://github.com/tecnativa/doodba-copier-template
A Copier template for Doodba projects
https://github.com/tecnativa/doodba-copier-template
copier-template doodba hacktoberfest template-project
Last synced: 12 days ago
JSON representation
A Copier template for Doodba projects
- Host: GitHub
- URL: https://github.com/tecnativa/doodba-copier-template
- Owner: Tecnativa
- License: bsl-1.0
- Created: 2020-03-05T12:27:14.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-05-11T14:29:07.000Z (27 days ago)
- Last Synced: 2026-05-11T14:33:49.244Z (27 days ago)
- Topics: copier-template, doodba, hacktoberfest, template-project
- Language: Jinja
- Homepage:
- Size: 1.18 MB
- Stars: 113
- Watchers: 23
- Forks: 147
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
[][doodba]
[][copier]
[](COPYING)
[](https://pre-commit.com/)
# Doodba Copier Template
This project lets you maintain [Odoo][] deployments based on [Doodba][] using
[Copier][].
Table of contents
- [Installation and Usage](#installation-and-usage)
- [Install the dependencies](#install-the-dependencies)
- [Use the template to generate your subproject](#use-the-template-to-generate-your-subproject)
- [Getting updates for your subproject](#getting-updates-for-your-subproject)
- [Using your subproject to build an Odoo deployment](#using-your-subproject-to-build-an-odoo-deployment)
- [Python libraries](#python-libraries)
- [Getting help](#getting-help)
- [Contributing](#contributing)
- [Credits](#credits)
- [Footnotes](#footnotes)
# Installation and Usage
## Install the dependencies
This project itself is just the template, but you need to install these tools to use it:
- Linux1
- [copier][]
- [Docker](https://docs.docker.com/)
- [Compose V2 plugin](https://docs.docker.com/compose/install/)
- [git](https://git-scm.com/) 2.24 or newer
- [invoke](https://www.pyinvoke.org/) installed in Python 3.8.1+ (and the binary must be
called `invoke` — beware if your distro installs it as `invoke3` or similar).
- [pre-commit](https://pre-commit.com/)
- [python](https://www.python.org/) 3.8.1+
- [venv](https://docs.python.org/3/library/venv.html)
Install non-python apps with your distro's recommended package manager. The recommended
way to install Python CLI apps is [pipx](https://pipxproject.github.io/pipx/):
```bash
python3 -m pip install --break-system-packages --user pipx
pipx install copier
pipx install invoke
pipx install pre-commit
pipx ensurepath
```
## Use the template to generate your subproject
Once you installed everything, you can now use Copier to copy this template:
```bash
copier copy https://github.com/Tecnativa/doodba-copier-template ~/path/to/your/subproject
```
Copier will ask you a lot of questions. Answer them to properly generate the template.
Notes:
- The backup service will not be deployed when using postgresql 9.6.
## Getting updates for your subproject
⚠️ If you come from
[doodba-scaffolding](https://github.com/Tecnativa/doodba-scaffolding), please follow
[the migration guide](docs/migrating-from-doodba-scaffolding.md).
If you always used Copier with this project, getting last updates with Copier is simple:
```bash
cd ~/path/to/your/downstream/scaffolding
copier update --trust
```
Copier will ask you all questions again, but default values will be those you answered
last time. Just hit Enter to accept those defaults, or change them if
needed... or you can use `copier update --force --trust` instead to avoid answering
again all things.
Basically, read Copier docs and `copier --help-all` to know how to use it.
# Using your subproject to build an Odoo deployment
This is a big topic [documented separately](docs/daily-usage.md).
## Python libraries
This project includes several libraries to add features to odoo scafoldings:
- **openupgradelib**: Tools to manage upgrades in Odoo.
- **unicodecsv**: Read and write CSV files with Unicode encoding support.
- **unidecode**: Transliterates Unicode text to ASCII characters.
- **jingtrang** (from Odoo 13 onwards): XML document validation using RELAX NG schemas.
- **pathlib** (for Odoo < 11): Object-oriented path management for file system
operations.
# Getting help
If your question is not answered in [our FAQ](docs/faq.md) or
[Doodba's FAQ](https://github.com/Tecnativa/doodba#faq),
[open an issue](CONTRIBUTING.md#issues)
# Contributing
See the [contribution guidelines](CONTRIBUTING.md).
# Credits
This project is maintained by:
[](https://www.tecnativa.com/r/rIN)
Also, special thanks to
[our dear community contributors](https://github.com/Tecnativa/doodba-copier-template/graphs/contributors).
# Footnotes
1 Any modern distro should work. Ubuntu and Fedora are officially supported.
Other systems are not tested. If you're on Windows, you'll probably need WSL or a Linux
VM to work with doodba without problems. If you use other systems and find a way to make
these tools work, please consider [opening a PR](#contributing) to add some docs that
might help others with your situation.
[copier]: https://github.com/pykong/copier
[doodba]: https://github.com/Tecnativa/doodba
[odoo]: https://www.odoo.com/