UV-GUIDE.md

Working with UV InvenioRDM

Installing UV

Make sure to install UV on your Operating system.

using UV to set up your virtual env and install packages

Use UV to create and activate a virtual environment:

uv venv --prompt uv-env && source .venv/bin/activate && uv pip install -e path/to/package
uv sync

install dependencies

Synchronize and install all dependencies:

uv pip install -e path/to/package
uv sync

define dependencies

Update your pyproject.toml file to include all necessary dependencies

dependencies = [
    "invenio-override ~=0.0.3"
]

sync dependencies

uv sync

build assets

Compile and build assets for the project:

uv run invenio-cli assets build

start/destroy Services

Set up and start required services:

uv run invenio-cli services destroy
uv run invenio-cli services setup

run the app

Start the Invenio application:

uv run invenio-cli run

OS (macOS) architecture compatibility issues

issues related to architecture (e.g., -84 architecture errors) on macOS systems, particularly with Apple Silicon chips (M1/M2), use the following command to resolve them:

export SYSTEM_VERSION_COMPAT=1
arch -arm64 brew install python