From f925a9578e09e7e99172f7e901d9c25ad3199e51 Mon Sep 17 00:00:00 2001 From: Milan Kolar Date: Thu, 1 Apr 2021 17:37:50 +0200 Subject: [PATCH] Auto stash before checking out "openPype/develop" --- README.md | 117 +++++++++++++++++++++++++++++------------------------- 1 file changed, 64 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 456655bfb9..aae79f2358 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,49 @@ -Pype +OpenPype ==== Introduction ------------ -Multi-platform open-source pipeline built around the [Avalon](https://getavalon.github.io/) platform, -expanding it with extra features and integrations. Pype connects asset database, project management -and time tracking into a single modular system. It has tight integration -with [ftrack](https://www.ftrack.com/en/), but it can also run independently. +Open-source pipeline for visual effects and animation built on top of the [Avalon](https://getavalon.github.io/) framework, expanding it with extra features and integrations. OpenPype connects your DCCs, asset database, project management and time tracking into a single system. It has a tight integration with [ftrack](https://www.ftrack.com/en/), but can also run independently or be integrated into a different project management solution. -To get all the key information about the project, go to [PYPE.club](http://pype.club) +OpenPype provides a robust platform for your studio, without the worry of a vendor lock. You will always have full access to the source-code and your project database will run locally or in the cloud of your choice. + + +To get all the information about the project, go to [OpenPype.io](http://openpype.io) Requirements ------------ -Pype will run on most typical hardware configurations commonly found in studios around the world. -It is installed on artist computer and can take up 3Gb of space depending on number of versions -and other dependencies. -For well functioning [ftrack](https://www.ftrack.com/en/) event server, we recommend a -linux virtual server with [Ubuntu](https://ubuntu.com/) or [CentosOS](https://www.centos.org/). -CPU and RAM allocation need differ based on the studio size, but a 2GB of RAM, with a -dual core CPU and around 4GB of storage should suffice. +We aim to closely follow [**VFX Reference Platform**](https://vfxplatform.com/) -Pype needs running [mongodb](https://www.mongodb.com/) server with good connectivity as it is -heavily used by Pype. Depending on project size and number of artists working connection speed and -latency influence performance experienced by artists. If remote working is required, this mongodb -server must be accessible from Internet or cloud solution can be used. Reasonable backup plan -or high availability options are recommended. +OpenPype is written in Python 3 with specific elements still running in Python2 until all DCCs are fully updated. To see the list of those, that are not quite there yet, go to [VFX Python3 tracker](https://vfxpy.com/) -Building Pype +The main things you will need to run and build OpenPype are: + +- **Terminal** in your OS + - PowerShell 5.0+ (Windows) + - Bash (Linux) +- [**Python 3.7.8**](#python) or higher +- [**MongoDB**](#database) + + +It can be built and ran on all common platforms. We develop and test on the following: + +- **Windows** 10 +- **Linux** + - **Ubuntu** 20.04 LTS + - **Centos** 7 +- **Mac OSX** + - **10.15** Catalina + - **11.1** Big Sur (using Rosetta2) + +For more details on requirements visit [requirements documentation](https://openpype.io/docs/dev_requirements) + +Building OpenPype ------------- -To build Pype you currently need [Python 3.7](https://www.python.org/downloads/) as we are following +To build OpenPype you currently need [Python 3.7](https://www.python.org/downloads/) as we are following [vfx platform](https://vfxplatform.com). Because of some Linux distros comes with newer Python version already, you need to install **3.7** version and make use of it. You can use perhaps [pyenv](https://github.com/pyenv/pyenv) for this on Linux. @@ -44,27 +55,27 @@ development tools like [CMake](https://cmake.org/) and [Visual Studio](https://v #### Clone repository: ```sh -git clone --recurse-submodules git@github.com:pypeclub/pype.git +git clone --recurse-submodules git@github.com:Pypeclub/OpenPype.git ``` -#### To build Pype: +#### To build OpenPype: 1) Run `.\tools\create_env.ps1` to create virtual environment in `.\venv` -2) Run `.\tools\build.ps1` to build pype executables in `.\build\` +2) Run `.\tools\build.ps1` to build OpenPype executables in `.\build\` -To create distributable Pype versions, run `./tools/create_zip.ps1` - that will -create zip file with name `pype-vx.x.x.zip` parsed from current pype repository and +To create distributable OpenPype versions, run `./tools/create_zip.ps1` - that will +create zip file with name `openpype-vx.x.x.zip` parsed from current OpenPype repository and copy it to user data dir, or you can specify `--path /path/to/zip` to force it there. -You can then point **Igniter** - Pype setup tool - to directory containing this zip and +You can then point **Igniter** - OpenPype setup tool - to directory containing this zip and it will install it on current computer. -Pype is build using [CX_Freeze](https://cx-freeze.readthedocs.io/en/latest) to freeze itself and all dependencies. +OpenPype is build using [CX_Freeze](https://cx-freeze.readthedocs.io/en/latest) to freeze itself and all dependencies. ### macOS You will need [Python 3.7](https://www.python.org/downloads/) and [git](https://git-scm.com/downloads). You'll need also other tools to build -some Pype dependencies like [CMake](https://cmake.org/) and **XCode Command Line Tools** (or some other build system). +some OpenPype dependencies like [CMake](https://cmake.org/) and **XCode Command Line Tools** (or some other build system). Easy way of installing everything necessary is to use [Homebrew](https://brew.sh): @@ -81,7 +92,7 @@ brew install cmake 3) Install [pyenv](https://github.com/pyenv/pyenv): ```sh brew install pyenv -echo 'eval "$(pypenv init -)"' >> ~/.zshrc +echo 'eval "$(pyenv init -)"' >> ~/.zshrc pyenv init exec "$SHELL" PATH=$(pyenv root)/shims:$PATH @@ -98,14 +109,14 @@ pyenv install 3.7.9 5) Set local Python version ```sh -# switch to Pype source directory +# switch to OpenPype source directory pyenv local 3.7.9 ``` -#### To build Pype: +#### To build OpenPype: 1) Run `.\tools\create_env.sh` to create virtual environment in `.\venv` -2) Run `.\tools\build.sh` to build Pype executables in `.\build\` +2) Run `.\tools\build.sh` to build OpenPype executables in `.\build\` ### Linux @@ -115,7 +126,7 @@ You will need [Python 3.7](https://www.python.org/downloads/) and [git](https:// To build Python related stuff, you need Python header files installed (`python3-dev` on Ubuntu for example). You'll need also other tools to build -some Pype dependencies like [CMake](https://cmake.org/). Python 3 should be part of all modern distributions. You can use your package manager to install **git** and **cmake**. +some OpenPype dependencies like [CMake](https://cmake.org/). Python 3 should be part of all modern distributions. You can use your package manager to install **git** and **cmake**.
@@ -127,7 +138,7 @@ sudo apt install build-essential checkinstall sudo apt install git cmake curl ``` #### Note: -In case you run in error about `xcb` when running Pype, +In case you run in error about `xcb` when running OpenPype, you'll need also additional libraries for Qt5: ```sh @@ -144,7 +155,7 @@ sudo yum install qit cmake ``` #### Note: -In case you run in error about `xcb` when running Pype, +In case you run in error about `xcb` when running OpenPype, you'll need also additional libraries for Qt5: ```sh @@ -153,7 +164,7 @@ sudo yum install qt5-qtbase-devel
-Use pyenv to install Python version for Pype build +Use pyenv to install Python version for OpenPype build You will need **bzip2**, **readline** and **sqlite3** libraries. @@ -177,8 +188,8 @@ exec $SHELL # install Python 3.7.9 pyenv install -v 3.7.9 -# change path to pype 3 -cd /path/to/pype-3 +# change path to OpenPype 3 +cd /path/to/openpype-3 # set local python version pyenv local 3.7.9 @@ -186,42 +197,42 @@ pyenv local 3.7.9 ```
-#### To build Pype: +#### To build OpenPype: 1) Run `.\tools\create_env.sh` to create virtual environment in `.\venv` -2) Run `.\tools\build.sh` to build Pype executables in `.\build\` +2) Run `.\tools\build.sh` to build OpenPype executables in `.\build\` -Running Pype +Running OpenPype ------------ -Pype can by executed either from live sources (this repository) or from +OpenPype can by executed either from live sources (this repository) or from *"frozen code"* - executables that can be build using steps described above. -If Pype is executed from live sources, it will use Pype version included in them. If -it is executed from frozen code it will try to find latest Pype version installed locally +If OpenPype is executed from live sources, it will use OpenPype version included in them. If +it is executed from frozen code it will try to find latest OpenPype version installed locally on current computer and if it is not found, it will ask for its location. On that location -pype can be either in directories or zip files. Pype will try to find latest version and -install it to user data directory (on Windows to `%LOCALAPPDATA%\pypeclub\pype`, on Linux -`~/.local/share/pype` and on macOS in `~/Library/Application Support/pype`). +OpenPype can be either in directories or zip files. OpenPype will try to find latest version and +install it to user data directory (on Windows to `%LOCALAPPDATA%\pypeclub\openpype`, on Linux +`~/.local/share/openpype` and on macOS in `~/Library/Application Support/openpype`). ### From sources -Pype can be run directly from sources by activating virtual environment: +OpenPype can be run directly from sources by activating virtual environment: ```sh poetry run python start.py tray ``` -This will use current Pype version with sources. You can override this with `--use-version=x.x.x` and -then Pype will try to find locally installed specified version (present in user data directory). +This will use current OpenPype version with sources. You can override this with `--use-version=x.x.x` and +then OpenPype will try to find locally installed specified version (present in user data directory). ### From frozen code -You need to build Pype first. This will produce two executables - `pype_gui(.exe)` and `pype_console(.exe)`. +You need to build OpenPype first. This will produce two executables - `openpype_gui(.exe)` and `openpype_console(.exe)`. First one will act as GUI application and will not create console (useful in production environments). The second one will create console and will write output there - useful for headless application and -debugging purposes. If you need pype version installed, just run `./tools/create_zip(.ps1|.sh)` without -arguments and it will create zip file that pype can use. +debugging purposes. If you need OpenPype version installed, just run `./tools/create_zip(.ps1|.sh)` without +arguments and it will create zip file that OpenPype can use. Building documentation