******* DEPRECATED REPOSITORY *******

This repository is publicly archived and will reach its EOL at the end of the year when it will be private and just available under request contacting our support team at support@ftrack.com.

We are currently moving our repositories to a new monorepo structure https://github.com/ftrackhq/integrations. The monorepo is currently private during the migration, but we are working hard to open it publicly as soon as we can. Meanwhile, we will not do any new updates in the current repository.

Don't hesitate on contact our support team if you have any inquiries: support@ftrack.com

ftrack connect package

Meta package that provides support for building platform specific bundles of ftrack connect packages.

Clone the public repository:

$ git clone git@bitbucket.org:ftrack/ftrack-connect-package.git

Or download and extract the zipball

Clone ftrack connect public repository:

$ git clone git@bitbucket.org:ftrack/ftrack-connect.git

Or download and extract the zipball

Create and activate a virtual environment with python3.7

Note

If in windows, please create the virtual env using venv.

Install dependencies with:

$ pip install -r <ftrack-connect-package>/requirements.txt

Warning

( Windows only )

Visual studio and c++ build tools should be installed before install the requirements.

Reference: (link)

Note

cx_freeze branch installation is temporary until cx_freeze > 6.5 version is released. ( 3.7 )

Install ftrack connect:

$ cd <ftrack-connect>
$ pip install -r <ftrack-connect>/requirements.txt
$ python setup.py install

Build connect package with (specific build package):

$ cd <ftrack-connect-package>

Linux

Build tar.gz release with:

$ python setup.py build_exe

Once build the result will be available in build/exe.linux-x86_64-<PYTHON VERSION>

To generate the tar.gz run from the build folder:

$ tar -zcvf ftrack-connect-package-<PACKAGE VERSION>-<PLATFORM>.tar.gz exe.linux-x86_64-3.7 --transform 's/exe.linux-x86_64-3.7/ftrack-connect-package/'

Generate the md5 with:

$ md5sum ftrack-connect-package-<PACKAGE VERSION>-<PLATFORM>.tar.gz > ftrack-connect-package-<PACKAGE VERSION>-<PLATFORM>.tar.gz.md5

Note

Please remember to set <PLATFORM> to either:

• C7 for Centos 7 compatible releases.
• C8 for centos 8 compatible releases.

Windows

Build msi release with:

$ python setup.py bdist_msi

Note

Codesign process works only on machine where the key certificate is loaded and available. Codesign also require to have the signtool.exe installed and available.

To codesign

Preparation

• Install signtool.exe from https://docs.microsoft.com/en-us/dotnet/framework/tools/signtool-exe
• If you download the Windows 10 SDK, the signtools is located here (version number may vary): "C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64\signtool.exe"
• Download and install the certificate .p12 certificate.

Once the msi is built, run the following commands to codesign it:

$ signtool sign /tr http://timestamp.sectigo.com /td sha256 /fd sha256 /a <path to msi file>

At the end of the process you'll then asked to provide your token password, once done, the package should get codesigned.

MacOs

Preparation

Install appdmg to be able to create the dmg:

$ npm install -g appdmg

Note

On latest version of OSX these envs are needed in order to properly build:

$ export CPPFLAGS=-I/usr/local/opt/openssl/include
$ export LDFLAGS=-L/usr/local/opt/openssl/lib

To build without codesign

Build with:

$ python setup.py bdist_mac

To build and codesign

Set your certificate id to CODESIGN_IDENTITY:

$ export CODESIGN_IDENTITY="<your_certificate_id_here>"

Set your Apple username to APPLE_USER_NAME:

$ export APPLE_USER_NAME="<your_apple_user>"

Set your APP-specific password generated on https://appleid.apple.com/account/manage to the keychain under the name ftrack_connect_sign_pass.

Execute the following build command and follow the instructions:

$ python setup.py bdist_mac --codesign_frameworks --codesign --create_dmg --notarize

Docker

As part of this repository, 3 Dockerfiles are available to sendbox the build of ftrack-connect-package.

• C7.Dockerfile [centos 7]
• C8.Dockerfile [centos 8]
• Win10.Dockerfile [windows 10]

For further information, please use the README file contained in the docker folder.

Note

In order to build in docker windows, you need to have a windows 10 Pro activated and configured.

Known Issues

• None

Dependencies

• Python >= 3.7, < 3.8
• ftrack-connect >= 2.0, < 3.0