SG-34308 - Rebranding (#24)

* Change all the shotgrid/shotgun occurrences in the repository. * Change all the SG occurrences in the repository. * Change all the SG occurrences in the repository. * Update text occurrences. * Update text.
shotgunsoftware · Mar 20, 2024 · 1e7088a · 1e7088a
1 parent 47b728d
commit 1e7088a
Show file tree

Hide file tree

Showing 9 changed files with 88 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 [![Linting](https://img.shields.io/badge/PEP8%20by-Hound%20CI-a873d1.svg)](https://houndci.com)
 
 ## Documentation
-This repository is a part of the ShotGrid Pipeline Toolkit.
+This repository is a part of the Flow Production Tracking Toolkit.
 
 - For more information about this app and for release notes, *see the wiki section*.
 - For general information and documentation, click here: https://help.autodesk.com/view/SGDEV/ENU/?contextId=SA_INTEGRATIONS_USER_GUIDE
-- For information about ShotGrid in general, click here: https://help.autodesk.com/view/SGSUB/ENU/
+- For information about Flow Production Tracking in general, click here: https://help.autodesk.com/view/SGSUB/ENU/
 
 ## Using this app in your Setup
 All the apps that are part of our standard app suite are pushed to our App Store.

diff --git a/SECURITY.md b/SECURITY.md
@@ -4,18 +4,18 @@
 
 At Autodesk, we know that the security of your data is critical to your studio’s
 operation.
-As the industry shifts to the cloud, ShotGrid knows that security and service
+As the industry shifts to the cloud, Flow Production Tracking knows that security and service
 models are more important than ever.
 
 The confidentiality, integrity, and availability of your content is at the top
 of our priority list.
-Not only do we have a team of ShotGrid engineers dedicated to platform security
+Not only do we have a team of Flow Production Tracking engineers dedicated to platform security
 and performance, we are also backed by Autodesk’s security team, also invests
 heavily in the security for broad range of industries and customers.
 We constantly reassess, develop, and improve our risk management program because
 we know that the landscape of security is ever-changing.
 
-If you believe you have found a security vulnerability in any ShotGrid-owned
+If you believe you have found a security vulnerability in any Flow Production Tracking-owned
 repository, please report it to us as described below.
 
 
@@ -32,4 +32,4 @@ configurations, reproduction steps, exploit code, impact, etc.
 
 ## Additional Information
 
-Please check out the [ShotGrid Security White Paper](https://help.autodesk.com/view/SGSUB/ENU/?guid=SG_Administrator_ar_general_security_ar_security_white_paper_html).
+Please check out the [Flow Production Tracking Security White Paper](https://help.autodesk.com/view/SGSUB/ENU/?guid=SG_Administrator_ar_general_security_ar_security_white_paper_html).
diff --git a/engine.py b/engine.py
@@ -79,8 +79,9 @@ def pre_app_init(self):
         ):
             # this is a completely unsupported version of Mari!
             raise TankError(
-                "This version of Mari (%d.%dv%d) is not supported by SG Toolkit.  The"
-                "minimum required version is %d.%dv%d."
+                "This version of Mari (%d.%dv%d) is not supported by "
+                "Flow Production Tracking. The minimum required "
+                "version is %d.%dv%d."
                 % (
                     mari_version.major(),
                     mari_version.minor(),
@@ -96,9 +97,9 @@ def pre_app_init(self):
         ):
             # this is an untested version of Mari
             msg = (
-                "The SG Pipeline Toolkit has not yet been fully tested with Mari %d.%dv%d. "
-                "You can continue to use the Toolkit but you may experience bugs or "
-                "instability.  Please report any issues you see via %s."
+                "The Flow Production Tracking has not yet been fully tested "
+                "with Mari %d.%dv%d. You can continue to use the Toolkit but you may "
+                "experience bugs or instability.  Please report any issues you see via %s."
                 % (
                     mari_version.major(),
                     mari_version.minor(),
@@ -114,7 +115,7 @@ def pre_app_init(self):
                 >= self.get_setting("compatibility_dialog_min_version")
             ):
                 # show the warning dialog the first time:
-                mari.utils.message(msg, "ShotGrid")
+                mari.utils.message(msg, "Flow Production Tracking")
                 os.environ["SGTK_MARI_VERSION_WARNING_SHOWN"] = "1"
 
             self.log_warning(msg)
@@ -283,7 +284,7 @@ def log_debug(self, msg):
         if not hasattr(self, "_debug_logging"):
             self._debug_logging = self.get_setting("debug_logging", False)
         if self._debug_logging:
-            print("SG Debug: %s" % msg)
+            print("PTR Debug: %s" % msg)
 
     def log_info(self, msg):
         """
@@ -297,7 +298,7 @@ def log_warning(self, msg):
         Log a warning
         :param msg:    The warning message to log
         """
-        msg = "SG Warning: %s" % msg
+        msg = "PTR Warning: %s" % msg
         print(msg)
         # mari.utils.message(msg)
 
@@ -306,7 +307,7 @@ def log_error(self, msg):
         Log an error
         :param msg:    The error message to log
         """
-        msg = "SG Error: %s" % msg
+        msg = "PTR Error: %s" % msg
         print(msg)
         mari.utils.message(msg)
 
@@ -334,7 +335,7 @@ def __on_project_opened(self, opened_project, is_new):
         if not md:
             # This project has never been opened with Toolkit running before
             # so don't need to do anything!
-            self.log_debug("Work area unchanged - the opened project is not SG aware!")
+            self.log_debug("Work area unchanged - the opened project is not PTR aware!")
             return
 
         # try to determine the project context from the metadata:
@@ -378,6 +379,6 @@ def __on_project_opened(self, opened_project, is_new):
             # start new engine with the new context:
             sgtk.platform.start_engine(self.name, ctx.sgtk, ctx)
         except TankError as e:
-            self.log_error("Failed to start SG engine for Work Area %s: %s" % (ctx, e))
+            self.log_error("Failed to start PTR engine for Work Area %s: %s" % (ctx, e))
         except Exception as e:
-            self.log_exception("Failed to start SG engine for Work Area %s" % ctx)
+            self.log_exception("Failed to start PTR engine for Work Area %s" % ctx)
diff --git a/hooks/tk-multi-publish2/basic/publish_mari_textures.py b/hooks/tk-multi-publish2/basic/publish_mari_textures.py
@@ -36,7 +36,7 @@ def name(self):
         """
         One line display name describing the plugin
         """
-        return "Publish to ShotGrid"
+        return "Publish to Flow Production Tracking"
 
     @property
     def description(self):
@@ -48,8 +48,8 @@ def description(self):
         loader_url = "https://help.autodesk.com/view/SGDEV/ENU/?contextId=PC_APP_LOADER"
 
         return """
-        Publishes the file to ShotGrid. A <b>Publish</b> entry will be
-        created in ShotGrid which will include a reference to the file's current
+        Publishes the file to Flow Production Tracking. A <b>Publish</b> entry will be
+        created in Flow Production Tracking which will include a reference to the file's current
         path on disk. Other users will be able to access the published file via
         the <b><a href='%s'>Loader</a></b> so long as they have access to
         the file's location on disk.
@@ -62,7 +62,7 @@ def description(self):
         file to the next version after publishing.
 
         The <code>version</code> field of the resulting <b>Publish</b> in
-        ShotGrid will also reflect the version number identified in the filename.
+        Flow Production Tracking will also reflect the version number identified in the filename.
         The basic worklfow recognizes the following version formats by default:
 
         <ul>
@@ -115,7 +115,7 @@ def settings(self):
             "Publish Type": {
                 "type": "shotgun_publish_type",
                 "default": "UDIM Image",
-                "description": "SG publish type to associate publishes with.",
+                "description": "PTR publish type to associate publishes with.",
             },
             "Publish Template": {
                 "type": "template",
@@ -289,7 +289,7 @@ def publish(self, settings, item):
         # are appropriate for current os, no double separators, etc.
         path = sgtk.util.ShotgunPath.normalize(publish_path)
 
-        self.logger.info("A Publish will be created in SG and linked to:")
+        self.logger.info("A Publish will be created in PTR and linked to:")
         self.logger.info("  %s" % (path,))
 
         if layer_name:
@@ -379,7 +379,7 @@ def finalize(self, settings, item):
 
         publisher = self.parent
 
-        # get the data for the publish that was just created in SG
+        # get the data for the publish that was just created in PTR
         publish_data = item.properties["sg_publish_data"]
 
         # ensure conflicting publishes have their status cleared
@@ -395,7 +395,7 @@ def finalize(self, settings, item):
             extra={
                 "action_show_in_shotgun": {
                     "label": "Show Publish",
-                    "tooltip": "Open the Publish in ShotGrid.",
+                    "tooltip": "Open the Publish in Flow Production Tracking.",
                     "entity": publish_data,
                 }
             },

diff --git a/info.yml b/info.yml
@@ -29,8 +29,8 @@ configuration:
 requires_shotgun_fields:
 
 # More verbose description of this item
-display_name: "ShotGrid Engine for Mari"
-description: "ShotGrid Integration in Mari"
+display_name: "Flow Production Tracking Engine for Mari"
+description: "Flow Production Tracking Integration in Mari"
 
 # Required minimum versions for this item to run
 requires_shotgun_version:

diff --git a/python/tk_mari/menu_generation.py b/python/tk_mari/menu_generation.py
@@ -100,13 +100,13 @@ def __init__(self, engine):
         self.__action_factory = ActionFactory()
 
     MAIN_MENU_SET = "MainWindow"
-    SHOTGUN_MENU_ROOT = "ShotGrid"
+    SHOTGUN_MENU_ROOT = "Flow Production Tracking"
 
     def create_menu(self):
         """
         Create the Shotgun menu
         """
-        self._engine.log_debug("Creating the SG menu for Mari...")
+        self._engine.log_debug("Creating the PTR menu for Mari...")
 
         shotgun_menu = "%s/%s" % (
             MenuGenerator.MAIN_MENU_SET,
@@ -119,7 +119,7 @@ def create_menu(self):
         # now enumerate all items and create menu objects for them
         menu_items = []
         for cmd_name, cmd_details in self._engine.commands.items():
-            # if not (cmd_name == "SG File Manager..." or cmd_name == "Version up Current Scene..."):
+            # if not (cmd_name == "PTR File Manager..." or cmd_name == "Version up Current Scene..."):
             menu_items.append(AppCommand(cmd_name, cmd_details, self.__action_factory))
 
         commands_by_app = {}
@@ -148,7 +148,7 @@ def destroy_menu(self):
         This has been logged with the Foundry (#2014080310000042).
 
         """
-        self._engine.log_debug("Destroying the SG menu for Mari...")
+        self._engine.log_debug("Destroying the PTR menu for Mari...")
 
         # clear the action factory:
         self.__action_factory.clear()
@@ -266,7 +266,7 @@ def __build_context_menu(self, shotgun_menu):
         )
         mari.menus.addAction(action, ctx_menu)
         action = self.__action_factory.create_action(
-            "Jump To ShotGrid", self._jump_to_sg
+            "Jump To Flow Production Tracking", self._jump_to_sg
         )
         mari.menus.addAction(action, ctx_menu)
 

diff --git a/python/tk_mari/metadata.py b/python/tk_mari/metadata.py
@@ -55,49 +55,80 @@ class MetadataManager(object):
 
     # Shotgun metadata definition for a Mari Project entity
     __PROJECT_METADATA_INFO = {
-        "project_id": {"display_name": "ShotGrid Project Id", "visible": False},
+        "project_id": {
+            "display_name": "Flow Production Tracking Project Id",
+            "visible": False,
+        },
         "entity_type": {
-            "display_name": "ShotGrid Entity Type",
+            "display_name": "Flow Production Tracking Entity Type",
             "visible": False,
             "default_value": "",
         },
-        "entity_id": {"display_name": "ShotGrid Entity Id", "visible": False},
-        "step_id": {"display_name": "ShotGrid Step Id", "visible": False},
-        "task_id": {"display_name": "ShotGrid Task Id", "visible": False},
+        "entity_id": {
+            "display_name": "Flow Production Tracking Entity Id",
+            "visible": False,
+        },
+        "step_id": {
+            "display_name": "Flow Production Tracking Step Id",
+            "visible": False,
+        },
+        "task_id": {
+            "display_name": "Flow Production Tracking Task Id",
+            "visible": False,
+        },
     }
 
     # Shotgun metadata definition for a Mari GeoEntity entity
     __GEO_METADATA_INFO = {
-        "project_id": {"display_name": "ShotGrid Project Id", "visible": False},
+        "project_id": {
+            "display_name": "Flow Production Tracking Project Id",
+            "visible": False,
+        },
         "project": {
-            "display_name": "ShotGrid Project",
+            "display_name": "Flow Production Tracking Project",
             "visible": True,
             "default_value": "",
         },
         "entity_type": {
-            "display_name": "ShotGrid Entity Type",
+            "display_name": "Flow Production Tracking Entity Type",
             "visible": False,
             "default_value": "",
         },
-        "entity_id": {"display_name": "ShotGrid Entity Id", "visible": False},
+        "entity_id": {
+            "display_name": "Flow Production Tracking Entity Id",
+            "visible": False,
+        },
         "entity": {
-            "display_name": "ShotGrid Entity",
+            "display_name": "Flow Production Tracking Entity",
+            "visible": True,
+            "default_value": "",
+        },
+        "task_id": {
+            "display_name": "Flow Production Tracking Task Id",
+            "visible": False,
+        },
+        "task": {
+            "display_name": "Flow Production Tracking Task",
             "visible": True,
             "default_value": "",
         },
-        "task_id": {"display_name": "ShotGrid Task Id", "visible": False},
-        "task": {"display_name": "ShotGrid Task", "visible": True, "default_value": ""},
     }
 
     # Shotgun metadata definition for a Mari GeoEntityVersion entity
     __GEO_VERSION_METADATA_INFO = {
         "path": {
-            "display_name": "ShotGrid Project Id",
+            "display_name": "Flow Production Tracking Project Id",
             "visible": True,
             "default_value": "",
         },
-        "publish_id": {"display_name": "ShotGrid Project", "visible": True},
-        "version": {"display_name": "ShotGrid Entity Type", "visible": True},
+        "publish_id": {
+            "display_name": "Flow Production Tracking Project",
+            "visible": True,
+        },
+        "version": {
+            "display_name": "Flow Production Tracking Entity Type",
+            "visible": True,
+        },
     }
 
     def __init__(self):
@@ -208,7 +239,7 @@ def set_geo_metadata(self, geo, project, entity, task):
             metadata["project"] = project.get("name")
         if entity:
             metadata_info["entity"]["display_name"] = (
-                "ShotGrid %s" % entity.get("type") or "Entity"
+                "Flow Production Tracking %s" % entity.get("type") or "Entity"
             )
             metadata["entity_type"] = entity["type"]
             metadata["entity_id"] = entity["id"]

diff --git a/python/tk_mari/utils.py b/python/tk_mari/utils.py
@@ -79,4 +79,7 @@ def update_publish_records(sg_publishes, min_fields=None):
             for sg_item in sg_res:
                 to_update[sg_item["id"]].update(sg_item)
         except Exception as e:
-            raise TankError("Failed to retrieve publish details from ShotGrid: %s" % e)
+            raise TankError(
+                "Failed to retrieve publish details from Flow Production Tracking: %s"
+                % e
+            )
diff --git a/startup/init.py b/startup/init.py
@@ -21,10 +21,10 @@ def show_warning(msg):
 
     :param msg:    The warning message to show
     """
-    warning_msg = "SG Warning: %s" % msg
+    warning_msg = "PTR Warning: %s" % msg
     print(warning_msg)
     if not mari.app.inTerminalMode():
-        mari.utils.misc.message(warning_msg, "SG Warning")
+        mari.utils.misc.message(warning_msg, "PTR Warning")
 
 
 def bootstrap_sgtk():
@@ -46,7 +46,7 @@ def bootstrap_sgtk():
         context = sgtk.context.deserialize(os.environ.get("TANK_CONTEXT"))
     except Exception as e:
         show_warning(
-            "Could not create context! SG Pipeline Toolkit will be disabled. Details: %s"
+            "Could not create context! Flow Production Tracking will be disabled. Details: %s"
             % e
         )
         return