Skip to content

How to install aviary with uv

Skill level: Beginner

TL;DR

Use uv pip install geospaitial-lab-aviary to install aviary.
To include the CLI, use uv pip install geospaitial-lab-aviary[cli].
For CLI-only, use uv tool install geospaitial-lab-aviary[cli].

The recommended way to install aviary is using uv – a Python package and project manager that simplifies the installation and management of Python packages, their dependencies, and even Python itself.

Install uv

First, make sure uv is installed on your system.

Download uv from the official uv website . If you need help, you can refer to the official uv installation guide .

Install aviary

With uv, you can install aviary in different ways depending on your needs and preferences.

Install aviary using uv pip

uv includes a drop-in replacement for pip - Python’s built-in package manager - so you can use it to install aviary just like you would with pip.

Set up a virtual environment

It is considered best practice to use a virtual environment to install Python packages. This keeps your project dependencies isolated.

Navigate to the directory where you want to install aviary and create a virtual environment.

uv venv venv --python 3.12

Next, activate the virtual environment.

source venv/bin/activate

venv\Scripts\activate

Once activated, you should see its name – in this case, venv – in your terminal prompt.

Install aviary

Install aviary using uv pip.

Warning

aviary is currently released as a pre-release version.
To install the latest version, you need to explicitly specify its version:

uv pip install geospaitial-lab-aviary==VERSION

uv pip install geospaitial-lab-aviary

uv pip install geospaitial-lab-aviary[cli]

uv pip install geospaitial-lab-aviary[all]

Note that there are optional dependency groups:

  • cli: Required for aviary’s CLI
  • all: Includes optional dependencies, such as cli

Install aviary using uv tool

In case you only need the CLI, aviary can be installed globally as a tool.

Warning

aviary is currently released as a pre-release version.
To install the latest version, you need to explicitly specify its version:

uv tool install geospaitial-lab-aviary==VERSION

uv tool install geospaitial-lab-aviary[cli]

For more information, you can refer to the official uv tool documentation .

Install aviary using uv add

If you already use an uv-managed project, you can simply add aviary.

Warning

aviary is currently released as a pre-release version.
To install the latest version, you need to explicitly specify its version:

uv add geospaitial-lab-aviary==VERSION

uv add geospaitial-lab-aviary

uv add geospaitial-lab-aviary[cli]

uv add geospaitial-lab-aviary[all]

Note that there are optional dependency groups:

  • cli: Required for aviary’s CLI
  • all: Includes optional dependencies, such as cli

For more information, you can refer to the official uv projects documentation .

Verify the installation

To verify that aviary was installed successfully, you can check the version.

import aviary

print(aviary.__version__)

aviary --version

This shows the version of aviary.