Installation

Prerequisites

Make sure you have Python (version 3.8 or higher) installed.

For efficient package management, we recommend uv — a modern and fast tool for managing Python environments.

Method 1: Install from Source (for Development)

This method is ideal if you want to contribute to the project or modify the code.

  1. Clone the repository:

    git clone https://github.com/aborruso/tometo_tomato.git

  2. Navigate to the project directory:

    cd tometo_tomato

  3. Install dependencies:

    • With uv (recommended):

      uv sync

      This creates a virtual environment and installs the package in editable mode, so code changes take effect immediately.

    • With pip:

      pip install -e .

    If you don’t plan to modify the code, you can omit the -e flag:

    pip install .

Method 2: Install as a Global Tool (with uv tool install)

If you just want to use tometo_tomato as a command-line tool without managing source code or virtual environments, uv tool install is the cleanest option.

  1. Make sure you have uv installed.

  2. Install the tool:

    uv tool install tometo_tomato

    This installs tometo_tomato in an isolated environment managed by uv and makes it available on your PATH.

Verify the Installation

After completing any of the installation methods, verify that tometo_tomato is installed correctly:

tometo_tomato --version

You should see the version number printed on screen.