Skip to content

davidlatwe/rezup

Repository files navigation

rezup

Python package Version

A cross-platform Rez production tooling manager

Read The Docs

Why use rezup

  • Easier to setup/update Rez venv
  • Easier to install custom Rez extensions (plugins)
  • Easier to provide different Rez venv setup for different purpose

Install

This installs the rezup full package, command line tool and the api package.

$ pip install rezup

To upgrade, you only need to upgrade the api package. So to avoid re-creating console-script.

$ pip install -U rezup-api

Quick start

Simply calling rezup in terminal will suffice.

$ rezup

The command above is a shorthand for rezup use .main, which means to enter a Rez venv container named .main. Usually you must rezup add a new container before you can use it. But default container .main will automatically be created if it's not existing yet, for the first time.

So, what will & should happen after calling rezup ?

  1. A most basic recipe will be written into user home directory (~/rezup.toml)
  2. Default container .main will be created with that recipe
  3. Wait for it...
  4. Bam! A vanilla Rez environment is presented (In subprocess)
  5. Try rez --version or any rez command
  6. Once you're done, simply type exit to escape.

As you may have seen, Rez venv is in the container and is deployed with a recipe file. Please visit Container-Recipe page for more detail about how you can auth and create a richer container by the recipe.

And for other rezup commands, please run rezup --help or rezup [COMMAND] --help for each command's usage.

$ rezup --help

Or, visit Command page.