Skip to content

Installation

This guide will walk you through installing Teyaotlani on your system.

Level: Beginner Time: 5 minutes

Prerequisites

  • Python 3.10 or higher
  • A package manager (uv or pip)

uv is a fast Python package manager that we recommend for managing Teyaotlani.

uv add teyaotlani

Installation with pip

You can also install Teyaotlani using pip:

pip install teyaotlani

Verify the installation

After installation, verify that Teyaotlani is working correctly by checking the version:

teyaotlani version

You should see output similar to:

Teyaotlani v0.1.0

You can also verify the Python package is importable:

>>> import teyaotlani
>>> teyaotlani.__version__
'0.1.0'

Development installation

If you want to contribute to Teyaotlani or run from source, clone the repository and install in development mode:

git clone https://github.com/alanbato/teyaotlani.git
cd teyaotlani
uv sync --group dev

This installs Teyaotlani along with all development dependencies (testing, linting, etc.).

Next steps

Now that you have Teyaotlani installed, you're ready to: