https://github.com/bamidev/wax
A reproducable Odoo development environment as a Nix flake
https://github.com/bamidev/wax
Last synced: about 1 year ago
JSON representation
A reproducable Odoo development environment as a Nix flake
- Host: GitHub
- URL: https://github.com/bamidev/wax
- Owner: bamidev
- Created: 2025-06-10T10:53:26.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-10T10:56:00.000Z (about 1 year ago)
- Last Synced: 2025-06-10T11:42:14.252Z (about 1 year ago)
- Language: Nix
- Size: 0 Bytes
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wax
Wax is a build system and development environment for Odoo, in Nix.
It is a nix flake, and uses tools like virtualenv and gitaggregator to set up the environment.
There is no need to prepare your system with the correct python interpreter or c development files of any libraries.
You just need to have the nix package manager installed, and have the flake feature enabled.
## Example flake
Here is an example Nix flake for you Odoo project:
`flake.nix`:
```
{
description = "A Wax example";
inputs = {
wax.url = "github:bamidev/wax";
};
outputs = { self, wax }: {
devShells.x86_64-linux.default = wax.lib.mkOdooShell {
system = "x86_64-linux";
config = import ./config.nix;
};
};
}
```
`config.nix`:
```
{
odooVersion = "16.0";
databaseName = "my-database";
odooConfig = {
options = {
workers = 4;
};
};
}
```
# Commands
In the directory of your flake.nix file, enter the development environment with `nix develop`, edit the `etc/repos.yaml` and `etc/requirements.txt` files, and then you can use the following commands to start using Odoo:
```
build
run
```
Or if you want to completely reset the environment:
```
rm -rf wax
setup
build
```
For the Odoo versions that support it, there is also the `shell` command to run a Odoo shell.