Installation

This page covers the different ways to install the Xyra framework and get your development environment ready.

Installing with Pip

The recommended way to install Xyra is from PyPI using pip. This ensures you get the latest stable version.

Bash

pip install xyra

This command will automatically download and install Xyra along with all of its required dependencies.

Installing with Uv

For faster package management, you can use Uv, a modern Python package installer written in Rust. First, install Uv if you haven't already:

Bash

# Install Uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Or using pip
pip install uv

Then install Xyra using Uv:

Bash

uv add xyra

Uv provides significantly faster installation speeds compared to pip, especially for packages with many dependencies.

Installing from Source

If you want to get the latest development features or contribute to the project, you can install Xyra directly from the source code repository on GitHub.

Bash

git clone https://github.com/xyra-python/xyra.git
cd xyra
pip install -e .

The -e flag installs the framework in "editable" mode, meaning any changes you make to the source code will be immediately effective in your environment.

Verifying the Installation

To confirm that Xyra was installed correctly, you can check its version using the command-line interface:

Bash

python -m xyra --version

This should print the installed version number of the Xyra framework, for example: Xyra version 0.1.9.