mirror of
https://github.com/ynput/ayon-core.git
synced 2026-01-01 08:24:53 +01:00
Merge branch 'release/3.15.x' into enhancement/remove-staging-logic-on-version
This commit is contained in:
commit
2b6b5668b8
158 changed files with 12012 additions and 3958 deletions
|
|
@ -17,10 +17,12 @@ Distribution consists of two parts
|
|||
It is self contained (frozen) software that also includes all of the OpenPype codebase with the version
|
||||
from the time of the build.
|
||||
|
||||
Igniter package is around 500MB and preparing an updated version requires you to re-build pype. That would be
|
||||
Igniter package is around 1Gb and preparing an updated version requires you to re-build pype. That would be
|
||||
inconvenient for regular and quick distribution of production updates and fixes. So you can distribute those
|
||||
independently, without requiring you artists to re-install every time.
|
||||
|
||||
You can have multiple versions installed at the same time.
|
||||
|
||||
### 2. OpenPype Codebase
|
||||
|
||||
When you upgrade your studio pype deployment to a new version or make any local code changes, you can distribute
|
||||
|
|
@ -73,4 +75,6 @@ For example OpenPype will consider the versions in this order: `3.8.0-nightly` <
|
|||
|
||||
See https://semver.org/ for more details.
|
||||
|
||||
For studios customizing the source code of OpenPype, a practical approach could be to build by adding a name and a number after the PATCH and not to deploy 3.8.0 from original OpenPype repository. For example, your builds will be: `3.8.0-yourstudio.1` < `3.8.0-yourstudio.2` < `3.8.1-yourstudio.1`.
|
||||
For studios customizing the source code of OpenPype, a practical approach could be to build by adding a name and a number after the PATCH and not to deploy 3.8.0 from original OpenPype repository. For example, your builds will be: `3.8.0-yourstudio.1` < `3.8.0-yourstudio.2` < `3.8.1-yourstudio.1`.
|
||||
|
||||
Versions of Igniter and those coming in zips are compatible if they match major and minor version - `3.13.4` is compatible with `3.13.1` but not with `3.12.2` or `3.14.0`.
|
||||
|
|
|
|||
|
|
@ -26,6 +26,9 @@ as a naive barier to prevent artists from accidental setting changes.
|
|||
**`Disk mapping`** - Platform dependent configuration for mapping of virtual disk(s) on an artist's OpenPype machines before OP starts up.
|
||||
Uses `subst` command, if configured volume character in `Destination` field already exists, no re-mapping is done for that character(volume).
|
||||
|
||||
### FFmpeg and OpenImageIO tools
|
||||
We bundle FFmpeg tools for all platforms and OpenImageIO tools for Windows and Linux. By default are used bundled tools but it is possible to set environment variables `OPENPYPE_FFMPEG_PATHS` and `OPENPYPE_OIIO_PATHS` in system settings environments to look for them in different directory e.g. for different linux distributions or to add oiio support for MacOs. Values of both environment variables should lead to directory where tool executables are located (multiple paths are supported).
|
||||
|
||||
### OpenPype deployment control
|
||||
**`Versions Repository`** - Location where automatic update mechanism searches for zip files with
|
||||
OpenPype update packages. To read more about preparing OpenPype for automatic updates go to [Admin Distribute docs](admin_distribute.md#2-openpype-codebase)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
|
|||
|
||||
To build Pype you currently need (on all platforms):
|
||||
|
||||
- **[Python 3.7](https://www.python.org/downloads/)** as we are following [vfx platform](https://vfxplatform.com).
|
||||
- **[Python 3.9](https://www.python.org/downloads/)** as we are following [vfx platform CY2022](https://vfxplatform.com).
|
||||
- **[git](https://git-scm.com/downloads)**
|
||||
|
||||
We use [CX_Freeze](https://cx-freeze.readthedocs.io/en/latest) to freeze the code and all dependencies and
|
||||
|
|
@ -114,8 +114,8 @@ To build OpenPype on Linux you will need:
|
|||
- **[curl](https://curl.se)** on systems that doesn't have one preinstalled.
|
||||
- **bzip2**, **readline**, **sqlite3** and other libraries.
|
||||
|
||||
Because some Linux distros come with newer Python version pre-installed, you might
|
||||
need to install **3.7** version and make use of it explicitly.
|
||||
Because some Linux distros come with older Python version pre-installed, you might
|
||||
need to install **3.9** version and make use of it explicitly.
|
||||
Your best bet is probably using [pyenv](https://github.com/pyenv/pyenv).
|
||||
|
||||
You can use your package manager to install **git** and other packages to your build
|
||||
|
|
@ -136,16 +136,16 @@ $ eval "$(pyenv virtualenv-init -)"
|
|||
# reload shell
|
||||
$ exec $SHELL
|
||||
|
||||
# install Python 3.7.10
|
||||
# install Python 3.9.6
|
||||
# python will be downloaded and build so please make sure
|
||||
# you have all necessary requirements installed (see below).
|
||||
$ pyenv install -v 3.7.10
|
||||
$ pyenv install -v 3.9.6
|
||||
|
||||
# change path to pype 3
|
||||
$ cd /path/to/pype-3
|
||||
|
||||
# set local python version
|
||||
$ pyenv local 3.7.10
|
||||
$ pyenv local 3.9.6
|
||||
```
|
||||
:::note Install build requirements for **Ubuntu**
|
||||
|
||||
|
|
@ -220,19 +220,19 @@ $ exec "$SHELL"
|
|||
$ PATH=$(pyenv root)/shims:$PATH
|
||||
```
|
||||
|
||||
4) Pull in required Python version 3.7.x
|
||||
4) Pull in required Python version 3.9.x
|
||||
```shell
|
||||
# install Python build dependences
|
||||
$ brew install openssl readline sqlite3 xz zlib
|
||||
|
||||
# replace with up-to-date 3.7.x version
|
||||
$ pyenv install 3.7.9
|
||||
# replace with up-to-date 3.9.x version
|
||||
$ pyenv install 3.9.6
|
||||
```
|
||||
|
||||
5) Set local Python version
|
||||
```shell
|
||||
# switch to Pype source directory
|
||||
$ pyenv local 3.7.9
|
||||
$ pyenv local 3.9.6
|
||||
```
|
||||
|
||||
6) Install `create-dmg`
|
||||
|
|
@ -256,7 +256,7 @@ to `pyproject.toml` to `[tool.poetry.dependencies]` section.
|
|||
|
||||
```toml title="/pyproject.toml"
|
||||
[tool.poetry.dependencies]
|
||||
python = "3.7.*"
|
||||
python = "3.9.*"
|
||||
aiohttp = "^3.7"
|
||||
aiohttp_json_rpc = "*" # TVPaint server
|
||||
acre = { git = "https://github.com/pypeclub/acre.git" }
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ The main things you will need to run and build pype are:
|
|||
- **Terminal** in your OS
|
||||
- PowerShell 5.0+ (Windows)
|
||||
- Bash (Linux)
|
||||
- [**Python 3.7.9**](#python) or higher
|
||||
- [**Python 3.9.x**](#python)
|
||||
- [**MongoDB**](#database)
|
||||
|
||||
|
||||
|
|
@ -55,13 +55,14 @@ To run mongoDB on server, use your server distribution tools to set it up (on Li
|
|||
|
||||
## Python
|
||||
|
||||
**Python 3.7.8** is the recommended version to use (as per [VFX platform CY2021](https://vfxplatform.com/)).
|
||||
**Python 3.9.x** is the recommended version to use (as per [VFX platform CY2022](https://vfxplatform.com/)).
|
||||
**Note**: We do not support 3.9.0 because of [this bug](https://github.com/python/cpython/pull/22670). Please, use higher versions of 3.9.x.
|
||||
|
||||
If you're planning to run openPYPE on workstations from built executables (highly recommended), you will only need python for building and development, however, if you'd like to run from source centrally, every user will need python installed.
|
||||
If you're planning to run openPYPE on workstations from built executables (highly recommended), you will only need python for building and development, however, if you'd like to run from source centrally, every user will need python installed.
|
||||
|
||||
## Hardware
|
||||
|
||||
openPYPE should be installed on all workstations that need to use it, the same as any other application.
|
||||
openPYPE should be installed on all workstations that need to use it, the same as any other application.
|
||||
|
||||
There are no specific requirements for the hardware. If the workstation can run
|
||||
the major DCCs, it most probably can run openPYPE.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue