ftrack connect publisher widget

ftrack connect publisher widget

Installing

Installation is simple with pip:

pip install ftrack-connect-publisher-widget

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-publisher-widget.git

Then you can build and install the package into your current Python site-packages folder:

python setup.py build_plugin

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-publisher-widget/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

Dependencies

Additional For building

Additional For testing

Using

Publishing

Connect provides a simple publisher application to support publishing files directly from your computer without the need to open another application (though publishing from within many applications, including from the ftrack web interface, is also supported).

To publish, ensure you have the interface open by selecting Open from the service context menu and then selecting the Publish tab.

_images/publisher_tab.png

Add components

Drag and drop files from your computer onto the publisher (or use the Browse button to browse and select files).

Note

Sequences of files will be automatically detected and added as one entry.

_images/publisher_drop_files.png

Each file will be added as a component with a name based on the filename of the file. You can manually edit the name if desired by clicking in the name of the component and typing a new name.

_images/publisher_edit_component_name.png

Components can be removed by clicking the Remove icon next to each entry.

Select a linked entity

To change the entity that the publish will be linked to, click the Browse button next to the Linked Entity field.

_images/publisher_linked_entity_field.png

A browser, similar to the file browser, will appear, but it allows browsing ftrack rather than the filesystem.

_images/entity_browser.png

You can navigate through a project structure by double clicking on items in the list. A navigation bar at the top will show you where you are and you can also click an item in the navigation bar to jump back up the hierarchy. Alternatively, use the neighbouring Navigate Up tool button to move up a level at a time.

Note

If an item you expect to see in the list is not appearing, try clicking the Reload tool button to refresh the list from the server.

To select the entity to link against, select an item in the list and then click the Choose button. Alternatively, to cancel making any changes click the Cancel button.

Choose or create asset

You can now choose if you like to publish a new version of an previously published asset or if you like to publish the first version of a new asset.

_images/publisher_asset_options.png

To create a new asset, select Create new and fill in the following options.

Type

The type of asset to publish. Choose from a list retrieved from the connected ftrack server.

Name

The name of asset to publish. The name and type must be unique when creating new assets.

To publish a new version of an existing asset, select Version up existing instead. In the list which is shown below the radio buttons, select the asset you wish to use.

_images/publisher_asset_existing.png

Fill out remaining fields

Fill out the remaining fields in the publisher.

_images/publisher_filled_out.png
Web playable

If you want one of the components to be encoded for playing on the web select it in this field from the list of components added.

Thumbnail

Drag and drop a small thumbnail of the asset onto this field to give others a better indication of what the asset is before opening.

Description

A brief description of the published asset or the changes made since the last published version.

Publish

When ready, press Publish to start the publish. During this time you will see a progress indicator.

_images/publisher_publish_progress.png

Important

Do not quit the service whilst the publish is in progress.

Once completed, the indicator will change to a notification.

_images/publisher_publish_success.png

API reference

ftrack_connect_publisher_widget

Release and migration notes

Find out information about what has changed between versions and any important migration notes to be aware of when switching to a new version.

Release Notes

0.1.1

18 May 2022
  • changed

    Move launcher base class from connect to widget.

0.1.0

14 April 2022
  • changed

    Localise publisher code in separate connect plugin widget.

Migration notes

No migration notes required at this time.

Glossary

Indices and tables