/rez-tools

A suite tool command line for rez.

Primary LanguagePythonMIT LicenseMIT

logo

python version PyPI version Downloads Status Downloads License pypi format Maintenance

rez_tools

A suite tool command line for rez.

logoThis tool requires you to install rez in advance.

Installing

You can install via pip.

pip install rez_tools

or through clone from Github.

git clone https://github.com/loonghao/rez-tools.git

Install package.

cd rez_tools
python setup.py install

QuickStart

rez_tools will find all tools via reztoolsconfig:tool_paths.

> set REZ_TOOL_CONFIG=C:\Users\hao.long\PycharmProjects\rez_tools\examples\reztoolsconfig.py
> rt

rt will dynamically generate a command line and bind it to the rt namespace based on the content defined in the found .rt file.

type rt will list all tools found. like the below.

Usage: rt [OPTIONS] PLUGIN [PLUGIN OPTIONS]

Options:
  -h, --help  Show this message and exit.

Plugin Commands:
  conan_python2  A rez plugin - conan_python2.
  conan_python3  A rez plugin - conan_python3.
  python         Python3.

Tool Options:
  rez_tools run other tools with their own options and argument patterns,
  however, all tool has the following hidden options:

  --ignore-cmd  Ignore standard tool command when running the command,Remember
                to provide an argument which will be used as the command to
                run.Examples: rt conan --ignore-cmd python

  --print       Print plugin details and exit.

Define the suite description of rez-tool

The file format is .rt, the syntax is yaml

The following fields are now supported:

Key required description
name no The name of the tool, which will finally be registered in the command line.
command yes The complete command line to be executed.
requires yes The name of the rez package that the command line execution environment depends on

Examples:

maya.rt

command: maya
requires:
   - maya-2020
   - maya_usd
   - maya_mtoa

run command line

rt maya

cmake_gui.rt

command: cmke-gui
requeres:
    - cmake

run command line

rt cmake_gui

python-2.rt

name: python_2
command: python
requeres:
    - python-2.7
    - pyside
    - pyyaml

run command line

rt python_2