# AWS Deadline Cloud for Unreal Engine
[](https://pypi.python.org/pypi/deadline-cloud-for-unreal-engine)
[](https://pypi.python.org/pypi/deadline-cloud-for-unreal-engine)
[](https://github.com/aws-deadline/deadline-cloud-for-unreal-engine/blob/mainline/LICENSE)
[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
AWS Deadline Cloud for Unreal Engine is a python package that allows users to create [AWS Deadline Cloud][deadline-cloud] jobs from within Unreal Engine. Using the [Open Job Description (OpenJD) Adaptor Runtime][openjd-adaptor-runtime] this package also provides a command line application that adapts Unreal's command line interface to support the [OpenJD specification][openjd].
## Compatibility
This library requires:
1. Python 3.9 or higher; and
2. Windows operating system.
## Submitter
This package provides a Unreal Engine plugin that creates jobs for AWS Deadline Cloud using the [AWS Deadline Cloud client library][deadline-cloud-client]. Based on the loaded scene it determines the files required, allows the user to specify render options, and builds an [OpenJD template][openjd] that defines the workflow.
## Adaptor
The Unreal Engine Adaptor implements the [OpenJD][openjd-adaptor-runtime] interface that allows render workloads to launch Unreal Engien and feed it commands. This gives the following benefits:
* a standardized render application interface,
* sticky rendering, where the application stays open between tasks,
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-unreal-engine
```
After installation it can then be used as a command line tool:
```sh
$ unreal-engine-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-unreal-engine/blob/release/CONTRIBUTING.md#security-issue-notifications) for more information.
## Telemetry
See [telemetry](https://github.com/aws-deadline/deadline-cloud-for-unreal-engine/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-unreal-engine",
"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/bb/d1/d83c0c8fa08ca051e64cd335d081ea5f1b4414f70eea7a1eac28cfe94551/deadline_cloud_for_unreal_engine-0.2.2.tar.gz",
"platform": null,
"description": "# AWS Deadline Cloud for Unreal Engine\n\n[](https://pypi.python.org/pypi/deadline-cloud-for-unreal-engine)\n[](https://pypi.python.org/pypi/deadline-cloud-for-unreal-engine)\n[](https://github.com/aws-deadline/deadline-cloud-for-unreal-engine/blob/mainline/LICENSE)\n\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\nAWS Deadline Cloud for Unreal Engine is a python package that allows users to create [AWS Deadline Cloud][deadline-cloud] jobs from within Unreal Engine. Using the [Open Job Description (OpenJD) Adaptor Runtime][openjd-adaptor-runtime] this package also provides a command line application that adapts Unreal's command line interface to support the [OpenJD specification][openjd].\n\n## Compatibility\n\nThis library requires:\n\n1. Python 3.9 or higher; and\n2. Windows operating system.\n\n## Submitter\n\nThis package provides a Unreal Engine plugin that creates jobs for AWS Deadline Cloud using the [AWS Deadline Cloud client library][deadline-cloud-client]. Based on the loaded scene it determines the files required, allows the user to specify render options, and builds an [OpenJD template][openjd] that defines the workflow.\n\n## Adaptor\n\nThe Unreal Engine Adaptor implements the [OpenJD][openjd-adaptor-runtime] interface that allows render workloads to launch Unreal Engien 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\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\n$ pip install deadline-cloud-for-unreal-engine\n```\n\nAfter installation it can then be used as a command line tool:\n```sh\n$ unreal-engine-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-unreal-engine/blob/release/CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## Telemetry\n\nSee [telemetry](https://github.com/aws-deadline/deadline-cloud-for-unreal-engine/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": null,
"summary": "AWS Deadline Cloud for Unreal Engine",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/aws-deadline/deadline-cloud-for-unreal-engine",
"Source": "https://github.com/aws-deadline/deadline-cloud-for-unreal-engine"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa8d8e586e0b6bbb18667eee6d7a5b91aa310cc6192e9e8f0e6384b46ca3b2e2",
"md5": "0951755fe90aba131d299199e121ce31",
"sha256": "09c1ded8dd379473b52a8f789d17e4d33868174b4d4dff1307ccaa8a984e17d6"
},
"downloads": -1,
"filename": "deadline_cloud_for_unreal_engine-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0951755fe90aba131d299199e121ce31",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 42469,
"upload_time": "2024-06-19T21:22:31",
"upload_time_iso_8601": "2024-06-19T21:22:31.948791Z",
"url": "https://files.pythonhosted.org/packages/aa/8d/8e586e0b6bbb18667eee6d7a5b91aa310cc6192e9e8f0e6384b46ca3b2e2/deadline_cloud_for_unreal_engine-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbd1d83c0c8fa08ca051e64cd335d081ea5f1b4414f70eea7a1eac28cfe94551",
"md5": "6191c5c8dfb29a59107ad101a8514138",
"sha256": "38cd941890208061e3dcbcbb8315cdb49e56e474f5212b6b444f4430a6c315a3"
},
"downloads": -1,
"filename": "deadline_cloud_for_unreal_engine-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "6191c5c8dfb29a59107ad101a8514138",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 94682,
"upload_time": "2024-06-19T21:22:33",
"upload_time_iso_8601": "2024-06-19T21:22:33.243565Z",
"url": "https://files.pythonhosted.org/packages/bb/d1/d83c0c8fa08ca051e64cd335d081ea5f1b4414f70eea7a1eac28cfe94551/deadline_cloud_for_unreal_engine-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 21:22:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-deadline",
"github_project": "deadline-cloud-for-unreal-engine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deadline-cloud-for-unreal-engine"
}
JSON
