deadline-cloud-for-nuke


Namedeadline-cloud-for-nuke JSON
Version 0.18.7 PyPI version JSON
download
home_pageNone
SummaryThe submitter and adaptor to enable Nuke support for AWS Deadline Cloud
upload_time2024-11-21 19:52:07
maintainerNone
docs_urlNone
authorAmazon Web Services
requires_python>=3.9
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pypi](https://img.shields.io/pypi/v/deadline-cloud-for-nuke.svg?style=flat)](https://pypi.python.org/pypi/deadline-cloud-for-nuke)
[![python](https://img.shields.io/pypi/pyversions/deadline-cloud-for-nuke.svg?style=flat)](https://pypi.python.org/pypi/deadline-cloud-for-nuke)
[![license](https://img.shields.io/pypi/l/deadline-cloud-for-nuke.svg?style=flat)](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/mainline/LICENSE)

# AWS Deadline Cloud for Nuke

AWS Deadline Cloud for Nuke is a python package that allows users to create [AWS Deadline Cloud][deadline-cloud] jobs from within Nuke. Using the [Open Job Description (OpenJD) Adaptor Runtime][openjd-adaptor-runtime] this package also provides a command line application that adapts Nuke's command line interface to support the [OpenJD specification][openjd].

[deadline-cloud]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/what-is-deadline-cloud.html
[deadline-cloud-client]: https://github.com/aws-deadline/deadline-cloud
[openjd]: https://github.com/OpenJobDescription/openjd-specifications/wiki
[openjd-adaptor-runtime]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python
[openjd-adaptor-runtime-lifecycle]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python/blob/release/README.md#adaptor-lifecycle

## Compatibility

This library requires:

1. Nuke 15,
1. Python 3.9 or higher; and
1. Linux, Windows, or a macOS operating system.

## Submitter

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:
* a standardized render application interface,
* sticky rendering, where the application stays open between tasks,
* path mapping, that enables cross-platform rendering

Jobs created by the submitter use this adaptor by default.

### Getting Started

The adaptor can be installed by the standard python packaging mechanisms:
```sh
pip install deadline-cloud-for-nuke
```

After installation it can then be used as a command line tool:
```sh
nuke-openjd --help
```

For more information on the commands the OpenJD adaptor runtime provides, see [here][openjd-adaptor-runtime-lifecycle].

## Versioning

This package's version follows [Semantic Versioning 2.0](https://semver.org/), but is still considered to be in its 
initial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how
versions will increment during this initial development stage, they are described below:

1. The MAJOR version is currently 0, indicating initial development. 
2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API. 
3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API. 

## Security

See [CONTRIBUTING](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/release/CONTRIBUTING.md#security-issue-notifications) for more information.

## Telemetry

See [telemetry](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/release/docs/telemetry.md) for more information.

## License

This project is licensed under the Apache-2.0 License.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "deadline-cloud-for-nuke",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Amazon Web Services",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/c2/d1/2f5ff903f22c8eaa002eb98be388242a34aaeb43839effad3b68ae302797/deadline_cloud_for_nuke-0.18.7.tar.gz",
    "platform": null,
    "description": "[![pypi](https://img.shields.io/pypi/v/deadline-cloud-for-nuke.svg?style=flat)](https://pypi.python.org/pypi/deadline-cloud-for-nuke)\n[![python](https://img.shields.io/pypi/pyversions/deadline-cloud-for-nuke.svg?style=flat)](https://pypi.python.org/pypi/deadline-cloud-for-nuke)\n[![license](https://img.shields.io/pypi/l/deadline-cloud-for-nuke.svg?style=flat)](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/mainline/LICENSE)\n\n# AWS Deadline Cloud for Nuke\n\nAWS Deadline Cloud for Nuke is a python package that allows users to create [AWS Deadline Cloud][deadline-cloud] jobs from within Nuke. Using the [Open Job Description (OpenJD) Adaptor Runtime][openjd-adaptor-runtime] this package also provides a command line application that adapts Nuke's command line interface to support the [OpenJD specification][openjd].\n\n[deadline-cloud]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/what-is-deadline-cloud.html\n[deadline-cloud-client]: https://github.com/aws-deadline/deadline-cloud\n[openjd]: https://github.com/OpenJobDescription/openjd-specifications/wiki\n[openjd-adaptor-runtime]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python\n[openjd-adaptor-runtime-lifecycle]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python/blob/release/README.md#adaptor-lifecycle\n\n## Compatibility\n\nThis library requires:\n\n1. Nuke 15,\n1. Python 3.9 or higher; and\n1. Linux, Windows, or a macOS operating system.\n\n## Submitter\n\nThis 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.\n\n### Getting Started\n\nTo install the submitter manually, you can use `pip`.\n\n1. Install the package using `pip`.\n    ```sh\n    pip install deadline-cloud-for-nuke -t <target-directory>\n    ```\n\n2. Set the `NUKE_PATH` environment variable.\n    For Windows,\n    ```sh\n    set NUKE_PATH=<target-directory>;<target-directory>/deadline/nuke_submitter\n    ```\n\n    For Linux and MacOS:\n    ```sh\n    export NUKE_PATH=<target-directory>:<target-directory>/deadline/nuke_submitter\n    ```\n\n3. After installation and within the same terminal, run `Nuke<version>` executable. The Nuke submitter should now be available in the AWS Deadline menu.\n\n    NOTE: If you want the submitter available outside of this shell, consider using `NUKE_PATH` as an environment variable rather than a shell variable.\n\n## Adaptor\n\nThe 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:\n* a standardized render application interface,\n* sticky rendering, where the application stays open between tasks,\n* path mapping, that enables cross-platform rendering\n\nJobs created by the submitter use this adaptor by default.\n\n### Getting Started\n\nThe adaptor can be installed by the standard python packaging mechanisms:\n```sh\npip install deadline-cloud-for-nuke\n```\n\nAfter installation it can then be used as a command line tool:\n```sh\nnuke-openjd --help\n```\n\nFor more information on the commands the OpenJD adaptor runtime provides, see [here][openjd-adaptor-runtime-lifecycle].\n\n## Versioning\n\nThis package's version follows [Semantic Versioning 2.0](https://semver.org/), but is still considered to be in its \ninitial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how\nversions will increment during this initial development stage, they are described below:\n\n1. The MAJOR version is currently 0, indicating initial development. \n2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API. \n3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API. \n\n## Security\n\nSee [CONTRIBUTING](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/release/CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## Telemetry\n\nSee [telemetry](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/release/docs/telemetry.md) for more information.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "The submitter and adaptor to enable Nuke support for AWS Deadline Cloud",
    "version": "0.18.7",
    "project_urls": {
        "Homepage": "https://github.com/aws-deadline/deadline-cloud-for-nuke",
        "Source": "https://github.com/aws-deadline/deadline-cloud-for-nuke"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "203f4aca0af4f18ed4ed2023b4341390252c3c5396a529957bc820b7ce88ca50",
                "md5": "0c53cb4e3bb623612362e6d5189ebd8b",
                "sha256": "a92820eeb435a6a8230b8edf66a71f6ab0e6adbb98561529cbb04e2740d4ed5a"
            },
            "downloads": -1,
            "filename": "deadline_cloud_for_nuke-0.18.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0c53cb4e3bb623612362e6d5189ebd8b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 44850,
            "upload_time": "2024-11-21T19:52:06",
            "upload_time_iso_8601": "2024-11-21T19:52:06.075690Z",
            "url": "https://files.pythonhosted.org/packages/20/3f/4aca0af4f18ed4ed2023b4341390252c3c5396a529957bc820b7ce88ca50/deadline_cloud_for_nuke-0.18.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c2d12f5ff903f22c8eaa002eb98be388242a34aaeb43839effad3b68ae302797",
                "md5": "c293783b65879c8d8c2b6a90c4104319",
                "sha256": "9f52ff8bf4da2edebf77dd3ffec15e038b3fc5d373baf509c4e2d45ccfe2638f"
            },
            "downloads": -1,
            "filename": "deadline_cloud_for_nuke-0.18.7.tar.gz",
            "has_sig": false,
            "md5_digest": "c293783b65879c8d8c2b6a90c4104319",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 34677,
            "upload_time": "2024-11-21T19:52:07",
            "upload_time_iso_8601": "2024-11-21T19:52:07.232073Z",
            "url": "https://files.pythonhosted.org/packages/c2/d1/2f5ff903f22c8eaa002eb98be388242a34aaeb43839effad3b68ae302797/deadline_cloud_for_nuke-0.18.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-21 19:52:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aws-deadline",
    "github_project": "deadline-cloud-for-nuke",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "deadline-cloud-for-nuke"
}
        
Elapsed time: 1.34359s