ftrack connect action launcher widget

ation launcher widget

Installing

Installation is simple with pip:

pip install ftrack-connect-action-launcher-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-action-launcher-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-action-launcher-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

• Python >= 2.7, < 3

Additional For building

• Sphinx >= 1.2.2, < 2

• sphinx_rtd_theme >= 0.1.6, < 1

• Lowdown >= 0.1.0, < 2

Additional For testing

• Pytest >= 2.3.5

Using

Using integrations and actions

The pre-built packages installed from the Integrations webpage contains a set of integrations with different creative applications. These integrations can be launched directly from Connect or the ftrack web interface through the use of Actions.

Connect provides an interface in the standalone application to run your actions. Actions in ftrack provide a standardised way to integrate other tools, either off-the-shelf or custom built, directly into your ftrack workflow.

Using actions you can, for example, launch applications for a task you are working on, generate a custom report or generate your entire filesystem structure for a project with one click.

See also

ftrack:using/actions

Launching actions in Connect

To launch an action, select an entity for which to launch the action and press the action in the list below.

Actions are grouped based on their label and a context menu will be shown if multiple variants are available.

See also

You can also launch actions from the web interface.

ftrack:using/actions

Limitations

Connect will currently only list actions available in the running process and will therefore not include actions running on any remote servers.

Actions in connect does currently not support custom UI. You will see an error message if you try to run an action which returns an UI configuration.

API reference

ftrack_connect_action_launcher_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 action launcher code in separate connect plugin widget.

Migration notes

No migration notes required at this time.

Glossary

Indices and tables

• Index

• Module Index

• Search Page

Copyright and license

Copyright (c) 2022 ftrack

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE.txt file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.