Skip to content

Installation

Requirements

  • Python 3.11 or newer
  • No C extensions, no system libraries, no app required

Install from PyPI

pip install vexy-lines-py

Or with uv:

uv add vexy-lines-py

Runtime dependencies

Package Why
loguru Structured debug logging (silent by default)
pillow Image handling for replace_source_image()

Two dependencies. Both are pure Python or ship pre-built wheels for all major platforms.

Verify the install

from vexy_lines import parse
print("vexy-lines-py is ready")

Development install

Clone the repo and install in editable mode:

git clone https://github.com/vexyart/vexy-lines.git
cd vexy-lines/vexy-lines-py
uv venv --python 3.12
uv pip install -e ".[dev]"

Run tests:

uvx hatch test

Run type checking:

uvx hatch run lint:typing

Run linting:

uvx hatch run lint:style

Format code:

uvx hatch fmt

Platform support

Works everywhere Python runs. The parser is pure Python using only xml.etree.ElementTree, base64, zlib, and struct from the standard library. The pillow dependency is needed only for replace_source_image().

Tested on macOS, Linux, and Windows. CPython and PyPy.