Tk framework adobe Code Review

.flake8

@@ -0,0 +1,66 @@
+# Copyright (c) 2017 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.
+
+# Flake 8 PEP and lint configuration - https://gitlab.com/pycqa/flake8
+#
+# This defines the official lint and PEP8 rules for this repository
+#
+# You can run this locally by doing pep install flake8 and then
+# >flake8 /path/to/core
+#
+# This is also used by the hound CI - see the .hound.yml config file.
+#
+#
+[flake8]
+
+# things we don't want to lint
+exclude =
+    .tox,
+    .git,
+    .flake8,
+    .gitignore,
+    .travis.yml,
+    .cache,
+    .eggs,
+    *.rst,
+    *.yml,
+    *.pyc,
+    *.pyo,
+    *.egg-info,
+    __pycache__,
+    # Those are our third parties, do not lint them!
+    python/tank_vendor,
+    com.sg.basic.ps/*,
+    cep/node_modules/*,
+    # Otherwise you'll have a lot of 'xxx' imported but unused
+    python/tank/__init__.py,
+    python/tank/*/__init__.py,
+    # Skip the auto-generated ui file.
+    python/tank/authentication/ui/login_dialog.py,
+    python/tank/authentication/ui/resources_rc.py,
+    python/tank/authentication/sso_saml2/*,
+    tests/python
+
+# toolkit exceptions
+#
+# E501 line too long (112 > 79 characters)
+# W291 trailing whitespace
+# W293 blank line contains whitespace
+# W391 blank line at end of file
+# E221 multiple spaces before operator
+# E261 two whitespaces before end of line comment.
+# E402 module level import not top of file
+# N802 Variables should be lower case. (clashes with Qt naming conventions)
+# N806 Variables should be lower case. (clashes with Qt naming conventions)
+# E999 SyntaxError: invalid syntax (hack for hound CI which runs python 3.x)
+
+ignore = E501, W291, W293, W391, E221, E261, E402, N802, N806, E999
+
+

.gitignore

@@ -0,0 +1,11 @@
+*.py[co]
+
+.DS_Store
+*.swp
+*.lock
+profile
+Thumbs.db
+
+*.rnd
+*.swp
+pkgs/*

README.md

@@ -1,5 +1,71 @@
 # tk-framework-adobe
 
-A framework for adobe engines
+
+A framework for Adobe engines
+
+
+# Contributing
+
+## Setup development environment
+
+To setup the development environment for this project, you will need to obtain the _**ZXPSignCmd**_ tool provided by Adobe, which can be found [here](https://labs.adobe.com/downloads/extensionbuilder3.html). Once you have logged in using your existing Adobe user account, download the _**CC Extensions Signing Toolkit**_, which will provide you with the necessary executable.
+
+If you are developing on a ***Mac*** please set all necessary variables in `dev/env.mk`.
+
+On ***Windows*** please fill all necessary variables in `dev\env.cmd`
+
+From now on you may test and sign with the following targets:
+
+---
+***Note***
+Be sure to run all of the following commands from the top-level directory of this project.
+---
+
+
+### To install the CEP extension for testing without signing:
+```
+cd dev
+make test
+```
+
+### To sign the CEP extension
+```
+cd dev
+make sign
+```
+
+
+### To create a certificate for use when signing the CEP extension
+```
+cd dev
+make create_certificate
+```
+
+---
+***Note***
+In the case where the configured CERTIFICATE_FILE does not exist, the create_certificate command will be automatically run as part of the _sign_ target.
+---
+
+
+### To remove the latest signed zxp file
+```
+cd dev
+make clean
+```
+
+### Notes on editing the env files (env.mk/env.cmd)
+
+Changes to the env files (env.mk and env.cmd) will typically not be tracked in git. The information contained in these files is specific to a particular development environment, so tracking changes to that data in git is undesirable.
+
+If you need to make changes to these files, you can use the following commands:
+
+```
+git update-index --no-skip-worktree dev/env.mk dev/env.cmd
+git add dev\env.*
+git commit -m "your message"
+git update-index --skip-worktree dev/env.mk dev/env.cmd
+```
+
+Please be aware that these files contain potentially-sensitive information, such as a certificate password. When making changes to these files and pushing them to a git repository, be sure that you've removed any data that might be considered confidential.
 
 

cep/.debug

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ExtensionList>
+    <Extension Id="com.sg.basic.adobe.panel">
+        <HostList>
+           <Host Name="PHSP" Port="45216"/>
+           <Host Name="PHXS" Port="45217"/>
+           <Host Name="AEFT" Port="45218"/>
+        </HostList>
+    </Extension>
+    <Extension Id="com.sg.basic.adobe.manager">
+        <HostList>
+           <Host Name="PHSP" Port="45226"/>
+           <Host Name="PHXS" Port="45227"/>
+           <Host Name="AEFT" Port="45228"/>
+        </HostList>
+    </Extension>
+</ExtensionList>

cep/CSXS/manifest.xml

@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="com.sg.basic.adobe" ExtensionBundleName="Shotgun Engine for Adobe CC" ExtensionBundleVersion="1.0" Version="6.0">
+    <ExtensionList>
+        <Extension Id="com.sg.basic.adobe.manager" Version="1.0"/>
+        <Extension Id="com.sg.basic.adobe.panel" Version="1.0"/>
+    </ExtensionList>
+    <ExecutionEnvironment>
+        <HostList>
+            <!-- Photoshop - CC 2014+ -->
+            <Host Name="PHSP" Version="15.0"/>
+            <Host Name="PHXS" Version="15.0"/>
+            <!-- After Effects - CC 2017+ -->
+            <Host Name="AEFT" Version="14.0"/>
+            <!-- Supporting more engines than Photoshop and After Effects can be done in this line -->
+        </HostList>
+        <LocaleList>
+            <Locale Code="All"/>
+        </LocaleList>
+        <RequiredRuntimeList>
+            <RequiredRuntime Name="CSXS" Version="6.0"/>
+        </RequiredRuntimeList>
+    </ExecutionEnvironment>
+    <DispatchInfoList>
+        <Extension Id="com.sg.basic.adobe.manager">
+            <DispatchInfo>
+                <Resources>
+                    <MainPath>./html/manager.html</MainPath>
+                    <CEFCommandLine>
+                        <Parameter>--enable-nodejs</Parameter>
+                    </CEFCommandLine>
+                </Resources>
+                <Lifecycle>
+                    <!-- don't show. keep it secret. keep it safe. -->
+                    <AutoVisible>false</AutoVisible>
+                    <StartOn>
+                        <!-- Adobe CEP startup event -->
+                        <Event>com.adobe.csxs.events.AppOnline</Event>
+                        <!-- Adobe CEP startup event -->
+                        <Event>com.adobe.csxs.events.ApplicationActivate</Event>
+                    </StartOn>
+                </Lifecycle>
+                <UI>
+                    <!-- Custom keeps it hidden. -->
+                    <Type>Custom</Type>
+                    <Geometry>
+                        <Size>
+                            <Height>100</Height>
+                            <Width>100</Width>
+                        </Size>
+                    </Geometry>
+                </UI>
+            </DispatchInfo>
+        </Extension>
+        <Extension Id="com.sg.basic.adobe.panel">
+            <DispatchInfo>
+                <Resources>
+                    <MainPath>./html/panel.html</MainPath>
+                    <CEFCommandLine>
+                        <Parameter>--enable-nodejs</Parameter>
+                    </CEFCommandLine>
+                </Resources>
+                <Lifecycle>
+                    <AutoVisible>true</AutoVisible>
+                </Lifecycle>
+                <UI>
+                    <Type>Panel</Type>
+                    <Menu>Shotgun Adobe Panel</Menu>
+                    <Geometry>
+                        <Size>
+                            <Height>350</Height>
+                            <Width>400</Width>
+                        </Size>
+                    </Geometry>
+                    <Icons>
+                        <Icon Type="Normal">./images/IconLight.png</Icon>
+                        <Icon Type="RollOver">./images/IconLightRollOver.png</Icon>
+                        <Icon Type="DarkNormal">./images/IconDark.png</Icon>
+                        <Icon Type="DarkRollOver">./images/IconDarkRollOver.png</Icon>
+                    </Icons>
+                </UI>
+            </DispatchInfo>
+        </Extension>
+    </DispatchInfoList>
+</ExtensionManifest>