Package Distribution

Installation and Distribution

Udility is distributed as a standard Python package via PyPI, allowing for streamlined integration into educational and research workflows. The distribution includes all necessary logic for interfacing with Llama-based models and rendering SVG content into high-quality imagery.

Installing via pip

The most efficient way to install the latest stable version of Udility is through the Python Package Index (PyPI):

pip install Udility

This command automatically resolves and installs the core library along with its required dependencies.

Core Dependencies

Udility relies on several specialized libraries to handle text-to-SVG generation and image rendering. These are automatically managed during the installation process:

[!NOTE] While pip handles library dependencies, cairosvg may require system-level C libraries (like libcairo) depending on your operating system. Users on Linux or macOS may need to install cairo via their respective package managers (apt or brew) if it is not already present.

System Requirements

To ensure optimal performance and compatibility, your environment should meet the following specifications:

Python Version: Python 3.6 or higher.
API Access: An active OpenRouter API key is required to facilitate communication with the Meta Llama 3.5 backend.
Operating System: Cross-platform support (Windows, macOS, Linux).

Manual Installation (Development)

For users who wish to install the package directly from the source or contribute to its development, you can clone the repository and install it in editable mode:

git clone https://github.com/uditakhourii/Udility.git
cd Udility
pip install -e .

Versioning

Udility follows semantic versioning. You can verify your installed version using the following command:

import Udility
print(Udility.__version__) # Current stable version: 2.0