Skip to content

Installation Guide for Vizro

Overview

Welcome to Vizro! 👋 This guide will help you get started with installing and setting up Vizro for building interactive dashboards.

You can use PyCafe to work with Vizro without installing it, as demonstrated in the first dashboard tutorial. Using PyCafe is a great way to try out Vizro quickly. For more information, see the PyCafe documentation.

If you prefer to work locally, this guide will walk you through installing Vizro onto your machine. We'll also cover how to verify your installation and keep Vizro up to date.

Prerequisites

Before installing Vizro, you'll need:

  • Python 3.9 or later
  • A virtual environment (recommended)

For Python installation and virtual environment setup, refer to:

Use a virtual environment

We strongly recommend using a virtual environment when working with Python packages to avoid dependency conflicts and keep your system Python clean. See the Python Packaging Guide for more information about creating virtual environments.

Installing Vizro

Using pip

pip install vizro

Using uv

uv pip install vizro

Verifying the Installation

To make sure everything is working correctly, you can verify your installation and check the installed version:

import vizro

print(vizro.__version__)

You should see the version number displayed (e.g., 0.1.0).

Upgrading

When new versions of Vizro are released, you can upgrade to use them with:

pip install -U vizro

Check Release Notes

Before upgrading, we recommend checking the release notes for any breaking changes that might affect your existing dashboards.

IDE Support

Enable IDE autocompletion

Vizro uses pydantic for configuration, which means you can get IDE support. To enable autocompletion and type hints, install:

logo