sprocket-systems.coda.sdk 2.0.5__py3-none-any.whl → 2.0.7__py3-none-any.whl

coda/__init__.py

@@ -1,5 +1,5 @@
 # The versions below will be replaced automatically in CI.
 # You do not need to modify any of the versions below.
-__version__ = "2.0.5"
+__version__ = "2.0.7"
 CODA_APP_SUITE_VERSION = "+coda-2.0.12"
 FINAL_VERSION = __version__ + CODA_APP_SUITE_VERSION

coda/sdk/constants.py

@@ -7,8 +7,6 @@ ENV_CODA_API_TOKEN = "CODA_API_TOKEN"
 ENV_CODA_API_INSECURE_SKIP_VERIFY = "CODA_API_INSECURE_SKIP_VERIFY"
 ENV_CODA_CLI_EXE = "CODA_CLI_EXE"
 ENV_NO_CODA_EXE = "NO_CODA_EXE"
-ENV_S3_SRC_ROLE = "S3_SRC_ROLE"
-ENV_S3_SRC_EXTERNAL_ID = "S3_SRC_EXTERNAL_ID"
 
 # Default Values
 DEFAULT_API_URL = "https://v2.coda.sprocket.systems"

coda/sdk/essence.py

@@ -219,6 +219,7 @@ class Essence:
                 res["resource"]["auth"] = auth
             if opts is not None:
                 res["resource"]["opts"] = opts
+            print(res)
             self.payload["definition"]["resources"].append(res)
 
     def override_stem_type(self, stem_type: InputStemType) -> None:
@@ -298,12 +299,13 @@ class Essence:
 
     @staticmethod
     def essences_from_files(
-        files: List,
+        files: list,
         io_location_id: str | None = None,
-        file_info: Dict | None = None,
+        file_info: dict | None = None,
         program: str = "",
-        forced_frame_rate: str | None = None
-    ) -> List["Essence"]:
+        forced_frame_rate: str | None = None,
+        no_file_scan: bool = False
+    ) -> list["Essence"]:
         """Create a list of CodaEssence objects from files.
 
         This method inspects local files using the 'coda inspect' command-line tool
@@ -315,19 +317,26 @@ class Essence:
             io_location_id (str, optional): The IO Location ID associated with the source files. Required for agent transfers.
             file_info (dict, optional): Manual override info for files. Required for S3.
                 Should contain keys like 'format', 'type', 'frames', 's3_auth'. Defaults to None.
-                Example: file_info = {
+                Examples: file_info = {
                             "frames": 720000,
                             "format": Format.SEVEN_ONE,
                             "type": InputStemType.PRINTMASTER,
                             "s3_auth": {
-                                "role": os.getenv(ENV_S3_SRC_ROLE, "XXXX"),
-                                "external_id": os.getenv(ENV_S3_SRC_EXTERNAL_ID, "XXXX"),
+                                "iam_role": os.getenv(ENV_S3_ROLE, "XXXX"),
+                                "iam_external_id": os.getenv(ENV_S3_EXTERNAL_ID, "XXXX"),
                             },
                             "s3_options": {"region": "us-west-2"},
                         }
+
+                        Note: `s3_auth` may also use S3 access key secret and ID
+                        "s3_auth": {
+                            "access_key_id": os.getenv(ENV_S3_ACCESS_KEY_ID, "XXXX"),
+                            "secret_access_key": os.getenv(ENV_S3_SECRET_ACCESS_KEY, "XXXX"),
+                        }
             program (str, optional): The program identifier to assign to the essences.
                 Defaults to "".
             forced_frame_rate (str, optional): Specify the frame rate to calculate the FFOA and LFOA
+            no_file_scan (bool, optional): Do not use Coda CLI to scan files for metadata
 
         Raises:
             ValueError: If `files` is not populated with a list of file paths.
@@ -355,7 +364,7 @@ class Essence:
 
             absfiles = [str(Path(f).resolve()) for f in local_files]
             codaexe = shutil.which("coda") or os.getenv(ENV_CODA_CLI_EXE)
-            if not codaexe or os.getenv(ENV_NO_CODA_EXE) is not None:
+            if not codaexe or os.getenv(ENV_NO_CODA_EXE) is not None or no_file_scan is True:
                 if not file_info:
                     raise ValueError("Coda CLI not found and file_info was not provided for manual creation.")
 
@@ -440,6 +449,7 @@ class Essence:
             essence = Essence(
                 file_info["format"], stem_type=file_info["type"], program=program
             )
+
             res = [
                 {
                     "url": r,

coda/sdk/job.py

@@ -214,9 +214,16 @@ class JobPayloadBuilder:
             JobPayloadBuilder: The builder instance for fluent chaining.
 
         Raises:
+            ValueError: If no essences have been added yet.
             ValueError: If any essence has an incompatible format.
 
         """
+        if not self._essences:
+            raise ValueError(
+                "Cannot force imax5. No essences have been added. "
+                "Call with_essences() before using this method."
+            )
+
         incompatible_formats = [
             essence.payload["definition"]["format"]
             for essence in self._essences
@@ -242,7 +249,16 @@ class JobPayloadBuilder:
         Returns:
             JobPayloadBuilder: The builder instance for fluent chaining.
 
+        Raises:
+            ValueError: If no essences have been added yet.
+
         """
+        if not self._essences:
+            raise ValueError(
+                "Cannot set input language. No essences have been added. "
+                "Call with_essences() before using this method."
+            )
+
         for essence in self._essences:
             essence.payload["definition"]["language"] = language.value
         return self
@@ -259,7 +275,16 @@ class JobPayloadBuilder:
         Returns:
             JobPayloadBuilder: The builder instance for fluent chaining.
 
+        Raises:
+            ValueError: If no essences have been added yet.
+
         """
+        if not self._essences:
+            raise ValueError(
+                "Cannot set program for type. No essences have been added. "
+                "Call with_essences() before using this method."
+            )
+
         for essence in self._essences:
             if type in essence.payload["definition"]["type"]:
                 essence.payload["definition"]["program"] = program
@@ -277,7 +302,16 @@ class JobPayloadBuilder:
         Returns:
             JobPayloadBuilder: The builder instance for fluent chaining.
 
+        Raises:
+            ValueError: If no essences have been added yet.
+
         """
+        if not self._essences:
+            raise ValueError(
+                "Cannot set program for format. No essences have been added. "
+                "Call with_essences() before using this method."
+            )
+
         for essence in self._essences:
             if format == essence.payload["definition"]["format"]:
                 essence.payload["definition"]["program"] = program
@@ -292,7 +326,16 @@ class JobPayloadBuilder:
         Returns:
             JobPayloadBuilder: The builder instance for fluent chaining.
 
+        Raises:
+            ValueError: If no essences have been added yet.
+
         """
+        if not self._essences:
+            raise ValueError(
+                "Cannot set unique program. No essences have been added. "
+                "Call with_essences() before using this method."
+            )
+
         for essence in self._essences:
             essence.payload["definition"]["program"] = program
         return self
@@ -318,13 +361,6 @@ class JobPayloadBuilder:
         lfoa = None
         fr = None
 
-        for e in self._essences:
-            essence_timing = e.payload["timing_info"]
-            if essence_timing:
-                ffoa = essence_timing["ffoa_timecode"]
-                lfoa = essence_timing["lfoa_timecode"]
-                fr = essence_timing["source_frame_rate"]
-
         if self._time_options.get("frame_rate"):
             fr = self._time_options.get("frame_rate")
         if self._time_options.get("ffoa"):
@@ -332,6 +368,17 @@ class JobPayloadBuilder:
         if self._time_options.get("lfoa"):
             lfoa = self._time_options.get("lfoa")
 
+        for e in self._essences:
+            current_timing = e.payload.get("timing_info") or {}
+            new_timing = dict(current_timing)
+            if not new_timing.get("ffoa_timecode"):
+                new_timing["ffoa_timecode"] = ffoa
+            if not new_timing.get("lfoa_timecode"):
+                new_timing["lfoa_timecode"] = lfoa
+            if not new_timing.get("source_frame_rate"):
+                new_timing["source_frame_rate"] = fr
+            e.payload["timing_info"] = new_timing
+
         sources = [e.dict() for e in self._essences]
 
         start_time = self._time_options.get("start_time")

coda/sdk/preset.py

@@ -168,7 +168,7 @@ class Preset:
 
     @staticmethod
     def get_io_location_id_by_name(io_location_name: str) -> str:
-        """Get an IO Location ID by its name.
+        """Get an IO Location ID by its name. Requires Org Admin/Owner API token.
 
         Args:
             io_location_name (str): The name of the IO location to search for.
@@ -213,3 +213,27 @@ class Preset:
             raise ValueError(f"Multiple workflows found with name '{workflow_name}': {[w['id'] for w in matches]}")
 
         return matches[0]
+
+    @staticmethod
+    def get_naming_convention_by_name(naming_convention_name: str) -> dict:
+        """Get a naming convention by its name.
+
+        Args:
+            naming_convention_name (str): The name of the naming convention to search for.
+
+        Returns:
+            dict: The complete naming_convention object.
+
+        Raises:
+            ValueError: If no naming convention with the given name is found, or if multiple match.
+
+        """
+        naming_conventions = Preset.get_presets(PresetType.NAMING)
+        matches = [n for n in naming_conventions if n["name"] == naming_convention_name]
+
+        if len(matches) == 0:
+            raise ValueError(f"No naming convention found with name '{naming_convention_name}'")
+        if len(matches) > 1:
+            raise ValueError(f"Multiple naming conventions found with name '{naming_convention_name}': {[n['id'] for n in matches]}")
+
+        return matches[0]["convention_data"]

coda/sdk/workflow.py

@@ -995,7 +995,10 @@ class WorkflowDefinitionBuilder:
         venues = []
         for block_id in blist:
             block = self._process_blocks[block_id]
-            venues.append(block["output_settings"]["venue"])
+            venue_type = block.get("output_settings").get("venue")
+            venue = self._ALL_FROM_ESSENCE if venue_type == self._SAME_AS_INPUT else venue_type
+            venues.append(venue)
+
             for fr_original in output_frame_rates:
                 for f_original in output_formats:
                     for t_original in output_stem_types:
@@ -1078,7 +1081,10 @@ class WorkflowDefinitionBuilder:
 
         for block_id in blist:
             block = self._process_blocks[block_id]
-            venues.append(block["output_settings"]["venue"])
+            venue_type = block.get("output_settings").get("venue")
+            venue = self._ALL_FROM_ESSENCE if venue_type == self._SAME_AS_INPUT else venue_type
+            venues.append(venue)
+
             fmt = Format.ATMOS
             fr = self._SAME_AS_INPUT if output_frame_rate == self._ALL_FROM_ESSENCE else output_frame_rate
             st = self._SAME_AS_INPUT if output_stem_type == self._ALL_FROM_ESSENCE else output_stem_type

{sprocket_systems_coda_sdk-2.0.5.dist-info → sprocket_systems_coda_sdk-2.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sprocket-systems.coda.sdk
-Version: 2.0.5
+Version: 2.0.7
 Summary: The Coda SDK provides a Python interface to define Coda workflows, create jobs and run them.
 Keywords: python,coda,sdk
 Author-Email: Sprocket Systems <support@sprocket.systems>
@@ -9,13 +9,10 @@ License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Project-URL: Documentation, https://v2.coda.sprocket.systems/docs/sdks/python/
-Requires-Python: >=3.7
+Requires-Python: >=3.11
 Requires-Dist: requests
 Requires-Dist: soundfile>=0.13.1
 Description-Content-Type: text/markdown

sprocket_systems_coda_sdk-2.0.7.dist-info/RECORD

@@ -0,0 +1,15 @@
+coda/__init__.py,sha256=Yh8vyckIapgq2CptJp72Gm6OgtnxtzocwjzOIrof1X8,229
+coda/sdk/__init__.py,sha256=wOCrh1piLbgLVOMhKuLFYA62n60IN89eXGHpFKwFAE4,691
+coda/sdk/constants.py,sha256=DW-goGI4vTlt8KeR4z0sf89Duov4TgZdsjv1VJDuAQI,596
+coda/sdk/enums.py,sha256=1l4pK8pNofV56WVAiQXitlY6m9iTfEv9I159GWkTZKE,6582
+coda/sdk/essence.py,sha256=vSx2lp1I0yJvFNMcAWqF-I3BV9q_bRnZbtSEf_QArHg,20764
+coda/sdk/job.py,sha256=WArS06ufJUZLDdx6wJHgwk2olYjtX3w_sJqPF_XEu6A,21538
+coda/sdk/preset.py,sha256=OtaRVJU6luBBD_6Ehd8ZkcjXL_YVoXfziI14E-GS4Xw,8934
+coda/sdk/utils.py,sha256=uC9hHJtMkGu3pLvJOwq9kIdf6r7KxMRAbzaRyf95EdQ,10565
+coda/sdk/workflow.py,sha256=QpGvjkNuFKh5XyawC7HXyx-nmC4EKbdRc-6eIjaQ79Q,63171
+coda/tc_tools.py,sha256=hEtVE6xtPqg93WfJ-lQdRQroPdQTkH5HkMLWCIkwIlo,22010
+sprocket_systems_coda_sdk-2.0.7.dist-info/METADATA,sha256=DJRra7QdThUQVFDJZiQxWmy4X11iq6gu_SZNlrVPcaw,1106
+sprocket_systems_coda_sdk-2.0.7.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
+sprocket_systems_coda_sdk-2.0.7.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+sprocket_systems_coda_sdk-2.0.7.dist-info/licenses/LICENSE,sha256=wrFjizFlraIAPW8JIteGftNH2laAZBBRhdEnPVUsKTM,10198
+sprocket_systems_coda_sdk-2.0.7.dist-info/RECORD,,

sprocket_systems_coda_sdk-2.0.5.dist-info/RECORD

@@ -1,15 +0,0 @@
-coda/__init__.py,sha256=A5O6J7ACQsUK8TvmgzsxIrWX_dYll0VQGuGAuI7X5FE,229
-coda/sdk/__init__.py,sha256=wOCrh1piLbgLVOMhKuLFYA62n60IN89eXGHpFKwFAE4,691
-coda/sdk/constants.py,sha256=HRWf8zE8IFVRy-2apsae4BSecXod3BsQiozaMkJkY88,674
-coda/sdk/enums.py,sha256=1l4pK8pNofV56WVAiQXitlY6m9iTfEv9I159GWkTZKE,6582
-coda/sdk/essence.py,sha256=sv4ge8d--cTzXj0Qp7tHOn3skUIhV_KIej3v2kB2XvE,20264
-coda/sdk/job.py,sha256=7wV9-y9Xvi8QN9BJ3AtugMj-CQqH226DYf_GXLe-Ucw,19868
-coda/sdk/preset.py,sha256=93IKUSSEWe-E-jOOdM_TxJveICc3aKD8fY8_avg1Gbw,7951
-coda/sdk/utils.py,sha256=uC9hHJtMkGu3pLvJOwq9kIdf6r7KxMRAbzaRyf95EdQ,10565
-coda/sdk/workflow.py,sha256=4-r3hWUEabyzS1vA0Ql-1VY5FoQA3KNnWlhwqQ0umbw,62899
-coda/tc_tools.py,sha256=hEtVE6xtPqg93WfJ-lQdRQroPdQTkH5HkMLWCIkwIlo,22010
-sprocket_systems_coda_sdk-2.0.5.dist-info/METADATA,sha256=ha_aEO7RaRRntAQYzBsLVf1geHXvFoVfcso8mB6Vyvc,1252
-sprocket_systems_coda_sdk-2.0.5.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
-sprocket_systems_coda_sdk-2.0.5.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-sprocket_systems_coda_sdk-2.0.5.dist-info/licenses/LICENSE,sha256=wrFjizFlraIAPW8JIteGftNH2laAZBBRhdEnPVUsKTM,10198
-sprocket_systems_coda_sdk-2.0.5.dist-info/RECORD,,