Skip to main content

Modern TUI-driven Odoo Worktree Manager

Project description

Odoo Worktree Assistant (odoo-wt)

A professional, modern TUI-driven Git worktree manager explicitly designed for Odoo developers. Built with Python, Textual, and uv.

The Pitch

I work with Odoo using Git Worktrees every single day. Every time I start a new feature or need to check out a colleague's code, I find myself doing the same tedious dance: creating a new folder, fetching branches from the remote, adding the community worktree, adding the enterprise worktree, and then setting up the Python environment.

If you also work like this, I built this tool for you. It handles that entire handshake between Git and your virtual environments in seconds through a fast Terminal UI, so you can just focus on the code.

The Structure

The tool creates and manages a standardized folder structure that looks like this:

~/repos/Odoo/wt/                    <-- Your Worktree Root
│
├── master/                         <-- Your base repositories
│   ├── odoo/                       (Main clone of community)
│   └── enterprise/                 (Main clone of enterprise)
│
├── 17.0-fix-account-bug-pian/      <-- A new task
│   ├── .venv/                      <-- Auto-linked shared UV environment
│   ├── odoo/                       <-- Checked out to the task branch
│   └── enterprise/                 <-- Checked out to the task branch
│
└── saas-17.4-feature-xyz-mate/    <-- Checking a colleague's code
    ├── .venv/
    ├── odoo/
    └── enterprise/

Key Features

  • Modern TUI: A sleek, reactive All-in-One form built with Textual.
  • Smart Branching: Follows the Odoo standard: [VERSION]-[description]-[SUFFIX].
  • Dual Repo Support: Simultaneously creates worktrees for both odoo (Community) and enterprise.
  • Automated UV Environments:
    • Centralizes environments in ~/.envs/[VERSION].
    • Automatically runs uv venv and uv pip install if the environment is missing.
    • Instantly symlinks .venv into your new worktree folder for automatic VS Code detection.
  • Proactive Status Checks: Checks odoo-dev and local remotes to detect if branches already exist before creation.

Installation

1. From PyPI (Recommended)

odoo-wt is officially published on PyPI. The easiest way to install it globally is using uv tool:

uv tool install odoo-wt

To update to the latest release:

uv tool upgrade odoo-wt

2. From Source (For Contributors)

If you want to run the latest unreleased version or contribute to the project:

git clone https://github.com/nd-dew/odoo-wt.git
cd odoo-wt
uv tool install . --force

(Tip: For active development, use uv tool install --editable . --force to see code changes instantly without re-installing.)

Configuration

The tool saves its configuration to ~/.config/odoo-wt.json. You can edit paths directly in the Settings tab within the application.

  • wt_root: Where your worktree folders live (e.g., ~/repos/Odoo/wt).
  • env_root: Where your centralized global Python environments are stored (e.g., ~/.envs).
  • suffix: Your default developer quadrigram (e.g., pian).

Usage

Interactive Mode

Simply run the command with no arguments:

odoo-wt
  • Use Tab to switch between Version, Description, and Suffix.
  • Type custom... in any dropdown to reveal a custom input field.
  • Press Ctrl+S to instantly submit and deploy.
  • Press Esc to cancel and exit.

Fast Mode

If you already have a full branch name ready:

odoo-wt 17.0-fix-account-bug-pian

Development Guide

Running Tests

We use pytest for our modern test suite. It covers core logic, file management, and UI rendering via Textual's headless pilot.

# Run all tests
uv run pytest

# Run tests with detailed output
uv run pytest -v

Applying Changes

If you modify the source code, you can apply your changes to your local installation using:

uv tool install . --force

Known Limitations

  • Clipboard Interactions (Copy/Paste): Because odoo-wt uses mouse-capture to enable clickable buttons and scrollbars in the terminal, your terminal emulator's native click-to-highlight features are disabled by default.
    • To copy text manually: Hold the Shift key while clicking and dragging over the text to bypass the app and use your terminal's native selection, then use Ctrl+Shift+C.
    • To paste text: Sometimes native terminal paste (Ctrl+Shift+V or middle-click) events are intercepted unreliably by the underlying framework. If pasting into an input field fails, you may need to type the branch name manually.

Development

To apply changes made to the source:

uv tool install . --force

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odoo_wt-1.2.1.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_wt-1.2.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file odoo_wt-1.2.1.tar.gz.

File metadata

  • Download URL: odoo_wt-1.2.1.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for odoo_wt-1.2.1.tar.gz
Algorithm Hash digest
SHA256 7aca63e500ba139fe0ebdf89c43e3762d97045e34b8d8df8ee325042241a36d4
MD5 48c322db93fa068e0c1d1d45a0a44bce
BLAKE2b-256 31a488ce80ff02cbaf22abb5123260d7acf574705b22d88b64893bfc6a6a152b

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_wt-1.2.1.tar.gz:

Publisher: publish.yml on nd-dew/odoo-wt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file odoo_wt-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: odoo_wt-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for odoo_wt-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27896c08b45f4c4db8de732766410fc162ae8ab10d84b1e65fe27558e0846918
MD5 1f60de58b6e7d84cd64b372e0c71a5d1
BLAKE2b-256 d4fda4e8403444a41566fd64d5d80fff77cca47efa446f9b03b5d4c7dad01943

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_wt-1.2.1-py3-none-any.whl:

Publisher: publish.yml on nd-dew/odoo-wt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page