Installing¶
Pre-built packages are available for download for Windows, Linux and Mac from the Integrations webpage.
Note
Alternative installation methods require technical knowledge.
Building from source¶
You can also build manually from the source for more control. First obtain a copy of the source by either downloading the zipball or cloning the public repository:
$ git clone git@bitbucket.org:ftrack/ftrack-connect.git
install the requirements to prepare you environment with:
$ python -m pip install -r requirements.txt
Then you can build and install the package into your current Python site-packages folder:
$ python setup.py install
Alternatively, just build locally and manage yourself:
$ python setup.py build
Is also possible to build live development version using:
$ python setup.py build_ext --inplace
Building from git repository¶
Note
This is an advance method and is not suggested for average users Please refer to the previous way to install as default.
Alternatively, install using pip:
$ pip install git+https://bitbucket.org/ftrack/ftrack-connect.git
Warning
When installing through pip, the default hooks will not be properly installed as part of the package, but they’ll instead be installed on the root of the interpreter eg:
C:\Python37\ftrack_connect_resource\hook
Before starting connect please ensure the path is added to your
- FTRACK_EVENT_PLUGIN_PATH
environment variable.
Building documentation from source¶
To build the documentation from source:
$ python setup.py build_sphinx
Then view in your browser:
file:///path/to/ftrack-connect/build/doc/html/index.html
Running tests against the source¶
With a copy of the source it is also possible to run the unit tests:
$ python setup.py test