Skip to content

INSTALL.md

Latest commit

 

History

History
77 lines (51 loc) · 1.18 KB

INSTALL.md

File metadata and controls

77 lines (51 loc) · 1.18 KB
Raw

Installation

Method 1: Quick Install (System-wide)

cd spdx-diff
pip install . --break-system-packages

Use for: Quick testing, single-user systems

Method 2: Virtual Environment (Recommended)

cd spdx-diff

# Create virtual environment
python3 -m venv .venv

# Activate
source .venv/bin/activate

# Install
pip install -e .

# Use the tool
spdx-diff --help

# When done
deactivate

Use for: Development, multiple projects, safety

Note: The -e flag allows code changes to take effect immediately without reinstalling.

Usage

After installation:

# Show help
spdx-diff --help

# Compare two SPDX files, JSON output on stdout by default
spdx-diff reference.json new.json

# Compare two SPDX files, human readable output on stdout
spdx-diff reference.json new.json --human-readable

# With JSON file output generated
spdx-diff reference.json new.json --json-output results.json

See README.md for full documentation.

Uninstall

System-wide:

pip uninstall spdx-diff

Virtual environment:

source .venv/bin/activate
pip uninstall spdx-diff
deactivate

Or simply delete the .venv/ directory.