diff --git a/README.md b/README.md index 6dd1342f..08ac0416 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Linting](https://img.shields.io/badge/PEP8%20by-Hound%20CI-a873d1.svg)](https://houndci.com) -# Shotgun Event Framework +# Flow Production Tracking Event Framework This software was originaly developed by [Patrick Boucher](http://www.patrickboucher.com) with support from [Rodeo Fx](http://rodeofx.com) and Oblique. It is now part of -[Shotgun Software](http://www.shotgunsoftware.com)'s [open source +[Flow Production Tracking Software](https://www.autodesk.com/products/flow-production-tracking)'s [open source initiative](https://github.com/shotgunsoftware). This software is provided under the MIT License that can be found in the LICENSE @@ -16,7 +16,7 @@ file or at the [Open Source Initiative](http://www.opensource.org/licenses/mit-l ## Overview -When you want to access the Shotgun event stream, the preferred way to do so it +When you want to access the Flow Production Tracking event stream, the preferred way to do so it to monitor the events table, get any new events, process them and repeat. A lot of stuff is required for this process to work successfully, stuff that may @@ -34,7 +34,7 @@ The daemon handles: - Registering plugins from one or more specified paths. - Deactivate any crashing plugins. - Reloading plugins when they change on disk. -- Monitoring the Shotgun event stream. +- Monitoring the Flow Production Tracking event stream. - Remembering the last processed event id and any backlog. - Starting from the last processed event id on daemon startup. - Catching any connection errors. diff --git a/src/examplePlugins/docs/logArgs.md b/src/examplePlugins/docs/logArgs.md index 857d28ff..948aee8f 100644 --- a/src/examplePlugins/docs/logArgs.md +++ b/src/examplePlugins/docs/logArgs.md @@ -2,7 +2,7 @@ This is an EXAMPLE PLUGIN. -Use this plugin to determine if the Shotgun Event Daemon has been successfully +Use this plugin to determine if the Flow Production Tracking Event Daemon has been successfully installed. It will log all events in Shotgun by spitting out the event dictionary. diff --git a/src/examplePlugins/entity_status_update_task_status.py b/src/examplePlugins/entity_status_update_task_status.py index 97cc844b..00d8fc50 100644 --- a/src/examplePlugins/entity_status_update_task_status.py +++ b/src/examplePlugins/entity_status_update_task_status.py @@ -10,7 +10,7 @@ """ This plugin was created for the Shotgun Developer Learning series video titled, -"The Shotgun Event Daemon." See this page for details: +"The Flow Production Tracking Event Daemon." See this page for details: https://support.shotgunsoftware.com/hc/en-us/articles/115002525494-SG-Learning-Developer-Training @@ -29,7 +29,7 @@ def registerCallbacks(reg): """ - This function is run when the Shotgun Event Daemon starts, if this file + This function is run when the Flow Production Tracking Event Daemon starts, if this file (__file__) lives in the plugin directory specified by the daemon's config file. Typically the registerCallback method should be called from the available reg object. diff --git a/src/shotgunEventDaemon.conf.example b/src/shotgunEventDaemon.conf.example index 8f2f909d..4d38b6b2 100644 --- a/src/shotgunEventDaemon.conf.example +++ b/src/shotgunEventDaemon.conf.example @@ -123,5 +123,5 @@ from: support@yourdomain.com to: you@yourdomain.com # An email subject prefix that can be used by mail clients to help sort out -# alerts sent by the Shotgun event framework. +# alerts sent by the Flow Production Tracking event framework. subject: [SG] diff --git a/src/shotgunEventDaemon.py b/src/shotgunEventDaemon.py index 8924b61d..8b2a4f6c 100755 --- a/src/shotgunEventDaemon.py +++ b/src/shotgunEventDaemon.py @@ -1,9 +1,9 @@ #!/usr/bin/env python # -# Init file for Shotgun event daemon +# Init file for Flow Production Tracking event daemon # # chkconfig: 345 99 00 -# description: Shotgun event daemon +# description: Flow Production Tracking event daemon # ### BEGIN INIT INFO # Provides: shotgunEvent @@ -12,8 +12,8 @@ # Required-Stop: $network # Should-Stop: $remote_fs # Default-Start: 2 3 4 5 -# Short-Description: Shotgun event daemon -# Description: Shotgun event daemon +# Short-Description: Flow Production Tracking event daemon +# Description: Flow Production Tracking event daemon ### END INIT INFO """ @@ -530,7 +530,7 @@ def _getNewEvents(self): Fetch new events from Shotgun. @return: Recent events that need to be processed by the engine. - @rtype: I{list} of Shotgun event dictionaries. + @rtype: I{list} of Flow Production Tracking event dictionaries. """ nextEventId = None for newId in [ @@ -1004,7 +1004,7 @@ def __getattr__(self, name): class Callback(object): """ - A part of a plugin that can be called to process a Shotgun event. + A part of a plugin that can be called to process a Flow Production Tracking event. """ def __init__( @@ -1018,7 +1018,7 @@ def __init__( stopOnError=True, ): """ - @param callback: The function to run when a Shotgun event occurs. + @param callback: The function to run when a Flow Production Tracking event occurs. @type callback: A function object. @param engine: The engine that will dispatch to this callback. @type engine: L{Engine}. @@ -1090,7 +1090,7 @@ def process(self, event): If an error occurs, it will be logged appropriately and the callback will be deactivated. - @param event: The Shotgun event to process. + @param event: The Flow Production Tracking event to process. @type event: I{dict} """ # set session_uuid for UI updates @@ -1242,7 +1242,7 @@ def emit(self, record): class EventDaemonError(Exception): """ - Base error for the Shotgun event system. + Base error for the Flow Production Tracking event system. """ pass @@ -1264,7 +1264,7 @@ class WindowsService(win32serviceutil.ServiceFramework): """ _svc_name_ = "ShotgunEventDaemon" - _svc_display_name_ = "Shotgun Event Handler" + _svc_display_name_ = "Flow Production Tracking Event Handler" def __init__(self, args): win32serviceutil.ServiceFramework.__init__(self, args)