Cleaned up sources with pre-commit hooks. (#69)

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+# Copyright (c) 2019 Shotgun Software Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Shotgun Software Inc.
+
+# Styles the code properly
+# Exclude the UI files, as they are auto-generated.
+exclude: "ui\/.*py$"
+# List of super useful formatters.
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    # Ensures the code is syntaxically correct
+    - id: check-ast
+      language_version: python3
+    # Ensures a yaml file is properly formatted
+    - id: check-yaml
+    # Ensures a file name will resolve on all platform
+    - id: check-case-conflict
+    # Checks files with the execute bit set have shebangs
+    - id: check-executables-have-shebangs
+    # Ensure there's no incomplete merges
+    - id: check-merge-conflict
+    # Adds an empty line if missing at the end of a file.
+    - id: end-of-file-fixer
+    # Makes sure requirements.txt is properly formatted
+    - id: requirements-txt-fixer
+    # Removes trailing whitespaces.
+    - id: trailing-whitespace
+  # Leave black at the bottom so all touchups are done before it is run.
+  - repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3

README

@@ -2,7 +2,7 @@
 The Shotgun Pipeline Toolkit Default Configuration
 -------------------------------------------------------------------------
 
-Welcome to the Shotgun Pipeline Toolkit default configuration! 
+Welcome to the Shotgun Pipeline Toolkit default configuration!
 
 For more information, go to the following url:
 https://support.shotgunsoftware.com/hc/en-us/articles/115000067493-Integrations-Admin-Guide

after_project_create.py

@@ -23,6 +23,7 @@
 
 """
 
+
 def create(sg, project_id, log, **kwargs):
     """
     Insert post-project code here

core/hooks/README

@@ -1,12 +1,12 @@
 This location is for core hook override files.
 
-The Shotgun Pipeline Toolkit comes with a series of Core Hooks, essentially snippets of python 
+The Shotgun Pipeline Toolkit comes with a series of Core Hooks, essentially snippets of python
 that contain key operations such as copying a file, creating directories etc.
 
 These hooks are part of the platform distribution and are therefore bundled with the code itself.
 
 If you want to provide your own hook implementations, for example control file system permissions
 as files are being copied, you can override the core hooks by putting a file with the same
-name as the core hook in this location. Sgtk will basically look in this folder first as it is 
-requesting a core hook - if it doesn't find the core hook here, it will look in its internal 
-platform location.
+name as the core hook in this location. Sgtk will basically look in this folder first as it is
+requesting a core hook - if it doesn't find the core hook here, it will look in its internal
+platform location.

core/hooks/pick_environment.py

@@ -16,7 +16,6 @@
 
 
 class PickEnvironment(Hook):
-
     def execute(self, context, **kwargs):
         """
         The default implementation assumes there are three environments, called shot, asset

core/roots.yml

@@ -67,4 +67,3 @@ primary:
 #     description: "High performance storage for fast/frequent texture access"
 #     shotgun_storage_id: 2
 #
-

core/schema/project/assets/asset_type.yml

@@ -1,11 +1,11 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
@@ -15,10 +15,9 @@ type: "shotgun_list_field"
 entity_type: "Asset"
 
 # switch this to true if you only want to make folders for
-# values that are being used. Note that evaluating this is 
+# values that are being used. Note that evaluating this is
 # expensive and may potentially slow down folder creation.
-skip_unused: false 
+skip_unused: false
 
 # the shotgun field to use for the folder name
 field_name: "sg_asset_type"
-

core/schema/project/assets/asset_type/asset.yml

@@ -1,11 +1,11 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
@@ -18,7 +18,7 @@ name: "code"
 entity_type: "Asset"
 
 # shotgun filters to apply when getting the list of items
-# this should be a list of dicts, each dict containing 
+# this should be a list of dicts, each dict containing
 # three fields: path, relation and values
 # (this is std shotgun API syntax)
 # any values starting with $ are resolved into path objects

core/schema/project/assets/asset_type/asset/step.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "shotgun_step"
 
 # the shotgun field to use for the folder name
 name: "short_name"
-

core/schema/project/assets/asset_type/asset/step/publish/3dsmax.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "static"
 
 # defer creation and only create this folder when 3dsmax starts
 defer_creation: ["tk-3dsmax", "tk-3dsmaxplus"]
-

core/schema/project/assets/asset_type/asset/step/publish/3dsmax/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/alias.yml

@@ -13,4 +13,3 @@ type: "static"
 
 # defer creation and only create this folder when Nuke starts
 defer_creation: "tk-alias"
-

core/schema/project/assets/asset_type/asset/step/publish/alias/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/caches/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/elements/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/houdini.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "static"
 
 # defer creation and only create this folder when Houdini starts
 defer_creation: "tk-houdini"
-

core/schema/project/assets/asset_type/asset/step/publish/houdini/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/mari/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/maya.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "static"
 
 # defer creation and only create this folder when Maya starts
 defer_creation: "tk-maya"
-

core/schema/project/assets/asset_type/asset/step/publish/maya/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/mobu.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "static"
 
 # defer creation and only create this folder when Motion Builder starts
 defer_creation: "tk-motionbuilder"
-

core/schema/project/assets/asset_type/asset/step/publish/mobu/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/nuke.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "static"
 
 # defer creation and only create this folder when Nuke starts
 defer_creation: "tk-nuke"
-

core/schema/project/assets/asset_type/asset/step/publish/nuke/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/photoshop.yml

@@ -1,16 +1,15 @@
 # Copyright (c) 2015 Shotgun Software Inc.
-# 
+#
 # CONFIDENTIAL AND PROPRIETARY
-# 
-# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
 # Source Code License included in this distribution package. See LICENSE.
-# By accessing, using, copying or modifying this work you indicate your 
-# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
 # the type of dynamic content
 type: "static"
 
 # defer creation and only create this folder when Photoshop starts
 defer_creation: "tk-photoshopcc"
-

core/schema/project/assets/asset_type/asset/step/publish/photoshop/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/publish/vred.yml

@@ -13,4 +13,3 @@ type: "static"
 
 # defer creation and only create this folder when Nuke starts
 defer_creation: "tk-vred"
-

core/schema/project/assets/asset_type/asset/step/publish/vred/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/reference/artwork/placeholder

@@ -1,4 +1,4 @@
 # This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
 # Any file named 'placeholder' will not be copied across when folders are created.
 # Note: You can which files should be ignored when folders are created in the ignore_files file,
-# located in the schema folder.
+# located in the schema folder.