| Name | deadline JSON |
| Version |
0.49.2
JSON |
| download |
| home_page | None |
| Summary | Multi-purpose library and command line tool that implements functionality to support applications using AWS Deadline Cloud. |
| upload_time | 2024-11-21 17:00:06 |
| maintainer | None |
| docs_url | None |
| author | Amazon Web Services |
| requires_python | <3.13,>=3.8 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AWS Deadline Cloud Client
[](https://pypi.python.org/pypi/deadline)
[](https://pypi.python.org/pypi/deadline)
[](https://github.com/aws-deadline/deadline/blob/mainline/LICENSE)
AWS Deadline Cloud client is a multi-purpose python library and command line tool for interacting with and submitting
[Open Job Description (OpenJD)][openjd] jobs to [AWS Deadline Cloud][deadline-cloud].
To support building workflows on top of AWS Deadline Cloud, it implements its own user interaction, job creation, file upload/download, and other useful
helpers around the service's API. It can function as a pipeline tool, a standalone GUI application, or even be embedded within other applications' runtimes.
Notable features include:
* A command-line interface with subcommands for querying your AWS Deadline Cloud resources, and submitting jobs to your AWS Deadline Cloud Farm.
* A library of functions that implement AWS Deadline Cloud's Job Attachments functionality.
* A library of functions for creating a job submission UI within any content creation tool that supports Python 3.8+ based plugins and
the Qt GUI framework.
[cas]: https://en.wikipedia.org/wiki/Content-addressable_storage
[deadline-cloud]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/what-is-deadline-cloud.html
[deadline-cloud-monitor]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/working-with-deadline-monitor.html
[deadline-cloud-samples]: https://github.com/aws-deadline/deadline-cloud-samples
[deadline-jobs]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html
[job-attachments]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-attachments.html
[shared-storage]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/storage-shared.html
[job-bundles]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-bundle.html
[openjd]: https://github.com/OpenJobDescription/openjd-specifications/wiki
## Compatibility
This library requires:
1. Python 3.8 through 3.12; and
2. Linux, Windows, or macOS operating system.
## 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.
## Contributing
We welcome all contributions. Please see [CONTRIBUTING.md](https://github.com/aws-deadline/deadline-cloud/blob/mainline/CONTRIBUTING.md)
for guidance on how to contribute. Please report issues such as bugs, inaccurate or confusing information, and so on,
by making feature requests in the [issue tracker](https://github.com/aws-deadline/deadline-cloud/issues). We encourage
code contributions in the form of [pull requests](https://github.com/aws-deadline/deadline-cloud/pulls).
## Getting Started
The AWS Deadline Cloud client can be installed by the standard python packaging mechanisms:
```sh
$ pip install deadline
```
or if you want the optional gui dependencies:
```sh
$ pip install "deadline[gui]"
```
## Usage
After installation it can then be used as a command line tool:
```sh
$ deadline farm list
- farmId: farm-1234567890abcdefg
displayName: my-first-farm
```
or as a python library:
```python
from deadline.client import api
api.list_farms()
# {'farms': [{'farmId': 'farm-1234567890abcdefg', 'displayName': 'my-first-farm', ...},]}
```
## Job-related Files
For job-related files and data, AWS Deadline Cloud supports either transferring files to AWS using job attachments or reading files from network storage that is shared between both your local workstation and your farm.
### Job attachments
Job attachments enable you to transfer files between your workstations and AWS Deadline Cloud using Amazon S3 buckets as
[content-addressed storage][cas] in your AWS account. The use of a content-addressed storage means that a file will never need
to be uploaded again once it has been uploaded once.
See [job attachments][job-attachments] for a more in-depth look at how files are uploaded, stored, and retrieved.
### Shared storage and storage profiles
Jobs can reference files that are stored on shared network storage. The Deadline Client uses a storage profile to determine which paths on the workstation are part of the network storage and do not need to be transferred using job attachments.
To use an existing storage profile with the Deadline Client, you can configure your default storage profile via CLI:
```sh
deadline config set settings.storage_profile_id sp-10b2e48ad6ac4fc88595dfcbef6271f2
```
Or with the configuration GUI:
```sh
deadline config gui
```
Shared storage is possible with customer-managed fleets (CMF) but not service-managed fleets (SMF). See [shared storage][shared-storage] for more information.
## Job Bundles
A job bundle is one of the tools that you can use to define jobs for AWS Deadline Cloud. They group an [Open Job Description (OpenJD)][openjd] template with
additional information such as files and directories that your jobs use with job attachments. You can use this package's command-line interface and/or
its Python interface to use a job bundle to submit jobs for a queue to run. Please see the [Job Bundles][job-bundles]
section of the AWS Deadline Cloud Developer Guide for detailed information on job bundles.
At a minimum, a job bundle is a folder that contains an [OpenJD][openjd] template as a file named `template.json` or `template.yaml`. However, it can optionally include:
1. An `asset_references.yaml` file - lists file inputs and outputs.
2. A `parameter_values.yaml` file - contains the selected values for the job template's parameters.
3. Any number of additional files required for the job.
For example job bundles, visit the [samples repository][deadline-cloud-samples].
To submit a job bundle, you can run
```sh
$ deadline bundle submit <path/to/bundle>
```
or if you have the optional GUI components installed, you can load up a job bundle for submission by running:
```sh
$ deadline bundle gui-submit --browse
```
On submission, a job bundle will be created in the job history directory (default: `~/.deadline/job_history`).
## Configuration
You can see the current configuration by running:
```sh
$ deadline config show
```
and change the settings by running the associated `get` and `set` commands.
To see a list of settings that can be configured, run:
```sh
$ deadline config --help
```
Or you can manage settings by a graphical user-interface if you have the optional GUI dependencies:
```sh
$ deadline config gui
```
By default, configuration of AWS Deadline Cloud is provided at `~/.deadline/config`, however this can be overridden by the `DEADLINE_CONFIG_FILE_PATH` environment variable.
## Authentication
In addition to the standard AWS credential mechanisms (AWS Profiles, instance profiles, and environment variables), AWS Deadline Cloud monitor credentials are also supported.
To view the currently configured credentials authentication status, run:
```sh
$ deadline auth status
Profile Name: (default)
Source: HOST_PROVIDED
Status: AUTHENTICATED
API Availability: True
```
If the currently selected AWS Profile is set-up to use [AWS Deadline Cloud monitor][deadline-cloud-monitor] credentials, you can authenticate by logging in:
```sh
$ deadline auth login
```
and removing them by logging out:
```sh
$ deadline auth logout
```
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.
## Security Issue Notifications
We take all security reports seriously. When we receive such reports, we will
investigate and subsequently address any potential vulnerabilities as quickly
as possible. If you discover a potential security issue in this project, please
notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/)
or directly via email to [AWS Security](mailto:aws-security@amazon.com). Please do not
create a public GitHub issue in this project.
## Telemetry
See [telemetry](https://github.com/aws-deadline/deadline-cloud/blob/release/docs/telemetry.md) for more information.
## License
This project is licensed under the Apache-2.0 License.
### Optional third party dependencies - GUI
N.B.: Although this repository is released under the Apache-2.0 license, its optional GUI feature
uses the third party Qt and PySide projects. The Qt and PySide projects' licensing includes the LGPL-3.0 license.
Raw data
{
"_id": null,
"home_page": null,
"name": "deadline",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f1/7b/e9801e50cd7aa556cedc5588fa6d290713e801d6c1be21e97f84ea135d0f/deadline-0.49.2.tar.gz",
"platform": null,
"description": "# AWS Deadline Cloud Client\n\n[](https://pypi.python.org/pypi/deadline)\n[](https://pypi.python.org/pypi/deadline)\n[](https://github.com/aws-deadline/deadline/blob/mainline/LICENSE)\n\nAWS Deadline Cloud client is a multi-purpose python library and command line tool for interacting with and submitting\n[Open Job Description (OpenJD)][openjd] jobs to [AWS Deadline Cloud][deadline-cloud].\n\nTo support building workflows on top of AWS Deadline Cloud, it implements its own user interaction, job creation, file upload/download, and other useful\nhelpers around the service's API. It can function as a pipeline tool, a standalone GUI application, or even be embedded within other applications' runtimes.\n\nNotable features include:\n* A command-line interface with subcommands for querying your AWS Deadline Cloud resources, and submitting jobs to your AWS Deadline Cloud Farm.\n* A library of functions that implement AWS Deadline Cloud's Job Attachments functionality.\n* A library of functions for creating a job submission UI within any content creation tool that supports Python 3.8+ based plugins and\n the Qt GUI framework.\n\n[cas]: https://en.wikipedia.org/wiki/Content-addressable_storage\n[deadline-cloud]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/what-is-deadline-cloud.html\n[deadline-cloud-monitor]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/working-with-deadline-monitor.html\n[deadline-cloud-samples]: https://github.com/aws-deadline/deadline-cloud-samples\n[deadline-jobs]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html\n[job-attachments]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-attachments.html\n[shared-storage]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/storage-shared.html\n[job-bundles]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-bundle.html\n[openjd]: https://github.com/OpenJobDescription/openjd-specifications/wiki\n\n## Compatibility\n\nThis library requires:\n\n1. Python 3.8 through 3.12; and\n2. Linux, Windows, or macOS operating system.\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## Contributing\n\nWe welcome all contributions. Please see [CONTRIBUTING.md](https://github.com/aws-deadline/deadline-cloud/blob/mainline/CONTRIBUTING.md)\nfor guidance on how to contribute. Please report issues such as bugs, inaccurate or confusing information, and so on,\nby making feature requests in the [issue tracker](https://github.com/aws-deadline/deadline-cloud/issues). We encourage\ncode contributions in the form of [pull requests](https://github.com/aws-deadline/deadline-cloud/pulls). \n\n## Getting Started\n\nThe AWS Deadline Cloud client can be installed by the standard python packaging mechanisms:\n```sh\n$ pip install deadline\n```\n\nor if you want the optional gui dependencies:\n```sh\n$ pip install \"deadline[gui]\"\n```\n\n## Usage\n\nAfter installation it can then be used as a command line tool:\n```sh\n$ deadline farm list\n- farmId: farm-1234567890abcdefg\n displayName: my-first-farm\n```\n\nor as a python library:\n```python\nfrom deadline.client import api\napi.list_farms()\n# {'farms': [{'farmId': 'farm-1234567890abcdefg', 'displayName': 'my-first-farm', ...},]}\n```\n\n## Job-related Files\nFor job-related files and data, AWS Deadline Cloud supports either transferring files to AWS using job attachments or reading files from network storage that is shared between both your local workstation and your farm. \n\n### Job attachments\n\nJob attachments enable you to transfer files between your workstations and AWS Deadline Cloud using Amazon S3 buckets as\n[content-addressed storage][cas] in your AWS account. The use of a content-addressed storage means that a file will never need\nto be uploaded again once it has been uploaded once.\n\nSee [job attachments][job-attachments] for a more in-depth look at how files are uploaded, stored, and retrieved.\n\n### Shared storage and storage profiles\nJobs can reference files that are stored on shared network storage. The Deadline Client uses a storage profile to determine which paths on the workstation are part of the network storage and do not need to be transferred using job attachments.\n\nTo use an existing storage profile with the Deadline Client, you can configure your default storage profile via CLI:\n\n```sh\ndeadline config set settings.storage_profile_id sp-10b2e48ad6ac4fc88595dfcbef6271f2\n```\n\nOr with the configuration GUI:\n```sh\ndeadline config gui\n```\n\n\nShared storage is possible with customer-managed fleets (CMF) but not service-managed fleets (SMF). See [shared storage][shared-storage] for more information.\n\n## Job Bundles\n\nA job bundle is one of the tools that you can use to define jobs for AWS Deadline Cloud. They group an [Open Job Description (OpenJD)][openjd] template with\nadditional information such as files and directories that your jobs use with job attachments. You can use this package's command-line interface and/or\nits Python interface to use a job bundle to submit jobs for a queue to run. Please see the [Job Bundles][job-bundles]\nsection of the AWS Deadline Cloud Developer Guide for detailed information on job bundles.\n\nAt a minimum, a job bundle is a folder that contains an [OpenJD][openjd] template as a file named `template.json` or `template.yaml`. However, it can optionally include:\n1. An `asset_references.yaml` file - lists file inputs and outputs.\n2. A `parameter_values.yaml` file - contains the selected values for the job template's parameters.\n3. Any number of additional files required for the job.\n\nFor example job bundles, visit the [samples repository][deadline-cloud-samples].\n\nTo submit a job bundle, you can run\n```sh\n$ deadline bundle submit <path/to/bundle>\n```\n\nor if you have the optional GUI components installed, you can load up a job bundle for submission by running:\n```sh\n$ deadline bundle gui-submit --browse\n```\n\nOn submission, a job bundle will be created in the job history directory (default: `~/.deadline/job_history`).\n\n## Configuration\n\nYou can see the current configuration by running:\n```sh\n$ deadline config show\n```\nand change the settings by running the associated `get` and `set` commands.\n\nTo see a list of settings that can be configured, run:\n```sh\n$ deadline config --help\n```\n\nOr you can manage settings by a graphical user-interface if you have the optional GUI dependencies:\n```sh\n$ deadline config gui\n```\n\nBy default, configuration of AWS Deadline Cloud is provided at `~/.deadline/config`, however this can be overridden by the `DEADLINE_CONFIG_FILE_PATH` environment variable.\n\n## Authentication\n\nIn addition to the standard AWS credential mechanisms (AWS Profiles, instance profiles, and environment variables), AWS Deadline Cloud monitor credentials are also supported.\n\nTo view the currently configured credentials authentication status, run:\n\n```sh\n$ deadline auth status\n Profile Name: (default)\n Source: HOST_PROVIDED\n Status: AUTHENTICATED\nAPI Availability: True\n```\n\nIf the currently selected AWS Profile is set-up to use [AWS Deadline Cloud monitor][deadline-cloud-monitor] credentials, you can authenticate by logging in:\n\n```sh\n$ deadline auth login\n```\n\nand removing them by logging out:\n```sh\n$ deadline auth logout\n```\n\n## Code of Conduct\n\nThis project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).\nFor more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact\nopensource-codeofconduct@amazon.com with any additional questions or comments.\n\n## Security Issue Notifications\n\nWe take all security reports seriously. When we receive such reports, we will \ninvestigate and subsequently address any potential vulnerabilities as quickly \nas possible. If you discover a potential security issue in this project, please \nnotify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/)\nor directly via email to [AWS Security](mailto:aws-security@amazon.com). Please do not \ncreate a public GitHub issue in this project.\n\n## Telemetry\n\nSee [telemetry](https://github.com/aws-deadline/deadline-cloud/blob/release/docs/telemetry.md) for more information.\n\n## License \n\nThis project is licensed under the Apache-2.0 License.\n\n### Optional third party dependencies - GUI\n\nN.B.: Although this repository is released under the Apache-2.0 license, its optional GUI feature\nuses the third party Qt and PySide projects. The Qt and PySide projects' licensing includes the LGPL-3.0 license.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Multi-purpose library and command line tool that implements functionality to support applications using AWS Deadline Cloud.",
"version": "0.49.2",
"project_urls": {
"Homepage": "https://github.com/aws-deadline/deadline-cloud",
"Source": "https://github.com/aws-deadline/deadline-cloud"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac9660f0554adf6696fa826ed55aaafbcc63de0cb482256658981ed5a29739bf",
"md5": "ab52045d81248363d0ba6895bf231f2e",
"sha256": "899304cbe1fcaabb892a9cf1ad8484439b1385a28b1c78ba1e56d2bd6e752d96"
},
"downloads": -1,
"filename": "deadline-0.49.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab52045d81248363d0ba6895bf231f2e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 248544,
"upload_time": "2024-11-21T17:00:02",
"upload_time_iso_8601": "2024-11-21T17:00:02.955640Z",
"url": "https://files.pythonhosted.org/packages/ac/96/60f0554adf6696fa826ed55aaafbcc63de0cb482256658981ed5a29739bf/deadline-0.49.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f17be9801e50cd7aa556cedc5588fa6d290713e801d6c1be21e97f84ea135d0f",
"md5": "f4f1aa26fc329f3f3015aea5afd2077d",
"sha256": "f0e34d80fee581e938237bd4d3ca431fd4687dc78b723de95f048a504d5a6edd"
},
"downloads": -1,
"filename": "deadline-0.49.2.tar.gz",
"has_sig": false,
"md5_digest": "f4f1aa26fc329f3f3015aea5afd2077d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 201230,
"upload_time": "2024-11-21T17:00:06",
"upload_time_iso_8601": "2024-11-21T17:00:06.287434Z",
"url": "https://files.pythonhosted.org/packages/f1/7b/e9801e50cd7aa556cedc5588fa6d290713e801d6c1be21e97f84ea135d0f/deadline-0.49.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 17:00:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-deadline",
"github_project": "deadline-cloud",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deadline"
}
