Skip to content

Commit

Permalink
Just update Installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
j0yu authored and Joseph Yu committed Mar 18, 2021
1 parent 629f446 commit e922172
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions wiki/pages/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,25 @@ source /opt/rez/completion/complete.sh

## Installation Via Pip

It is possible to install rez with pip, like so:
It is possible to install rez with pip, like so (from source root directory):

```
]$ pip install rez
]$ pip install --target /opt/rez .
```

However, this comes with a caveat - rez command line tools _are not guaranteed
to work correctly_ once inside a rez environment (ie after using the `rez-env`
command). The reasons are given in the next section.
The environment variables to activate `rez` will be slightly different:

- Add `/opt/rez/bin` to `PATH`
- Add `/opt/rez` to `PYTHONPATH`

Alternatively, if you already have `rez` setup and have `pip>=19` available,
you can then install `rez` as a `rez` package by using:

]$ rez-pip --install .

However, these methods comes with a caveat - rez command line tools _are not
guaranteed to work correctly_ once inside a rez environment (ie after using the
`rez-env` command). The reasons are given in the next section.

Pip installation is adequate however, if all you require is the rez API, or you
don't require its command line tools to be available within a resolved environment.
Expand Down

0 comments on commit e922172

Please sign in to comment.