forked from AcademySoftwareFoundation/rez
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
607 additions
and
216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,3 +23,4 @@ docs/source/commands/ | |
| __tests_pkg_repo/ | ||
| .idea/ | ||
| venv/ | ||
| *.spec | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,228 +1,30 @@ | ||
| [](https://github.com/AcademySoftwareFoundation/rez/blob/main/LICENSE)<br> | ||
| [](https://github.com/AcademySoftwareFoundation/rez/releases) | ||
| [](https://pypi.org/project/rez)<br> | ||
| [](https://lists.aswf.io/g/rez-discussion) | ||
| [](https://slack.aswf.io/) | ||
| [](https://github.com/AcademySoftwareFoundation/rez/blob/main/CONTRIBUTING.md)<br> | ||
| [](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/tests.yaml) | ||
| [](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/installation.yaml) | ||
| [](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/flake8.yaml) | ||
| [](https://rez.readthedocs.io/en/stable) | ||
| [](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Apypi+event%3Arelease) | ||
| [](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Abenchmark+event%3Arelease)<br> | ||
| [](https://codecov.io/gh/AcademySoftwareFoundation/rez) | ||
| [](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez) | ||
| [](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez) | ||
| [](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez) | ||
| [](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez) | ||
| [](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez) | ||
| [](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez) | ||
| # Portable Rez build by PyInstaller | ||
|
|
||
| This is an unofficial portable build of Rez, created using PyInstaller. It is intended to be used as a standalone executable, which can be run on any Windows machine without the need to install Python or Rez. | ||
|
|
||
| - [What Is Rez?](#what-is-rez) | ||
| - [The Basics](#the-basics) | ||
| - [Examples](#examples) | ||
| - [Quickstart](#quickstart) | ||
| - [Building Your First Package](#building-your-first-package) | ||
| - [Features](#features) | ||
| The behavior of this build should be identical to the official Rez build. | ||
|
|
||
| The only difference between this repository and the official Rez repository is the addition of the pyinstaller folder, which contains the build script and the necessary files to create the portable build. | ||
|
|
||
| ## What Is Rez? | ||
| Original Rez repository: [AcademySoftwareFoundation/rez](https://github.com/AcademySoftwareFoundation/rez) | ||
|
|
||
| Rez is a cross-platform package manager with a difference. Using Rez you can create | ||
| standalone environments configured for a given set of packages. However, unlike many | ||
| other package managers, packages are not installed into these standalone environments. | ||
| Instead, all package versions are installed into a central repository, and standalone | ||
| environments reference these existing packages. This means that configured environments | ||
| are lightweight, and very fast to create, often taking just a few seconds to configure | ||
| despite containing hundreds of packages. | ||
| Rez documentation: [rez.readthedocs.io](https://rez.readthedocs.io/en/stable/index.html) | ||
|
|
||
| See [the wiki](https://rez.readthedocs.io) for full documentation. | ||
| ## Usage | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/other_pkg_mgr.png"> | ||
| <img src="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/other_pkg_mgr.png"></a> | ||
| <br><i>Typical package managers install packages into an environment</i> | ||
| </p> | ||
| 1. Download the latest release from the [Latest Releases](https://github.com/FhyTan/portable_rez/releases/download/Latest/portable_rez-3.2.0-x86_64-windows-py311.zip) | ||
| 2. Extract the contents of the zip file to a folder of your choice | ||
| 3. Add the folder to your PATH environment variable | ||
|
|
||
| <br> | ||
| <p align="center"> | ||
| <a href="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/rez_pkg_mgr.png"> | ||
| <img src="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/rez_pkg_mgr.png"></a> | ||
| <br><i>Rez installs packages once, and configures environments dynamically</i> | ||
| </p> | ||
| now you can run `rez` from the command line as you would with the official build. | ||
|
|
||
| <br> | ||
| Rez takes a list of package requests, and constructs the target environment, resolving | ||
| all the necessary package dependencies. Any type of software package is supported - | ||
| compiled, python, applications and libraries. | ||
| ## Build | ||
|
|
||
| Currently just provides a Windows build, but it should be possible to build for other platforms or other python versions as well. | ||
|
|
||
| ## The Basics | ||
| The build script is located in the `pyinstaller` folder. Just installer pyinstaller and run the command with your desired python version and platform: | ||
|
|
||
| Packages are stored in repositories on disk. Each package has a single concise | ||
| definition file (*package.py*) that defines its dependencies, its commands (how it | ||
| configures the environment containing it), and other metadata. For example, the | ||
| following is the package definition file for the popular *requests* python module: | ||
|
|
||
| name = "requests" | ||
|
|
||
| version = "2.8.1" | ||
|
|
||
| authors = ["Kenneth Reitz"] | ||
|
|
||
| requires = [ | ||
| "python-2.7+" | ||
| ] | ||
|
|
||
| def commands(): | ||
| env.PYTHONPATH.append("{root}/python") | ||
|
|
||
| This package requires python-2.7 or greater. When used, the 'python' subdirectory | ||
| within its install location is appended to the PYTHONPATH environment variable. | ||
|
|
||
| When an environment is created with the rez API or *rez-env* tool, a dependency | ||
| resolution algorithm tracks package requirements and resolves to a list of needed | ||
| packages. The commands from these packages are concatenated and evaluated, resulting | ||
| in a configured environment. Rez is able to configure environments containing | ||
| hundreds of packages, often within a few seconds. Resolves can also be saved to file, | ||
| and when re-evaluated later will reconstruct the same environment once more. | ||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
| This example places the user into a resolved shell containing the requested packages, | ||
| using the [rez-env](https://rez.readthedocs.io/en/stable/commands/rez-env.html) tool: | ||
|
|
||
| ]$ rez-env requests-2.2+ python-2.6 'pymongo-0+<2.7' | ||
|
|
||
| You are now in a rez-configured environment. | ||
|
|
||
| resolved by [email protected], on Wed Feb 26 15:56:20 2014, using Rez v2.0.0 | ||
|
|
||
| requested packages: | ||
| requests-2.2+ | ||
| python-2.6 | ||
| pymongo-0+<2.7 | ||
|
|
||
| resolved packages: | ||
| python-2.6.8 /software/ext/python/2.6.8 | ||
| platform-linux /software/ext/platform/linux | ||
| requests-2.2.1 /software/ext/requests/2.2.1/python-2.6 | ||
| pymongo-2.6.3 /software/ext/pymongo/2.6.3 | ||
| arch-x86_64 /software/ext/arch/x86_64 | ||
|
|
||
| > ]$ _ | ||
|
|
||
| This example creates an environment containing the package 'houdini' version 12.5 | ||
| or greater, and runs the command 'hescape -h' inside that environment: | ||
|
|
||
| ]$ rez-env houdini-12.5+ -- hescape -h | ||
| Usage: hescape [-foreground] [-s editor] [filename ...] | ||
| -h: output this usage message | ||
| -s: specify starting desktop by name | ||
| -foreground: starts process in foreground | ||
|
|
||
| Resolved environments can also be created via the API: | ||
|
|
||
| >>> import subprocess | ||
| >>> from rez.resolved_context import ResolvedContext | ||
| >>> | ||
| >>> r = ResolvedContext(["houdini-12.5+", "houdini-0+<13", "java", "!java-1.8+"]) | ||
| >>> p = r.execute_shell(command='which hescape', stdout=subprocess.PIPE) | ||
| >>> out, err = p.communicate() | ||
| >>> | ||
| >>> print(out) | ||
| '/software/ext/houdini/12.5.562/bin/hescape' | ||
|
|
||
|
|
||
| ## Quickstart | ||
|
|
||
| First, install Rez using Python 3.7+. Download the source, and from the source directory, run | ||
| (with DEST_DIR replaced with your install location): | ||
|
|
||
| ]$ python3 ./install.py -v DEST_DIR | ||
|
|
||
| This installs the Rez command line tools. It will print a message at the end | ||
| telling you how to use Rez when the installation has completed. Rez is not a | ||
| normal Python package and so you do not typically install it with pip or setup.py. | ||
| Do *not* move the installation - re-install to a new location if you want to | ||
| change the install path. If you want to install rez for multiple operating | ||
| systems, perform separate installs for each of those systems. | ||
|
|
||
| Next, you need to create some essential Rez packages. The *rez-bind* tool creates | ||
| Rez packages that are based on software already installed on your system. Try | ||
| binding the following list of packages (note that for Python, you may need | ||
| administrative privileges): | ||
|
|
||
| ]$ rez-bind platform | ||
| ]$ rez-bind arch | ||
| ]$ rez-bind os | ||
| ]$ rez-bind python | ||
|
|
||
| Now you should be able to create an environment containing Python. Try this: | ||
|
|
||
| ]$ rez-env python -- which python | ||
| /home/ajohns/packages/python-2.7.8/platform-linux/arch-x86_64/os-Ubuntu-12.04/bin/python | ||
|
|
||
|
|
||
| ## Building Your First Package | ||
|
|
||
| The *rez-build* tool is used to build packages and install them locally (typically | ||
| to *$HOME/packages*). Once you've done that, you can use them via *rez-env*, just | ||
| like any other package: | ||
|
|
||
| ]$ cd example_packages/hello_world | ||
| ]$ rez-build --install | ||
| ... | ||
| ]$ rez-env hello_world -- hello | ||
| Hello world! | ||
|
|
||
|
|
||
| ## Features | ||
|
|
||
| * Supports Linux, OSX and Windows; | ||
| * Allows for a fast and efficient build-install-test cycle; | ||
| * Creates shells of type: bash, tcsh, other (shells can be added as plugins); | ||
| * Contains a deployment system supporting git, mercurial and svn (as plugins); | ||
| * Environment resolves can be saved to disk and reused at a later date (a bit | ||
| like VirtualEnv); | ||
| * Highly pluggable, supports five different plugin types to do things from | ||
| adding new shell types, to adding new build systems; | ||
| * Contains a version resolving algorithm, for avoiding version clashes; | ||
| * Visualises resolved environments in a rendered dot-graph; | ||
| * Packages are found in a search path, so different packages can be deployed | ||
| to different locations; | ||
| * Supports alphanumeric version numbers; | ||
| * Has a powerful version requirements syntax, able to describe any version | ||
| range, and a conflict operator for rejecting version ranges; | ||
| * Package 'variants' - a way to define different flavors of the same package | ||
| version, for example a plugin built for multiple versions of the host app; | ||
| * Custom release hooks (such as post-release operations) can be added as plugins; | ||
| * Has a time lock feature, which allows old resolves to be recreated (newer | ||
| packages are ignored); | ||
| * Package definitions are a single, succinct file; | ||
| * Packages define their effect on the environment (adding to PATH etc) in a | ||
| platform- and shell- agnostic way, using a dedicated python API; | ||
| * Has a memcached-based caching system, for caching environment resolves; | ||
| * Has a package filtering feature, allowing for staged package releases such as | ||
| alpha and beta packages. | ||
|
|
||
| ## You have a problem or want to talk to us? | ||
|
|
||
| If you find a bug, need help, or want to talk to the developers, here is a list of the different | ||
| ways to get in touch with us: | ||
|
|
||
| * [Report an issue](https://github.com/AcademySoftwareFoundation/rez/issues) | ||
| * [Chat room](https://slack.aswf.io): Join the ``#rez`` channel | ||
| * [Start a discussion](https://github.com/AcademySoftwareFoundation/rez/discussions) | ||
| * [Mailing list](mail:[email protected]): Note that are way less active on the mailing | ||
| list than on any other communication channel. | ||
|
|
||
| ## Known issues and limitations | ||
|
|
||
| * Currently CMake builds do not function on Windows with Rez and | ||
| the related tests are skipped. A fix requires multiple changes that are on | ||
| the roadmap. Users have successfully implemented workarounds to utilize | ||
| CMake with Rez under Windows, but the goal is to provide a seamless experience | ||
| on any platform in the future. For details see this [issue](/../../issues/703) | ||
| ```bash | ||
| pip install pyinstaller | ||
| python ./pyinstaller/build.py | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import os | ||
| import sys | ||
|
|
||
| from rez.cli._main import run | ||
| from rez.system import system | ||
|
|
||
| # Determine if rez is running in a production install | ||
| if os.path.basename(sys.executable) == "_rez-complete.exe": | ||
| system.rez_bin_path = os.path.dirname(sys.executable) | ||
|
|
||
| # Run the command | ||
| run("complete") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import os | ||
| import sys | ||
|
|
||
| from rez.cli._main import run | ||
| from rez.system import system | ||
|
|
||
| # Determine if rez is running in a production install | ||
| if os.path.basename(sys.executable) == "_rez_fwd.exe": | ||
| system.rez_bin_path = os.path.dirname(sys.executable) | ||
|
|
||
| # Run the command | ||
| run("forward") |
Oops, something went wrong.