🕑 Read time: 2 min | Article Quick Search

This article helps developers to install ftrack Connect from source or pip for customization. These steps can be skipped for most users.

Article Quick Search:

Advanced installation

ftrack Connect can be built and installed from source or by using pip. This method is only recommended for advanced users to customize ftrack Connect and won’t be necessary for most users.

Building and installing from source

  1. Obtain a copy of the source by downloading the zipball or cloning the public repository:

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

  2.  Build and install the package into your current Python site-packages folder:

    python setup.py install

    Alternatively, you can build locally and manage yourself:

    python setup.py build 

Building documentation from source

To build the documentation from source, run:

python setup.py build_sphinx

To view, copy the following path into your browser:

file:///path/to/ftrack-connect/build/doc/html/index.html  `

Running tests against the source

You can run unit tests with a copy of the source:

python setup.py test 

There are interactive tests for many of the widgets that can be run directly once you have configured your environment to include the built package:

python test/interactive/timer.py 

Installing using pip

Install via pip by running:

pip install git+https://bitbucket.org/ftrack/ftrack-connect.git 

Advanced launching

If you are using alternative installation methods, such as building from source or installing through pip, you should open a terminal and execute the following:

python -m ftrack_connect 

To see all available launching options (logging verbosity etc.), use:

python -m ftrack_connect --help 

Advanced use via environment variable

Advanced users may want to control where Connect looks for plugins. You may want to do this to centralize hooks on a shared network for everyone in the company or just want to have them in a different location than default.

By setting the FTRACK_CONNECT_PLUGIN_PATH environment variable, you can add additional locations where plugin hooks are discovered. E.g:

export FTRACK_CONNECT_PLUGIN_PATH=/Users/<user>/Desktop/my-plugins

Did this answer your question?