Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Resolve menu.py not found error when running pip install deadline-cloud-for-nuke -t <folder> #165

Merged
merged 3 commits into from
Sep 10, 2024

Conversation

diane-hj
Copy link
Contributor

@diane-hj diane-hj commented Sep 9, 2024

What was the problem/requirement? (What/Why)

Addressing user feedback on receiving doesn't have menu.py error while installing deadline-cloud-for-nuke using pip install deadline-cloud-for-nuke -t command in MacOS

This PR is originated from PR-152 by Cherie. This commit is addressing:

  • update NUKE_PATH in installer
  • add a way for customers on how to setup submitter with pip install deadline-cloud-for-nuke

What was the solution? (How)

  • Added the setup information in README.md
  • Updated NUKE_PATH in installer
  • Move menu.py to the correct folder

What is the impact of this change?

  • Better customer experience in installing deadline-cloud-for-nuke

How was this change tested?

% ./python -m pip install -e /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke -t ~/testing
...
Successfully built deadline-cloud-for-nuke
Installing collected packages: xxhash, urllib3, typing-extensions, six, pyyaml, pyrsistent, packaging, jmespath, click, attrs, qtpy, python-dateutil, jsonschema, openjd-adaptor-runtime, botocore, s3transfer, boto3, deadline, deadline-cloud-for-nuke
Successfully installed attrs-23.2.0 boto3-1.34.147 botocore-1.34.147 click-8.1.7 deadline-0.48.7 deadline-cloud-for-nuke-0.18.3.post3+g08b2b27.d20240724 jmespath-1.0.1 jsonschema-4.17.3 openjd-adaptor-runtime-0.8.0 packaging-24.1 pyrsistent-0.20.0 python-dateutil-2.9.0.post0 pyyaml-6.0.1 qtpy-2.4.1 s3transfer-0.10.2 six-1.16.0 typing-extensions-4.12.2 urllib3-2.2.2 xxhash-3.4.1
- Ran `hatch build`
- On virtual env, run `pip install deadline-cloud-for-nuke -t ~/testing-nuke` 
- run `export NUKE_PATH=/Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/src/deadline/nuke_submitter`
- Open up the Nuke15 in the same terminal
Verified building the submitter installer locally on Linux

Did you run the "Job Bundle Output Tests"? If not, why not? If so, paste the test results here.


Timestamp: 2024-09-09T15:51:24.219040-07:00
Running job bundle output test: /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/job_bundle_output_tests/group-read

group-read
Test succeeded

Timestamp: 2024-09-09T15:51:25.224606-07:00
Running job bundle output test: /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/job_bundle_output_tests/noise-saver

noise-saver
Test succeeded

Timestamp: 2024-09-09T15:51:26.892546-07:00
Running job bundle output test: /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/job_bundle_output_tests/multi-load-save

multi-load-save
Test succeeded

Timestamp: 2024-09-09T15:51:27.945249-07:00
Running job bundle output test: /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/job_bundle_output_tests/frame

frame
Test succeeded

Timestamp: 2024-09-09T15:51:29.581547-07:00
Running job bundle output test: /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/job_bundle_output_tests/ocio

ocio
Test succeeded

Timestamp: 2024-09-09T15:51:30.564863-07:00
Running job bundle output test: /Users/chaejung/Desktop/submitter/deadline-cloud-for-nuke/job_bundle_output_tests/cwd-path

cwd-path
Test succeeded

All tests passed, ran 6 total.
Timestamp: 2024-09-09T15:52:41.846716-07:00

Was this change documented?

Yes - both development.md and readme.md are updated

Is this a breaking change?

No


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@diane-hj diane-hj requested a review from a team as a code owner September 9, 2024 22:59
README.md Outdated Show resolved Hide resolved
Copy link

Copy link
Contributor

@epmog epmog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

$ export NUKE_PATH=${NUKE_PATH}:<target-directory>/deadline/nuke_submitter
```

After installation and within the same terminal, run `Nuke<version>` executable. The Nuke submitter should now be available in the AWS Deadline menu.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd be helpful to give an example command here, especially for Macs where it's less obvious.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will add this on the separate PR! 🙏 Thanks for the suggestion.

To install the submitter manually, you can use pip.

```sh
$ pip install deadline-cloud-for-nuke -t target-directory

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: It'd be slightly better to choose a real target directory like ~/deadline-cloud-for-nuke so that users can copy-paste the commands. Then you could also note that users can choose a different directory if they want.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, we'd then also remove the shell indicator $ (for lack of knowing the term) to allow the copy/paste.

@diane-hj diane-hj merged commit 82b7eb2 into aws-deadline:mainline Sep 10, 2024
12 checks passed
StevenBanaszak added a commit that referenced this pull request Oct 21, 2024
…stall deadline-cloud-for-nuke -t <folder> (#165)" (#170)

This reverts commit 82b7eb2.

Signed-off-by: Steven Banaszak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants