Getting Started

Installation

Prerequisites

• Python 3.11 or higher.
• Git to clone from source.
• A tool like Rye, uv, or standard pip.

rye

$ rye install git+https://github.com/iiPythonx/pizza

uv

$ uv venv
$ source .venv/bin/activate
$ uv install git+https://github.com/iiPythonx/pizza

pip

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install git+https://github.com/iiPythonx/pizza

pip (no venv)

$ pip install --break-system-packages git+https://github.com/iiPythonx/pizza

from source

$ git clone https://github.com/iiPythonx/pizza
$ cd pizza
$ uv pip install -e .

pizza command not found?

If you installed inside a venv, make sure you have it activated:

source .venv/bin/activate

Tools like Rye install to ~/.rye and need to be added to PATH before they will work.

WARNING

Installing Pizza through pip using --break-system-packages is not supported.
If you encounter issues with Pizza, install using a different method before filing an issue.

Testing the installation

To make sure Pizza is installed correctly, check that it responds:

$ pizza version
🍕 Pizza v0.4.3 by iiPython

Up and Running

Pizza follows a specific lifecycle pattern, you have to:

• Index files you wish to manage
• Scan through the file index and perform MusicBrainz lookups
• Save the modified metadata to disk

To build your file index, run pizza add followed by the directory you wish to index:

$ pizza add /mnt/music

After your files have been indexed, run the write command to fetch metadata from MusicBrainz and write it to your files:

$ pizza write

See the CLI reference for more advanced usage.