Skip to content

UV_USAGE.md

Latest commit

 

History

History
101 lines (68 loc) · 2 KB

UV_USAGE.md

File metadata and controls

101 lines (68 loc) · 2 KB

Using azlin with uv

Note: This document covers the Python packaging of azlin via uv/uvx. As of v2.6.17, the primary azlin binary is written in Rust and can be downloaded directly from GitHub Releases. When installed via uvx, the Python package auto-routes to the Rust binary. Use azlin-py to run the Python CLI directly.

azlin is now configured as a uv project for ultra-fast dependency management and execution.

Installation Methods

Method 1: Run with uvx (No Installation)

The fastest way to use azlin - no installation required:

# Run azlin directly with uvx
uvx --from /path/to/azlin azlin --help

# Provision a VM
uvx --from /path/to/azlin azlin

# List VMs
uvx --from /path/to/azlin azlin list

Method 2: Install from Local Directory

Install azlin in your environment:

uv pip install /path/to/azlin
azlin --help

Method 3: Development Mode

For development with hot-reload:

cd /path/to/azlin
uv sync               # Install dependencies
uv run azlin --help   # Run azlin

Method 4: Traditional pip (Still Works)

cd /path/to/azlin
pip install -e .
azlin --help

Why uv?

  • Ultra-fast: 10-100x faster than pip
  • Reliable: Deterministic dependency resolution with uv.lock
  • No installation needed: uvx runs tools without installing
  • Better caching: Shared dependency cache across projects

Development Commands

# Sync dependencies (creates/updates .venv)
uv sync

# Add a new dependency
uv add requests

# Add a dev dependency
uv add --dev black

# Run azlin
uv run azlin

# Run tests
uv run pytest

# Update dependencies
uv lock --upgrade

Files Created

  • uv.lock - Locked dependency versions (commit this!)
  • .venv/ - Virtual environment (gitignored)
  • pyproject.toml - Updated for uv/hatchling

Publishing

When ready to publish to PyPI:

uv build
uv publish

Then users can run:

uvx azlin --help

Without needing the local path!