ankaios-sdk 0.5.0rc2__tar.gz

ankaios_sdk-0.5.0rc2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ankaios_sdk-0.5.0rc2/MANIFEST.in

@@ -0,0 +1,8 @@
+# Include all .proto files in the _protos directory
+recursive-include ankaios_sdk/_protos *.proto
+
+# Include the README file
+include README.md
+
+# Include the license file
+include LICENSE

ankaios_sdk-0.5.0rc2/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.1
+Name: ankaios-sdk
+Version: 0.5.0rc2
+Summary: Eclipse Ankaios Python SDK - provides a convenient Python interface for interacting with the Ankaios platform.
+Home-page: https://eclipse-ankaios.github.io/ankaios/latest/
+Author: Elektrobit Automotive GmbH and Ankaios contributors
+License: Apache-2.0
+Project-URL: Documentation, https://eclipse-ankaios.github.io/ankaios/latest/
+Project-URL: Source, https://github.com/eclipse-ankaios/ank-sdk-python
+Project-URL: Bug Tracker, https://github.com/eclipse-ankaios/ank-sdk-python/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf==5.27.2
+Requires-Dist: PyYAML
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pycodestyle; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: sphinx-mdinclude; extra == "docs"
+Requires-Dist: google-api-python-client; extra == "docs"
+
+<picture style="padding-bottom: 1em;">
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/eclipse-ankaios/ankaios/blob/main/logo/Ankaios__logo_for_dark_bgrd_clipped.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/eclipse-ankaios/ankaios/blob/main/logo/Ankaios__logo_for_light_bgrd_clipped.png">
+  <img alt="Shows Ankaios logo" src="https://github.com/eclipse-ankaios/ankaios/blob/main/logo/Ankaios__logo_for_light_bgrd_clipped.png">
+</picture>
+
+# Ankaios Python SDK for Eclipse Ankaios
+
+Eclipse Ankaios provides workload and container orchestration for automotive
+High Performance Computers (HPCs). While it can be used for various fields of
+applications, it is developed from scratch for automotive use cases and provides
+a slim yet powerful solution to manage containerized applications.
+
+The Python SDK provides easy access from the container (workload) point-of-view
+to manage the Ankaios system. A workload can use the Python SDK to run other workloads
+and get the state of the Ankaios system. 
+
+## Installation
+
+### Install via pip
+
+```sh
+pip install ankaios-sdk
+```
+
+### Clone and Local Build
+
+```sh
+# Clone repository
+git clone https://github.com/eclipse-ankaios/ank-sdk-python.git
+cd ank-sdk-python
+
+# Install in editable mode
+pip install -e .
+
+# If you plan on contributing or running tests locally
+pip install -e ".[dev]"
+```
+
+> **Note:**  
+> Depending on your Linux distribution, it could be that you need to create and activate a [virtual environment](https://docs.python.org/3/library/venv.html) to run the pip commands.
+
+## Usage
+
+After installation, you can use the Ankaios SDK to configure and run workloads and request
+the state of the Ankaios system and the connected agents.
+
+Example:
+```python
+from ankaios_sdk import Workload, Ankaios, WorkloadStateEnum, WorkloadSubStateEnum
+
+# Create a new Ankaios object.
+# The connection to the control interface is automatically done at this step.
+ankaios = Ankaios()
+
+# Create a new workload
+workload = Workload.builder() \
+  .workload_name("dynamic_nginx") \
+  .agent_name("agent_A") \
+  .runtime("podman") \
+  .restart_policy("NEVER") \
+  .runtime_config("image: docker.io/library/nginx\ncommandOptions: [\"-p\", \"8080:80\"]") \
+  .build()
+
+# Run the workload
+ret = ankaios.apply_workload(workload)
+
+# Get the WorkloadInstanceName to check later if the workload is running
+if ret is not None:
+  workload_instance_name = ret["added_workloads"][0]
+
+# Request the execution state based on the workload instance name
+ret = ankaios.get_execution_state_for_instance_name(workload_instance_name)
+if ret is not None:
+  print(f"State: {ret.state}, substate: {ret.substate}, info: {ret.additional_info}")
+
+# Wait until the workload reaches the running state
+ret = ankaios.wait_for_workload_to_reach_state(
+  workload_instance_name,
+  state=WorkloadStateEnum.RUNNING,
+  timeout=5
+  )
+if ret:
+  print("Workload reached the RUNNING state.")
+
+# Request the state of the system, filtered with the agent name
+complete_state = ankaios.get_state(
+  timeout=5,
+  field_masks=["workloadStates.agent_A"])
+
+# Get the workload states present in the complete_state
+workload_states_dict = complete_state.get_workload_states().get_as_dict()
+
+# Print the states of the workloads:
+for workload_name in workload_states_dict["agent_A"]:
+  for workload_id in workload_states_dict["agent_A"][workload_name]:
+    print(f"Workload {workload_name} with id {workload_id} has the state "
+          + str(workload_states_dict["agent_A"] \
+                [workload_name][workload_id].state))
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions. Before contributing, make sure to read the
+[contribution guideline](CONTRIBUTING.md).
+
+## License
+
+Ankaios Python SDK is licensed using the Apache License Version 2.0.

ankaios_sdk-0.5.0rc2/README.md

@@ -0,0 +1,109 @@
+<picture style="padding-bottom: 1em;">
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/eclipse-ankaios/ankaios/blob/main/logo/Ankaios__logo_for_dark_bgrd_clipped.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/eclipse-ankaios/ankaios/blob/main/logo/Ankaios__logo_for_light_bgrd_clipped.png">
+  <img alt="Shows Ankaios logo" src="https://github.com/eclipse-ankaios/ankaios/blob/main/logo/Ankaios__logo_for_light_bgrd_clipped.png">
+</picture>
+
+# Ankaios Python SDK for Eclipse Ankaios
+
+Eclipse Ankaios provides workload and container orchestration for automotive
+High Performance Computers (HPCs). While it can be used for various fields of
+applications, it is developed from scratch for automotive use cases and provides
+a slim yet powerful solution to manage containerized applications.
+
+The Python SDK provides easy access from the container (workload) point-of-view
+to manage the Ankaios system. A workload can use the Python SDK to run other workloads
+and get the state of the Ankaios system. 
+
+## Installation
+
+### Install via pip
+
+```sh
+pip install ankaios-sdk
+```
+
+### Clone and Local Build
+
+```sh
+# Clone repository
+git clone https://github.com/eclipse-ankaios/ank-sdk-python.git
+cd ank-sdk-python
+
+# Install in editable mode
+pip install -e .
+
+# If you plan on contributing or running tests locally
+pip install -e ".[dev]"
+```
+
+> **Note:**  
+> Depending on your Linux distribution, it could be that you need to create and activate a [virtual environment](https://docs.python.org/3/library/venv.html) to run the pip commands.
+
+## Usage
+
+After installation, you can use the Ankaios SDK to configure and run workloads and request
+the state of the Ankaios system and the connected agents.
+
+Example:
+```python
+from ankaios_sdk import Workload, Ankaios, WorkloadStateEnum, WorkloadSubStateEnum
+
+# Create a new Ankaios object.
+# The connection to the control interface is automatically done at this step.
+ankaios = Ankaios()
+
+# Create a new workload
+workload = Workload.builder() \
+  .workload_name("dynamic_nginx") \
+  .agent_name("agent_A") \
+  .runtime("podman") \
+  .restart_policy("NEVER") \
+  .runtime_config("image: docker.io/library/nginx\ncommandOptions: [\"-p\", \"8080:80\"]") \
+  .build()
+
+# Run the workload
+ret = ankaios.apply_workload(workload)
+
+# Get the WorkloadInstanceName to check later if the workload is running
+if ret is not None:
+  workload_instance_name = ret["added_workloads"][0]
+
+# Request the execution state based on the workload instance name
+ret = ankaios.get_execution_state_for_instance_name(workload_instance_name)
+if ret is not None:
+  print(f"State: {ret.state}, substate: {ret.substate}, info: {ret.additional_info}")
+
+# Wait until the workload reaches the running state
+ret = ankaios.wait_for_workload_to_reach_state(
+  workload_instance_name,
+  state=WorkloadStateEnum.RUNNING,
+  timeout=5
+  )
+if ret:
+  print("Workload reached the RUNNING state.")
+
+# Request the state of the system, filtered with the agent name
+complete_state = ankaios.get_state(
+  timeout=5,
+  field_masks=["workloadStates.agent_A"])
+
+# Get the workload states present in the complete_state
+workload_states_dict = complete_state.get_workload_states().get_as_dict()
+
+# Print the states of the workloads:
+for workload_name in workload_states_dict["agent_A"]:
+  for workload_id in workload_states_dict["agent_A"][workload_name]:
+    print(f"Workload {workload_name} with id {workload_id} has the state "
+          + str(workload_states_dict["agent_A"] \
+                [workload_name][workload_id].state))
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions. Before contributing, make sure to read the
+[contribution guideline](CONTRIBUTING.md).
+
+## License
+
+Ankaios Python SDK is licensed using the Apache License Version 2.0.

ankaios_sdk-0.5.0rc2/ankaios_sdk/__init__.py

@@ -0,0 +1,41 @@
+# Copyright (c) 2024 Elektrobit Automotive GmbH
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Ankaios Python SDK
+
+Classes
+-------
+
+- Ankaios:
+    The main SDK class.
+- Workload:
+    Represents a workload.
+- WorkloadBuilder:
+    A builder class for workloads.
+- WorkloadState:
+    Represents the state of a workload.
+- WorkloadStateCollection:
+    A collection of workload states.
+- Manifest:
+    Represents a workload manifest.
+- CompleteState:
+    Represents the complete state of the Ankaios cluster.
+"""
+
+from .exceptions import *
+from .ankaios import *
+from ._components import *
+
+__all__ = [name for name in globals() if not name.startswith('_')]

ankaios_sdk-0.5.0rc2/ankaios_sdk/_components/__init__.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2024 Elektrobit Automotive GmbH
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+This module initializes the ankaios_sdk package by importing all
+necessary components.
+
+Imports
+-------
+
+- Workload component:
+    responsible for defining the workload of the system.
+- WorkloadState component:
+    responsible for accessing the state of the workload.
+- CompleteState component:
+    responsible for accessing the complete state of the system.
+- Request component:
+    responsible for defining a request to be sent to the system.
+- Response component:
+    responsible for defining a response from the system.
+- Manifest component:
+    responsible for defining a manifest object.
+"""
+
+from .workload import *
+from .workload_state import *
+from .complete_state import *
+from .request import *
+from .response import *
+from .manifest import *
+
+__all__ = [name for name in globals() if not name.startswith('_')]