sprocket-systems.coda.sdk 2.0.5__tar.gz → 2.0.6__tar.gz

{sprocket_systems_coda_sdk-2.0.5 → sprocket_systems_coda_sdk-2.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sprocket-systems.coda.sdk
-Version: 2.0.5
+Version: 2.0.6
 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.5 → sprocket_systems_coda_sdk-2.0.6}/pyproject.toml

@@ -5,7 +5,7 @@ description = "The Coda SDK provides a Python interface to define Coda workflows
 authors = [
     { name = "Sprocket Systems", email = "support@sprocket.systems" },
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.11"
 readme = "PYPI_README.md"
 license = "LicenseRef-Tomorrow-Open-Source-Technology-License-1.0"
 license-files = [
@@ -20,17 +20,14 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Topic :: Software Development :: Libraries :: Python Modules",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
     "requests",
     "soundfile>=0.13.1",
 ]
-version = "2.0.5"
+version = "2.0.6"
 
 [project.urls]
 Documentation = "https://v2.coda.sprocket.systems/docs/sdks/python/"
@@ -55,3 +52,8 @@ excludes = [
     "dev",
     "utilities",
 ]
+
+[dependency-groups]
+dev = [
+    "pydoc-markdown>=4.8.2",
+]

{sprocket_systems_coda_sdk-2.0.5 → sprocket_systems_coda_sdk-2.0.6}/src/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.6"
 CODA_APP_SUITE_VERSION = "+coda-2.0.12"
 FINAL_VERSION = __version__ + CODA_APP_SUITE_VERSION

{sprocket_systems_coda_sdk-2.0.5 → sprocket_systems_coda_sdk-2.0.6}/src/coda/sdk/essence.py

@@ -298,12 +298,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
@@ -328,6 +329,7 @@ class Essence:
             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 +357,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.")
 

{sprocket_systems_coda_sdk-2.0.5 → sprocket_systems_coda_sdk-2.0.6}/src/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

{sprocket_systems_coda_sdk-2.0.5 → sprocket_systems_coda_sdk-2.0.6}/src/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"]