moveai-mocap-python 0.18.3__tar.gz

moveai_mocap_python-0.18.3/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: moveai-mocap-python
+Version: 0.18.3
+Summary: 
+License: #
+Author: Ben Hastings
+Author-email: ben@move.ai
+Requires-Python: >=3.10,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+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-Dist: boto3 (>=1.34.48,<2.0.0)
+Requires-Dist: boto3-stubs[ec2,iam] (>=1.34.49,<2.0.0)
+Requires-Dist: pydantic (>=2.6.1,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.2.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Move AI Mocap SDK
+
+This SDK allows you to use Python to define and run Move AI Engine jobs. It currently supports running jobs on AWS, based on the availability of AMIs in your EC2 environment.
+
+### Requirements
+Python 3.10 or higher.
+
+### Installation
+
+#### With poetry
+
+```bash
+poetry add moveai-mocap-python
+```
+
+#### With pip
+
+```bash
+pip install moveai-mocap-python
+```
+
+## Quickstart
+
+See the [docs](https://move-ai.github.io/moveai-mocap-python/) for more detailed information.
+
+### Examples
+
+See the [multi camera example](https://move-ai.github.io/moveai-mocap-python/quickstart/multicam.html).
+
+See the [single camera example](https://move-ai.github.io/moveai-mocap-python/quickstart/singlecam.html).
+
+## License
+
+This project is proprietary. All rights reserved.
+

moveai_mocap_python-0.18.3/README.md

@@ -0,0 +1,34 @@
+# Move AI Mocap SDK
+
+This SDK allows you to use Python to define and run Move AI Engine jobs. It currently supports running jobs on AWS, based on the availability of AMIs in your EC2 environment.
+
+### Requirements
+Python 3.10 or higher.
+
+### Installation
+
+#### With poetry
+
+```bash
+poetry add moveai-mocap-python
+```
+
+#### With pip
+
+```bash
+pip install moveai-mocap-python
+```
+
+## Quickstart
+
+See the [docs](https://move-ai.github.io/moveai-mocap-python/) for more detailed information.
+
+### Examples
+
+See the [multi camera example](https://move-ai.github.io/moveai-mocap-python/quickstart/multicam.html).
+
+See the [single camera example](https://move-ai.github.io/moveai-mocap-python/quickstart/singlecam.html).
+
+## License
+
+This project is proprietary. All rights reserved.

moveai_mocap_python-0.18.3/moveai_mocap/__init__.py

@@ -0,0 +1 @@
+"""Move.ai mocap SDK."""

moveai_mocap_python-0.18.3/moveai_mocap/compute/__init__.py

@@ -0,0 +1 @@
+"""Models for interacting with compute."""

moveai_mocap_python-0.18.3/moveai_mocap/compute/base.py

@@ -0,0 +1,41 @@
+"""Base model for compute."""
+
+import json
+from typing import Any
+
+from pydantic import BaseModel
+
+from moveai_mocap.models.base.run import BaseRunModel
+from moveai_mocap.models.notifiers.base import BaseNotifier
+
+
+class BaseComputeManager(BaseModel):
+    """Base model for the engine."""
+
+    notifier: BaseNotifier
+
+    def build_run(self, run: BaseRunModel) -> str:
+        """For the given run model add the notifier and return the model dump as json.
+
+        Args:
+            run: The run to build.
+
+        Returns:
+            The run with the notifier class, dumped as JSON
+        """
+        # We don't use `model_dump_json` as we need to add the notifier to the model dump
+        dumped_run = run.as_run()
+        # Add the notifier to the dumped run
+        dumped_run["notifier"] = self.notifier.model_dump(mode="json")
+        return json.dumps(dumped_run)
+
+    def provision(self, run: BaseRunModel) -> Any:
+        """Launch a compute instance for the appropriate compute class.
+
+        Args:
+            run: The run object that the instance is being provisioned for
+
+        Raises:
+            NotImplementedError: Must be implemented by subclass.
+        """
+        raise NotImplementedError("This method must be implemented in the subclass.")

moveai_mocap_python-0.18.3/moveai_mocap/compute/ec2.py

@@ -0,0 +1,104 @@
+"""A class that allows processing using an ec2 backend."""
+
+from __future__ import annotations
+
+import json
+import logging
+from contextlib import suppress
+from enum import Enum
+from typing import Type, cast
+
+from botocore.client import BaseClient
+from mypy_boto3_iam import IAMClient
+from pydantic import ConfigDict, Field, PrivateAttr, model_validator
+
+from moveai_mocap.compute.base import BaseComputeManager
+from moveai_mocap.compute.enums.ec2 import InstanceTypeEnum
+from moveai_mocap.compute.models.region import Region
+from moveai_mocap.compute.services.boto3.iam import IamBoto3Service
+from moveai_mocap.errors import ec2 as ec2_errors
+from moveai_mocap.errors.base import MoveError
+from moveai_mocap.logging.logger import get_logger
+from moveai_mocap.models.base.run import BaseRunModel
+
+
+class EC2ComputeManager(BaseComputeManager):
+    """The ec2 compute class."""
+
+    iam_instance_profile_name: str = Field(
+        description="The instance profile name that the EC2 instance should use.",
+    )
+    regions: list[Region] = Field(
+        description="List of regions to be used.",
+    )
+    dry_run: bool = Field(
+        default=False,
+        description="Checks whether you have the required permissions for the action, without actually making the request, and provides an error response",
+    )
+    instance_initiated_shutdown_behaviour: str = Field(
+        default="stop",
+        description="Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)",
+    )
+    instance_types: Type[Enum] = Field(
+        default=InstanceTypeEnum,
+        description="An enum of EC2 instance types. See `InstanceTypeEnum` for more information.",
+    )
+    iam_boto3_client: BaseClient = Field(
+        description="Boto3 client instance which points to `iam` service.",
+    )
+
+    model_config = ConfigDict(
+        # Allow arbitrary types to be assigned to the model (iam_boto3_client)
+        # This is because pydantic can't build its schema with iam_boto3_client by default.
+        arbitrary_types_allowed=True,
+    )
+
+    _iam_client: IamBoto3Service
+    _logger: logging.Logger = PrivateAttr(default_factory=get_logger)
+
+    @model_validator(mode="after")
+    def instantiate_private_attributes(self) -> EC2ComputeManager:
+        """Instantiate the private attributes used on this compute class.
+
+        Returns:
+            The validated object
+        """
+        self._iam_client = IamBoto3Service(
+            boto3_client=cast(IAMClient, self.iam_boto3_client),
+        )
+        return self
+
+    def provision(self, run: BaseRunModel) -> dict[str, str]:
+        """Launch an EC2 instance.
+
+        Args:
+            run: The run object that the instance is being provisioned for
+
+        Raises:
+            MoveFailedToStartEc2InstanceError: If instances cannot be started
+
+        Returns:
+            The response from the started instance
+        """
+        user_data = json.dumps(
+            {
+                "settings": self.build_run(run),
+                "shutdown": "shutdown",
+            },
+        )
+        instance_profile_id = self._iam_client.get_instance_profile(
+            instance_profile_name=self.iam_instance_profile_name,
+        )
+        for region in self.regions:
+            with suppress(MoveError):
+                return region.attempt_instance_placement(
+                    instance_types=self.instance_types,
+                    iam_instance_profile_name=self.iam_instance_profile_name,
+                    instance_initiated_shutdown_behaviour=self.instance_initiated_shutdown_behaviour,
+                    instance_profile_id=instance_profile_id,
+                    user_data=user_data,
+                    dry_run=self.dry_run,
+                ).model_dump()
+        raise ec2_errors.MoveFailedToStartEc2InstanceError(
+            "Failed to start EC2 instance in all regions, subnets and instance types.",
+        )

moveai_mocap_python-0.18.3/moveai_mocap/compute/enums/__init__.py

@@ -0,0 +1 @@
+"""Enums for use in the compute."""

moveai_mocap_python-0.18.3/moveai_mocap/compute/enums/ec2.py

@@ -0,0 +1,12 @@
+"""The AWS EC2 instance types to use - in order."""
+
+from enum import Enum
+
+
+class InstanceTypeEnum(Enum):
+    """The AWS EC2 instance types to use - in order."""
+
+    g6_xlarge: str = "g6.xlarge"
+    g6_2xlarge: str = "g6.2xlarge"
+    g6_4xlarge: str = "g6.4xlarge"
+    g6_8xlarge: str = "g6.8xlarge"

moveai_mocap_python-0.18.3/moveai_mocap/compute/local_run.py

@@ -0,0 +1,55 @@
+"""A class that allows processing using a local backend."""
+
+from __future__ import annotations
+
+import logging
+import subprocess  # noqa: S404
+import tempfile
+
+from pydantic import ConfigDict, Field, PrivateAttr
+
+from moveai_mocap.compute.base import BaseComputeManager
+from moveai_mocap.errors import local_run as local_run_errors
+from moveai_mocap.logging.logger import get_logger
+from moveai_mocap.models.base.run import BaseRunModel
+
+
+class LocalComputeManager(BaseComputeManager):
+    """The local compute class."""
+
+    dry_run: bool = Field(
+        default=False,
+        description="Checks whether you have the required permissions for the action, without actually making the request, and provides an error response",
+    )
+
+    model_config = ConfigDict(
+        # Allow arbitrary types to be assigned to the model (iam_boto3_client)
+        # This is because pydantic can't build its schema with iam_boto3_client by default.
+        arbitrary_types_allowed=True,
+    )
+
+    _logger: logging.Logger = PrivateAttr(default_factory=get_logger)
+
+    def provision(self, run: BaseRunModel) -> dict[str, str]:
+        """Launch a local instance.
+
+        Args:
+            run: The run object that the run is being provisioned for
+
+        Raises:
+            MoveFailedToStartLocalRunError: If local run cannot be started
+
+        Returns:
+            The response from the run
+        """
+        with tempfile.NamedTemporaryFile(mode="w", suffix=".json") as settings_file:
+            settings_file.write(self.build_run(run))
+            settings_file.flush()
+            res = subprocess.run(  # noqa: S603
+                ["/usr/local/bin/start_pipeline", settings_file.file.name],
+            )
+        if res.returncode == 0:
+            return {"exit": "0"}
+        raise local_run_errors.MoveFailedToStartLocalRunError(
+            "Failed to start local run",
+        )

moveai_mocap_python-0.18.3/moveai_mocap/compute/messages.py

@@ -0,0 +1,6 @@
+"""Centralised file for storing error messages."""
+
+FAILED_TO_START_WITHIN_REGION_MESSAGE = "{0}. {1}".format(
+    "Failed to start instance type {instance_type} on subnet {subnet} in region {region}",
+    "Attempting the next subnet.",
+)

moveai_mocap_python-0.18.3/moveai_mocap/compute/models/__init__.py

@@ -0,0 +1 @@
+"""Models for compute."""

moveai_mocap_python-0.18.3/moveai_mocap/compute/models/ec2.py

@@ -0,0 +1,48 @@
+"""Models for EC2 compute."""
+
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class Filter(BaseModel):
+    """Filter Schema."""
+
+    Name: str
+    Values: List[Any]
+
+
+class ModifyAttribute(BaseModel):
+    """Modify attribute schema."""
+
+    InstanceId: str
+    UserData: dict[str, Any]
+
+
+class InstanceAttributes(BaseModel):
+    """Instance Attribute schema."""
+
+    ImageId: str
+    MinCount: int = Field(default=1)
+    MaxCount: int = Field(default=1)
+    InstanceType: str
+    DryRun: bool
+    SecurityGroupIds: List[str]
+    SubnetId: str
+    InstanceInitiatedShutdownBehavior: str
+    CapacityReservationSpecification: Dict[str, str] = Field(
+        default={
+            "CapacityReservationPreference": "open",
+        },
+    )
+    UserData: Optional[Any] = Field(default=None)
+    IamInstanceProfile: Dict[str, str]
+    MetadataOptions: Dict[str, str] = Field(default={"HttpTokens": "required"})
+
+
+class EC2ProvisionResponse(BaseModel):
+    """The response from the call to `provision`."""
+
+    instance_id: str
+    instance_type: str
+    region_name: str