| Name | openjd-adaptor-runtime JSON |
| Version |
0.9.1
JSON |
| download |
| home_page | None |
| Summary | A python library for building adaptors that integrate applications with Open Job Description jobs. |
| upload_time | 2025-07-09 22:42:06 |
| maintainer | None |
| docs_url | None |
| author | Amazon Web Services |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Open Job Description - Adaptor Runtime Library
[](https://pypi.python.org/pypi/openjd-adaptor-runtime)
[](https://pypi.python.org/pypi/openjd-adaptor-runtime)
[](https://github.com/OpenJobDescription/openjd-adaptor-runtime/blob/mainline/LICENSE)
This package provides a runtime library to help build application interfaces that simplify
Open Job Description job templates. When implemented by a third party on behalf of
an application, the result is a CLI command that acts as an adaptor. Application
developers can also implement support for these CLI patterns directly in their
applications, potentially using this library to simplify the work.
Interface features that this library can assist with include:
1. Run as a background daemon to amortize application startup and scene load time.
* Tasks run in the context of [Open Job Description Sessions], and this pattern lets a
scheduling engine sequentially dispatch tasks to a single process that retains the
application, loaded scene, and any acceleration data structures in memory.
2. Report progress and status messages.
* Applications write progress information and status messages in many different ways.
An adaptor can scan the output of an application and report it in the format specified
for [Open Job Description Stdout Messages].
3. Map file system paths in input data.
* When running tasks on a different operating system, or when files are located at
different locations compared to where they were at creation, an adaptor can take
path mapping rules and perform [Open Job Description Path Mapping].
4. Transform signals like cancelation requests from the Open Job Description runtime into
the signal needed by the application.
* Applications may require different mechanisms to receive these messages, an adaptor
can handle any differences with what Open Job Description provides to give full
feature support.
5. Adjust application default behaviors for batch processing.
* When running applications that were built for interactive use within a batch processing
system, some default behaviors may lead to unreliability of workload completion, such
as using watermarks when a license could not be acquired or returning a success exit
code when an input data file could not be read. The adaptor can monitor and detect
these cases.
[Open Job Description Sessions]: https://github.com/OpenJobDescription/openjd-specifications/wiki/How-Jobs-Are-Run#sessions
[Open Job Description Stdout Messages]: https://github.com/OpenJobDescription/openjd-specifications/wiki/How-Jobs-Are-Run#stdoutstderr-messages
[Open Job Description Path Mapping]: https://github.com/OpenJobDescription/openjd-specifications/wiki/How-Jobs-Are-Run#path-mapping
Read the [Library Documentation](docs/README.md) to learn more.
## Compatibility
This library requires:
1. Python 3.9 or higher; and
2. Linux, MacOS, or Windows 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.
## Downloading
You can download this package from:
- [PyPI](https://pypi.org/project/openjd-adaptor-runtime/)
- [GitHub releases](https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python/releases)
### Verifying GitHub Releases
See [VERIFYING_PGP_SIGNATURE](VERIFYING_PGP_SIGNATURE.md) for more information.
## Security
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](aws-security@amazon.com). Please do not
create a public GitHub issue in this project.
## License
This project is licensed under the Apache-2.0 License.
Raw data
{
"_id": null,
"home_page": null,
"name": "openjd-adaptor-runtime",
"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/57/19/2528d4bf0251c4bc4b66e22d66d7c135460ff28badc4b39a7056ee8434d2/openjd_adaptor_runtime-0.9.1.tar.gz",
"platform": null,
"description": "# Open Job Description - Adaptor Runtime Library\n\n[](https://pypi.python.org/pypi/openjd-adaptor-runtime)\n[](https://pypi.python.org/pypi/openjd-adaptor-runtime)\n[](https://github.com/OpenJobDescription/openjd-adaptor-runtime/blob/mainline/LICENSE)\n\nThis package provides a runtime library to help build application interfaces that simplify\nOpen Job Description job templates. When implemented by a third party on behalf of\nan application, the result is a CLI command that acts as an adaptor. Application\ndevelopers can also implement support for these CLI patterns directly in their\napplications, potentially using this library to simplify the work.\n\nInterface features that this library can assist with include:\n\n1. Run as a background daemon to amortize application startup and scene load time.\n * Tasks run in the context of [Open Job Description Sessions], and this pattern lets a\n scheduling engine sequentially dispatch tasks to a single process that retains the\n application, loaded scene, and any acceleration data structures in memory.\n2. Report progress and status messages.\n * Applications write progress information and status messages in many different ways.\n An adaptor can scan the output of an application and report it in the format specified\n for [Open Job Description Stdout Messages].\n3. Map file system paths in input data.\n * When running tasks on a different operating system, or when files are located at\n different locations compared to where they were at creation, an adaptor can take\n path mapping rules and perform [Open Job Description Path Mapping].\n4. Transform signals like cancelation requests from the Open Job Description runtime into\n the signal needed by the application.\n * Applications may require different mechanisms to receive these messages, an adaptor\n can handle any differences with what Open Job Description provides to give full\n feature support.\n5. Adjust application default behaviors for batch processing.\n * When running applications that were built for interactive use within a batch processing\n system, some default behaviors may lead to unreliability of workload completion, such\n as using watermarks when a license could not be acquired or returning a success exit\n code when an input data file could not be read. The adaptor can monitor and detect\n these cases.\n\n[Open Job Description Sessions]: https://github.com/OpenJobDescription/openjd-specifications/wiki/How-Jobs-Are-Run#sessions\n[Open Job Description Stdout Messages]: https://github.com/OpenJobDescription/openjd-specifications/wiki/How-Jobs-Are-Run#stdoutstderr-messages\n[Open Job Description Path Mapping]: https://github.com/OpenJobDescription/openjd-specifications/wiki/How-Jobs-Are-Run#path-mapping\n\nRead the [Library Documentation](docs/README.md) to learn more.\n\n## Compatibility\n\nThis library requires:\n\n1. Python 3.9 or higher; and\n2. Linux, MacOS, or Windows 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## Downloading\n\nYou can download this package from:\n- [PyPI](https://pypi.org/project/openjd-adaptor-runtime/)\n- [GitHub releases](https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python/releases)\n\n### Verifying GitHub Releases\n\nSee [VERIFYING_PGP_SIGNATURE](VERIFYING_PGP_SIGNATURE.md) for more information.\n\n## Security\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](aws-security@amazon.com). Please do not\ncreate a public GitHub issue in this project.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n",
"bugtrack_url": null,
"license": null,
"summary": "A python library for building adaptors that integrate applications with Open Job Description jobs.",
"version": "0.9.1",
"project_urls": {
"Homepage": "https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python",
"Source": "https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "53dbc47e235c80e250000a340a1819200ffa021c668c071897ef6d72b45f691a",
"md5": "7f56af5070244267edd8c3c7ef4f867e",
"sha256": "5d142cea75382cc76a3ff3f1936e0cc11e31dbaf78d76a5feeb8a3eb9a49b174"
},
"downloads": -1,
"filename": "openjd_adaptor_runtime-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f56af5070244267edd8c3c7ef4f867e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 97298,
"upload_time": "2025-07-09T22:42:05",
"upload_time_iso_8601": "2025-07-09T22:42:05.730326Z",
"url": "https://files.pythonhosted.org/packages/53/db/c47e235c80e250000a340a1819200ffa021c668c071897ef6d72b45f691a/openjd_adaptor_runtime-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "57192528d4bf0251c4bc4b66e22d66d7c135460ff28badc4b39a7056ee8434d2",
"md5": "1ef6b766f5abd5a2dcd4dc3e6245fa0b",
"sha256": "8741388d40c07cf90c099105ef3bb899966d36b79295d916ce21864cf28ca223"
},
"downloads": -1,
"filename": "openjd_adaptor_runtime-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "1ef6b766f5abd5a2dcd4dc3e6245fa0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 67398,
"upload_time": "2025-07-09T22:42:06",
"upload_time_iso_8601": "2025-07-09T22:42:06.961066Z",
"url": "https://files.pythonhosted.org/packages/57/19/2528d4bf0251c4bc4b66e22d66d7c135460ff28badc4b39a7056ee8434d2/openjd_adaptor_runtime-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 22:42:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenJobDescription",
"github_project": "openjd-adaptor-runtime-for-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openjd-adaptor-runtime"
}
