For #45533, addressed PR comments (moved plugins to examples folder).

src/standardPlugins/assign_to_project.py → src/examplePlugins/assign_to_project.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import shotgun_api3
 

src/standardPlugins/calc_field.py → src/examplePlugins/calc_field.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 from __future__ import division
 import os
 import shotgun_api3

src/standardPlugins/calc_summaries.py → src/examplePlugins/calc_summaries.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 from __future__ import division
 import os
 import shotgun_api3

src/standardPlugins/calculate_cut_length.py → src/examplePlugins/calculate_cut_length.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import math
 import shotgun_api3

src/standardPlugins/convert_currency.py → src/examplePlugins/convert_currency.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import shotgun_api3
 

src/standardPlugins/create_note_from_version_field.py → src/examplePlugins/create_note_from_version_field.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import shotgun_api3
 

src/standardPlugins/datestamp.py → src/examplePlugins/datestamp.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import shotgun_api3
 import pytz

src/examplePlugins/docs/logArgs.md

@@ -0,0 +1,11 @@
+# logArgs.py
+
+This is an EXAMPLE PLUGIN.
+
+Use this plugin to determin if the Shotgun Event Daemon has been successfully
+installed. It will log all events in Shotgun by spitting out the event
+dictionary.
+
+## Args
+
+No settings.

src/examplePlugins/docs/sharedStateA.md

@@ -0,0 +1,17 @@
+# sharedStateA.py
+
+This is an EXAMPLE PLUGIN.
+
+Global variable shared state.
+
+This plugin demoes how three callbacks can share state through a global variable.
+
+The shared state stores two counters one (sequential) will be incremented
+sequentially by each callback and will keep incrementing across event ids.
+
+The second counter (rotating) will be incremented by each successive callback
+but will be reset at each new event.
+
+## Args
+
+No settings.

src/examplePlugins/docs/sharedStateB.md

@@ -0,0 +1,18 @@
+# sharedStateB.py
+
+This is an EXAMPLE PLUGIN.
+
+Args based shared state.
+
+This plugin demoes how three callbacks can share state through the args argument
+to registerCallback.
+
+The shared state stores two counters one (sequential) will be incremented
+sequentially by each callback and will keep incrementing across event ids.
+
+The second counter (rotating) will be incremented by each successive callback
+but will be reset at each new event.
+
+## Args
+
+No settings.

src/examplePlugins/docs/sharedStateC.md

@@ -0,0 +1,17 @@
+# sharedStateC.py
+
+This is an EXAMPLE PLUGIN.
+
+Object based shared state.
+
+This example aims to show that you can store state in callable object instances.
+
+The shared state stores two counters one (sequential) will be incremented
+sequentially by each callback and will keep incrementing across event ids.
+
+The second counter (rotating) will be incremented by each successive callback
+but will be reset at each new event.
+
+## Args
+
+No settings.

src/standardPlugins/field_to_field.py → src/examplePlugins/field_to_field.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import shotgun_api3
 

src/standardPlugins/init_entity.py → src/examplePlugins/init_entity.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 import shotgun_api3
 

src/standardPlugins/init_shot_handles.py → src/examplePlugins/init_shot_handles.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 import os
 
 

src/standardPlugins/link_shot_to_sequence.py → src/examplePlugins/link_shot_to_sequence.py

@@ -5,6 +5,8 @@
 # this software in either electronic or hard copy form.
 #
 
+# See docs folder for detailed usage info.
+
 """
 Required fields
     Shot entity:

src/examplePlugins/logArgs.py

@@ -1,51 +1,64 @@
-"""
-For detailed information please see
+# Copyright 2018 Autodesk, Inc.  All rights reserved.
+#
+# Use of this software is subject to the terms of the Autodesk license agreement
+# provided at the time of installation or download, or which otherwise accompanies
+# this software in either electronic or hard copy form.
+#
 
-http://shotgunsoftware.github.com/shotgunEvents/api.html
-"""
+# See docs folder for detailed usage info.
+
+import os
 import logging
 
 
 def registerCallbacks(reg):
-    """Register all necessary or appropriate callbacks for this plugin."""
+    """
+    Register all necessary or appropriate callbacks for this plugin.
+    """
 
     # Specify who should recieve email notifications when they are sent out.
     #
-    #reg.setEmails('me@mydomain.com')
+    # reg.setEmails('me@mydomain.com')
 
-    # Use a preconfigured logging.Logger object to report info to log file or
+    # Use a preconfigured logging.Logger object to report info to a log file or
     # email. By default error and critical messages will be reported via email
-    # and logged to file, all other levels are logged to file.
+    # and logged to file, all other levels are logged to a file.
     #
-    #reg.logger.debug('Loading logArgs plugin.')
+    # reg.logger.debug('Loading logArgs plugin.')
 
     # Register a callback to into the event processing system.
     #
     # Arguments:
     # - Shotgun script name
     # - Shotgun script key
     # - Callable
-    # - Argument to pass through to the callable
     # - A filter to match events to so the callable is only invoked when
     #   appropriate
+    # - Argument to pass through to the callable
     #
-    #eventFilter = {'Shotgun_Task_Change': ['sg_status_list']}
+    # eventFilter = {'Shotgun_Task_Change': ['sg_status_list']}
     eventFilter = None
-    reg.registerCallback('$DEMO_SCRIPT_NAME$', '$DEMO_API_KEY$', logArgs, eventFilter, None)
+    reg.registerCallback(
+        os.environ["SGDAEMON_LOGARGS_NAME"],
+        os.environ["SGDAEMON_LOGARGS_KEY"],
+        logArgs,
+        eventFilter,
+        None,
+    )
 
-    # Set the logging level for this particular plugin. Let error and above
-    # messages through but block info and lower. This is particularly usefull
+    # Set the logging level for this particular plugin. Let debug and above
+    # messages through (don't block info, etc). This is particularly usefull
     # for enabling and disabling debugging on a per plugin basis.
-    reg.logger.setLevel(logging.ERROR)
+    reg.logger.setLevel(logging.DEBUG)
 
 
 def logArgs(sg, logger, event, args):
     """
     A callback that logs its arguments.
 
-    @param sg: Shotgun instance.
-    @param logger: A preconfigured Python logging.Logger object
-    @param event: A Shotgun event.
-    @param args: The args passed in at the registerCallback call.
+    :param sg: Shotgun API handle.
+    :param logger: Logger instance.
+    :param event: A Shotgun EventLogEntry entity dictionary.
+    :param args: Any additional misc arguments passed through this plugin.
     """
     logger.info("%s" % str(event))

src/examplePlugins/sharedStateA.py

@@ -1,28 +1,13 @@
-"""
-For detailed information please see
+# Copyright 2018 Autodesk, Inc.  All rights reserved.
+#
+# Use of this software is subject to the terms of the Autodesk license agreement
+# provided at the time of installation or download, or which otherwise accompanies
+# this software in either electronic or hard copy form.
+#
 
-http://shotgunsoftware.github.com/shotgunEvents/api.html
+# See docs folder for detailed usage info.
 
-
-Global variable shared state
-----------------------------
-
-This plugin demoes how three callbacks can share state through a global variable.
-
-The shared state stores two counters one (sequential) will be incremented
-sequentially by each callback and will keep incrementing across event ids.
-
-The second counter (rotating) will be incremented by each successive callback
-but will be reset at each new event.
-
-
-Try me
-------
-
-To try the plugin, make sure you copy it into a path mentioned in your .conf's
-"paths" ([plugin] section) and change $DEMO_SCRIPT_NAME$ and $DEMO_API_KEY$ for
-sane values.
-"""
+import os
 
 _state = {
     'sequential': -1,
@@ -31,10 +16,12 @@
 
 
 def registerCallbacks(reg):
-    """Register all necessary or appropriate callbacks for this plugin."""
+    """
+    Register all necessary or appropriate callbacks for this plugin.
+    """
 
-    scriptName = '$DEMO_SCRIPT_NAME$'
-    scriptKey = '$DEMO_API_KEY$'
+    scriptName = os.environ["SGDAEMON_SHAREDSTATEA_NAME"]
+    scriptKey = os.environ["SGDAEMON_SHAREDSTATEA_KEY"]
 
     # Callbacks are called in registration order. So callbackA will be called
     # before callbackB and callbackC
@@ -44,6 +31,13 @@ def registerCallbacks(reg):
 
 
 def callbackA(sg, logger, event, args):
+    """
+    :param sg: Shotgun API handle.
+    :param logger: Logger instance.
+    :param event: A Shotgun EventLogEntry entity dictionary.
+    :param args: Any additional misc arguments passed through this plugin.
+    """
+
     # We know callbackA will be called first because we registered it first.
     # As the first thing to run on each event, we can reinizialize the rotating
     # counter.