added ftrack action for start timer

pype/ftrack/actions/action_start_clockify.py

@@ -0,0 +1,102 @@
+import sys
+import argparse
+import logging
+
+import ftrack_api
+from pype.ftrack import BaseAction
+from pype.clockify import ClockifyAPI
+
+
+class StartClockify(BaseAction):
+    '''Starts timer on clockify.'''
+
+    #: Action identifier.
+    identifier = 'start.clockify.timer'
+    #: Action label.
+    label = 'Start timer'
+    #: Action description.
+    description = 'Starts timer on clockify'
+    #: roles that are allowed to register this action
+    icon = 'https://clockify.me/assets/images/clockify-logo.png'
+    #: Clockify api
+    clockapi = ClockifyAPI()
+
+    def discover(self, session, entities, event):
+        if len(entities) != 1:
+            return False
+        if entities[0].entity_type.lower() != 'task':
+            return False
+        return True
+
+    def launch(self, session, entities, event):
+        task = entities[0]
+        task_name = task['name']
+        project_name = task['project']['full_name']
+
+        def get_parents(entity):
+            output = []
+            if entity.entity_type.lower() == 'project':
+                return output
+            output.extend(get_parents(entity['parent']))
+            output.append(entity['name'])
+
+            return output
+
+        desc_items = get_parents(task['parent'])
+        description = '/'.join(desc_items)
+
+        self.clockapi.start_time_entry(
+            description=description,
+            project_name=project_name,
+            task_name=task_name,
+        )
+
+        return True
+
+
+def register(session, **kw):
+    '''Register plugin. Called when used as an plugin.'''
+
+    if not isinstance(session, ftrack_api.session.Session):
+        return
+
+    StartClockify(session).register()
+
+
+def main(arguments=None):
+    '''Set up logging and register action.'''
+    if arguments is None:
+        arguments = []
+
+    parser = argparse.ArgumentParser()
+    # Allow setting of logging level from arguments.
+    loggingLevels = {}
+    for level in (
+        logging.NOTSET, logging.DEBUG, logging.INFO, logging.WARNING,
+        logging.ERROR, logging.CRITICAL
+    ):
+        loggingLevels[logging.getLevelName(level).lower()] = level
+
+    parser.add_argument(
+        '-v', '--verbosity',
+        help='Set the logging output verbosity.',
+        choices=loggingLevels.keys(),
+        default='info'
+    )
+    namespace = parser.parse_args(arguments)
+
+    # Set up basic logging
+    logging.basicConfig(level=loggingLevels[namespace.verbosity])
+
+    session = ftrack_api.Session()
+    register(session)
+
+    # Wait for events
+    logging.info(
+        'Registered actions and listening for events. Use Ctrl-C to abort.'
+    )
+    session.event_hub.wait()
+
+
+if __name__ == '__main__':
+    raise SystemExit(main(sys.argv[1:]))