Merge branch 'master' into fix-none-pixmap-using-pyqt

.coveragerc

@@ -0,0 +1,20 @@
+# 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.
+#
+# coverage configuration - used by https://coveralls.io/ integration
+#
+#
+[run]
+source=.
+omit=tests/*
+
+[report]
+exclude_lines =
+    raise NotImplementedError

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+# 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.4.0
+    hooks:
+    # Ensures the code is syntaxically correct
+    - id: check-ast
+      language_version: python3
+    # 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: 19.10b0
+    hooks:
+    - id: black
+      language_version: python3

LICENSE

@@ -4,9 +4,9 @@ Version: 7/07/2013
 
 Shotgun Software Inc. ("Company") provides the Shotgun Pipeline Toolkit,
 software, including source code, in this package or repository folder (the
-"Shotgun Toolkit Code") subject to your acceptance of and compliance with 
+"Shotgun Toolkit Code") subject to your acceptance of and compliance with
 the following terms and conditions (the "License Terms"). By accessing,
-downloading, copying, using or modifying any of the Shotgun Toolkit Code, 
+downloading, copying, using or modifying any of the Shotgun Toolkit Code,
 you agree to these License Terms.
 
 Eligibility
@@ -33,7 +33,7 @@ to the Shotgun Toolkit Code or any of Company's other software or intellectual
 property rights. You agree not to take any action with respect to the Shotgun
 Toolkit Code that is not expressly authorized above.
 
-You must keep intact (and, in the case of copies, reproduce) all copyright 
+You must keep intact (and, in the case of copies, reproduce) all copyright
 and other proprietary notices, including all references to and copies of these
 License Terms, as originally included on, in, or with the Shotgun Toolkit
 Code. You must ensure that all derivative works you make of the Shotgun
@@ -64,7 +64,7 @@ Company).
 Liability
 
 You agree to be solely responsible for your use and modifications of the
-Shotgun Toolkit Code, and for any harm or liability arising out of such use 
+Shotgun Toolkit Code, and for any harm or liability arising out of such use
 or modifications, including but not limited to any liability for infringement
 of third-party intellectual property rights.
 
@@ -78,7 +78,7 @@ advised of the possibility of such damages; and (b) in any event, Company's
 aggregate liability under these License Terms or in connection with the
 Shotgun Toolkit Code, regardless of the form of action and under any theory
 (whether in contract, tort, statutory, or otherwise), will not exceed the
-greater of $50 or the amount (if any) that you actually paid for access to 
+greater of $50 or the amount (if any) that you actually paid for access to
 the Shotgun Toolkit Code.
 
 Ownership
@@ -115,7 +115,7 @@ Company grants you a non-exclusive right to continue to modify, make
 derivative works of, reproduce, and use the Contribution for your
 non-commercial or internal business purposes, and to further Company's
 development of Company Programs. This grant does not: (a) limit Company's
-rights, (b) grant you any rights with respect to the Company Programs; nor 
+rights, (b) grant you any rights with respect to the Company Programs; nor
 (c) permit you to distribute, operate for the benefit of third parties (for
 example, on a hosted basis), or otherwise commercially exploit the
 Contribution.
@@ -143,4 +143,4 @@ employees, and agents against any and all claims, actions or damages
 account of a breach or alleged breach of the foregoing warranty. You make no
 other express or implied warranty (including without limitation any warranty
 of merchantability or fitness for a particular purpose) regarding the
-Contribution.
+Contribution.

README.md

@@ -1,13 +1,19 @@
+[![Reference Documentation](http://img.shields.io/badge/doc-reference-blue.svg)](http://developer.shotgunsoftware.com/tk-framework-qtwidgets)
+[![Build Status](https://dev.azure.com/shotgun-ecosystem/Toolkit/_apis/build/status/Frameworks/tk-framework-qtwidgets?branchName=master)](https://dev.azure.com/shotgun-ecosystem/Toolkit/_build/latest?definitionId=45&branchName=master)
+[![codecov](https://codecov.io/gh/shotgunsoftware/tk-framework-qtwidgets/branch/master/graph/badge.svg)](https://codecov.io/gh/shotgunsoftware/tk-framework-qtwidgets)
+[![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)
+
 ## Documentation
 This repository is a part of the Shotgun Pipeline Toolkit.
 
 - For more information about this app and for release notes, *see the wiki section*.
-- For API Reference, see http://shotgunsoftware.github.io/tk-framework-qtwidgets
+- For API Reference, see http://developer.shotgunsoftware.com/tk-framework-qtwidgets
 - For general information and documentation, click here: https://support.shotgunsoftware.com/entries/95441257
 - For information about Shotgun in general, click here: http://www.shotgunsoftware.com/toolkit
 
 ## Using this app in your Setup
-All the apps that are part of our standard app suite are pushed to our App Store. 
+All the apps that are part of our standard app suite are pushed to our App Store.
 This is where you typically go if you want to install an app into a project you are
 working on. For an overview of all the Apps and Engines in the Toolkit App Store,
 click here: https://support.shotgunsoftware.com/entries/95441247.

azure-pipelines.yml

@@ -0,0 +1,44 @@
+# 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.
+
+# Imports the shared Azure CI tools
+resources:
+  repositories:
+    - repository: templates
+      type: github
+      name: shotgunsoftware/tk-ci-tools
+      ref: refs/heads/master
+      endpoint: shotgunsoftware
+
+# We want builds to trigger for 3 reasons:
+# - The master branch sees new commits
+# - Each PR should get rebuilt when commits are added to it.
+# - When we tag something
+trigger:
+  branches:
+    include:
+    - master
+  tags:
+    include:
+    - v*
+pr:
+  branches:
+    include:
+    - "*"
+
+# This pulls in a variable group from Azure. Variables can be encrypted or not.
+variables:
+- group: deploy-secrets
+
+jobs:
+- template: build-pipeline.yml@templates
+  parameters:
+    additional_repositories:
+    - name: tk-framework-shotgunutils

docs/activity_stream.rst

@@ -24,7 +24,7 @@ All the content in the activity stream is cached and when you request the activi
 stream for an entity, the widget requests only the changes since the last update. The
 data is cached in a shared manner, meaning that a project, shot and task may be showing
 the same updates in their respective streams - and in this case, those updates are only
-pulled down once. 
+pulled down once.
 
 
 ActivityStreamWidget

docs/context_widget.rst

@@ -21,5 +21,3 @@ The widget includes the following features:
     :members:
     :inherited-members:
     :exclude-members: eventFilter
-
-

docs/elided_label.rst

@@ -3,7 +3,7 @@ Auto-Elide label
 
 
 This simple yet commonly used class helps add an elide (a "..." at the end)
-to text when it doesn't fit within a given space. 
+to text when it doesn't fit within a given space.
 
 .. currentmodule:: elided_label
 

docs/index.rst

@@ -40,7 +40,7 @@ that they are placed at the top of the file.
 
 Once you have imported the module, you can access the class or objects inside::
 
-    my_overlay = overlay.ShotgunOverlayWidget(self)
+    my_overlay = overlay_widget.ShotgunOverlayWidget(self)
 
 .. _widgets-in-designer:
 

docs/search_completer.rst

@@ -9,8 +9,8 @@ Global Search Completer
 =======================
 
 The global search completer is a QCompleter instance for use with widgets
-that allow input of Shotgun entities. The completer can be customized to 
-search across a given set of entity types. 
+that allow input of Shotgun entities. The completer can be customized to
+search across a given set of entity types.
 
 Once a user selects an object, a signal fires to indicate that an entity
 was activated.
@@ -32,4 +32,4 @@ hierarchy was selected.
 
 .. autoclass:: HierarchicalSearchCompleter
     :members:
-    :inherited-members:
+    :inherited-members:

docs/shotgun_menus.rst

@@ -28,5 +28,3 @@ Entity Field Menu
 .. autoclass:: EntityFieldMenu
     :show-inheritance:
     :members:
-
-

framework.py

@@ -1,24 +1,23 @@
 # Copyright (c) 2013 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.
 
 import sgtk
 
+
 class QtWidgetFramework(sgtk.platform.Framework):
-    
+
     ##########################################################################################
     # init and destroy
-            
+
     def init_framework(self):
         self.log_debug("%s: Initializing..." % self)
 
     def destroy_framework(self):
         self.log_debug("%s: Destroying..." % self)
-
-

info.yml

@@ -1,11 +1,11 @@
 # Copyright (c) 2013 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.
 
 # Metadata defining the behavior and requirements for this framework
@@ -16,16 +16,15 @@ configuration:
 # the Shotgun fields that this engine needs in order to operate correctly
 requires_shotgun_fields:
 
-# More verbose description of this item 
+# More verbose description of this item
 display_name: "QT Widgets Framework"
 description: "A Collection of Reusable QT Widgets to simplify app development."
 
 # Required minimum versions for this item to run
 requires_shotgun_version:
-requires_core_version: "v0.18.45"
+requires_core_version: "v0.19.1"
+
 
-
 # the frameworks required to run this app
 frameworks:
     - {"name": "tk-framework-shotgunutils", "version": "v5.x.x", "minimum_version": "v5.2.2"}
-

python/__init__.py

@@ -1,11 +1,11 @@
 # Copyright (c) 2016 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.
 
 from . import utils

python/activity_stream/__init__.py

@@ -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.