fix: Resolve menu.py not found error when installing via pip

Signed-off-by: Steven Banaszak <[email protected]>
aws-deadline · Nov 13, 2024 · 2f36a08 · 2f36a08
1 parent d31466a
commit 2f36a08
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 12 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -87,12 +87,12 @@ WARNING: This workflow installs additional Python packages into your Nuke's pyth
 
    Windows (update the paths as needed):
    ```
-   set NUKE_PATH=C:\Users\<username>\deadline-clients\deadline-cloud-for-nuke\src
+   set NUKE_PATH=C:\Users\<username>\deadline-clients\deadline-cloud-for-nuke\src;C:\Users\<username>\deadline-clients\deadline-cloud-for-nuke\src\deadline\nuke_submitter
    ```
 
    Mac (update the paths as needed):
    ```
-   export NUKE_PATH=/Users/<username>/dev/deadline-clients/deadline-cloud-for-nuke/src
+   export NUKE_PATH=/Users/<username>/dev/deadline-clients/deadline-cloud-for-nuke/src:/Users/<username>/dev/deadline-clients/deadline-cloud-for-nuke/src/deadline/nuke_submitter
    ```
 1. Set the `DEADLINE_ENABLE_DEVELOPER_OPTIONS` environment variable to `true` to enable the job bundle debugging support. This enables a menu item you can use to run the tests from the `job_bundle_output_tests` directory.
 

diff --git a/README.md b/README.md
@@ -24,6 +24,30 @@ This library requires:
 
 This package provides a Nuke plugin that creates jobs for AWS Deadline Cloud using the [AWS Deadline Cloud client library][deadline-cloud-client]. Based on the loaded comp it determines the files required, allows the user to specify render options, and builds an [OpenJD template][openjd] that defines the workflow.
 
+### Getting Started
+
+To install the submitter manually, you can use `pip`.
+
+1. Install the package using `pip`.
+    ```sh
+    pip install deadline-cloud-for-nuke -t <target-directory>
+    ```
+
+2. Set the `NUKE_PATH` environment variable.
+    For Windows,
+    ```sh
+    set NUKE_PATH=<target-directory>;<target-directory>/deadline/nuke_submitter
+    ```
+
+    For Linux and MacOS:
+    ```sh
+    export NUKE_PATH=<target-directory>:<target-directory>/deadline/nuke_submitter
+    ```
+
+3. After installation and within the same terminal, run `Nuke<version>` executable. The Nuke submitter should now be available in the AWS Deadline menu.
+
+    NOTE: If you want the submitter available outside of this shell, consider using `NUKE_PATH` as an environment variable rather than a shell variable.
+
 ## Adaptor
 
 The Nuke Adaptor implements the [OpenJD][openjd-adaptor-runtime] interface that allows render workloads to launch Nuke and feed it commands. This gives the following benefits:
@@ -37,12 +61,12 @@ Jobs created by the submitter use this adaptor by default.
 
 The adaptor can be installed by the standard python packaging mechanisms:
 ```sh
-$ pip install deadline-cloud-for-nuke
+pip install deadline-cloud-for-nuke
 ```
 
 After installation it can then be used as a command line tool:
 ```sh
-$ nuke-openjd --help
+nuke-openjd --help
 ```
 
 For more information on the commands the OpenJD adaptor runtime provides, see [here][openjd-adaptor-runtime-lifecycle].

diff --git a/install_builder/deadline-cloud-for-nuke.xml b/install_builder/deadline-cloud-for-nuke.xml
@@ -18,7 +18,6 @@
                     <onPackingFilterList>
                         <fileNameFilter pattern="*/deadline/nuke_submitter/*" logic="matches" patternType="glob"/>
                         <fileNameFilter pattern="*/deadline/nuke_util/*" logic="matches" patternType="glob"/>
-                        <fileNameFilter pattern="*/menu.py" logic="matches" patternType="glob"/>
                     </onPackingFilterList>
                 </distributionDirectory>
             </distributionFileList>
@@ -74,13 +73,36 @@
 		</stringParameter>
 	</parameterList>
     <postInstallationActionList>
-		<fnAddPathEnvironmentVariable>
-			<progressText>Setting NUKE_PATH</progressText>
-			<name>NUKE_PATH</name>
-			<value>${nuke_installdir}</value>
-			<scope>${installscope}</scope>
-			<insertAt>end</insertAt>
-		</fnAddPathEnvironmentVariable>
+        <if>
+            <conditionRuleList>
+                <platformTest type="windows"/>
+            </conditionRuleList>
+            <actionList>
+                <fnAddPathEnvironmentVariable>
+                    <progressText>Setting NUKE_PATH</progressText>
+                    <name>NUKE_PATH</name>
+                    <value>${nuke_installdir};${nuke_installdir}/deadline/nuke_submitter</value>
+                    <scope>${installscope}</scope>
+                    <insertAt>end</insertAt>
+                </fnAddPathEnvironmentVariable>
+            </actionList>
+        </if>
+        <if>
+            <ruleEvaluationLogic>or</ruleEvaluationLogic>
+            <conditionRuleList>
+                <platformTest type="osx"/>
+                <platformTest type="linux"/>
+            </conditionRuleList>
+            <actionList>
+                <fnAddPathEnvironmentVariable>
+                    <progressText>Setting NUKE_PATH</progressText>
+                    <name>NUKE_PATH</name>
+                    <value>${nuke_installdir}:${nuke_installdir}/deadline/nuke_submitter</value>
+                    <scope>${installscope}</scope>
+                    <insertAt>end</insertAt>
+                </fnAddPathEnvironmentVariable>
+            </actionList>
+        </if>
         <unzip>
             <destinationDirectory>${nuke_installdir}</destinationDirectory>
             <zipFile>${installdir}/tmp/nuke_deps/dependency_bundle/deadline_cloud_for_nuke_submitter-deps-${nuke_deps_platform}.zip</zipFile>

diff --git a/src/menu.py → src/deadline/nuke_submitter/menu.py b/src/menu.py → src/deadline/nuke_submitter/menu.py