Skip to content

Installation

PinViz requires Python 3.12 or later.

Choose Your Install Method

Method Best for Run pinviz as Upgrade command
uv tool install pinviz CLI-only use, global access pinviz ... uv tool upgrade pinviz
pipx install pinviz CLI-only use, no uv pinviz ... pipx upgrade pinviz
uv add pinviz Using PinViz as a library in a project uv run pinviz ... uv add pinviz@latest
pip install pinviz Simple library use, existing venv pinviz ... (if venv active) pip install --upgrade pinviz

Not sure? Use uv tool install pinviz — it gives you a global pinviz command without affecting any project environment.

Install as a standalone tool with global access to the CLI using uv:

uv tool install pinviz

After installation, pinviz will be available globally in your terminal.

Alternative: You can also use pipx for isolated CLI tool installations:

pipx install pinviz

As a Project Dependency

If you want to use PinViz as a library in your Python project:

# Using uv
uv add pinviz

# Using pip
pip install pinviz

Note

If you install with uv add, the CLI tool will only be available via uv run pinviz. For direct CLI access, use uv tool install instead.

Verify Installation

Check that PinViz is installed correctly:

pinviz --help

You should see the command-line help output.

Tip

If you installed with uv add, use uv run pinviz --help instead.

Development Installation

For contributing to PinViz, clone the repository and install in development mode:

# Clone repository
git clone https://github.com/nordstad/PinViz.git
cd PinViz

# Install dependencies
uv sync --dev

# Verify installation
uv run pinviz --help

Requirements

  • Python 3.12 or later
  • Dependencies:
    • drawsvg~=2.4 - SVG generation
    • pyyaml>=6.0.1 - YAML configuration parsing
    • typer>=0.12.0 - CLI framework
    • rich>=13.7.0 - Terminal output formatting
    • structlog>=24.1.0 - Structured logging

All dependencies are installed automatically when you install PinViz.

Next Steps