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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sprocket-systems.coda.sdk
-Version: 1.3.3
+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,18 +9,16 @@ 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
-Project-URL: Documentation, https://coda.sprocket.systems/docs/sdks/python/
-Requires-Python: >=3.7
+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.11
 Requires-Dist: requests
+Requires-Dist: soundfile>=0.13.1
 Description-Content-Type: text/markdown
 
 # Coda Python SDK
 
 Coda provides a Python SDK that streamlines interactions with the core API. It provides the ability to define Coda workflows, create jobs, and run them.
 
-Please see [the documentation](https://coda.sprocket.systems/docs/sdks/python/) for more information.
+Please see [the documentation](https://v2.coda.sprocket.systems/docs/sdks/python/) for more information.

{sprocket_systems_coda_sdk-1.3.3 → sprocket_systems_coda_sdk-2.0.6}/PYPI_README.md

@@ -2,4 +2,4 @@
 
 Coda provides a Python SDK that streamlines interactions with the core API. It provides the ability to define Coda workflows, create jobs, and run them.
 
-Please see [the documentation](https://coda.sprocket.systems/docs/sdks/python/) for more information.
+Please see [the documentation](https://v2.coda.sprocket.systems/docs/sdks/python/) for more information.

{sprocket_systems_coda_sdk-1.3.3 → 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,19 +20,17 @@ 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 = "1.3.3"
+version = "2.0.6"
 
 [project.urls]
-Documentation = "https://coda.sprocket.systems/docs/sdks/python/"
+Documentation = "https://v2.coda.sprocket.systems/docs/sdks/python/"
 
 [build-system]
 requires = [
@@ -54,3 +52,8 @@ excludes = [
     "dev",
     "utilities",
 ]
+
+[dependency-groups]
+dev = [
+    "pydoc-markdown>=4.8.2",
+]

sprocket_systems_coda_sdk-2.0.6/src/coda/__init__.py

@@ -0,0 +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.6"
+CODA_APP_SUITE_VERSION = "+coda-2.0.12"
+FINAL_VERSION = __version__ + CODA_APP_SUITE_VERSION

sprocket_systems_coda_sdk-2.0.6/src/coda/sdk/__init__.py

@@ -0,0 +1,27 @@
+from .job import Job, JobPayloadBuilder
+from .essence import Essence
+from .workflow import WorkflowDefinition, WorkflowDefinitionBuilder
+from .preset import Preset
+from .enums import PresetType, SourceType, VenueType, InputFilter, Language, Format, StemType, FrameRate, InputStemType
+from .utils import user_info, timing_info, get_channels
+
+__all__ = [
+    "Job",
+    "JobPayloadBuilder",
+    "Essence",
+    "WorkflowDefinition",
+    "WorkflowDefinitionBuilder",
+    "Preset",
+    "PresetType",
+    "SourceType",
+    "VenueType",
+    "InputStemType",
+    "InputFilter",
+    "Language",
+    "Format",
+    "StemType",
+    "FrameRate",
+    "user_info",
+    "get_channels",
+    "timing_info",
+]

sprocket_systems_coda_sdk-2.0.6/src/coda/sdk/constants.py

@@ -0,0 +1,22 @@
+"""Constants used throughout the Coda SDK."""
+
+# Environment Variable Names
+ENV_CODA_API_GROUP_ID = "CODA_API_GROUP_ID"
+ENV_CODA_API_URL = "CODA_API_URL"
+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"
+DEFAULT_PROGRAM_ID = "program-1"
+DEFAULT_BIT_DEPTH = 24
+DEFAULT_SAMPLE_RATE = 48000
+INSECURE_SKIP_VERIFY_VALUES = ("true", "1", "yes")
+
+# URL Prefixes
+URL_PREFIX_S3 = "s3://"
+URL_PREFIX_IO = "io://"

sprocket_systems_coda_sdk-2.0.6/src/coda/sdk/enums.py

@@ -0,0 +1,270 @@
+from enum import StrEnum
+
+
+class PresetType(StrEnum):
+    """Enums for the different types of presets available in Coda."""
+
+    JOBS = "jobs"
+    WORKFLOWS = "workflows"
+    LOUDNESS = "loudness"
+    TIMECODE = "timecode"
+    GROUPS = "groups"
+    NAMING = "naming"
+    DOLBY = "dolby"
+    DTS = "dts"
+    SUPER_SESSION = "super_session"
+    IO_LOCATIONS = "io_locations"
+
+
+class SourceType(StrEnum):
+    """Enums for the different types of input sources for a job."""
+
+    INTERLEAVED = "interleaved"
+    MULTI_MONO = "multi_mono"
+    ADM = "bwav_adm"
+    IAB_MXF = "iab_mxf"
+
+
+class VenueType(StrEnum):
+    """Enums for the different venues supported."""
+
+    NEARFIELD = "nearfield"
+    THEATRICAL = "theatrical"
+    ALL_FROM_ESSENCE = "all_from_essence"
+    SAME_AS_INPUT = "same_as_input"
+
+
+class InputFilter(StrEnum):
+    """Enums for the input filters used in workflow process blocks."""
+
+    ALL_STEMS = "all_stems"
+    ALL_STEMS_EXCEPT_OPTIONALS = "all_stems_except_optionals"
+    ALL_DX = "all_dx"
+    ALL_MX = "all_mx"
+    ALL_FX = "all_fx"
+    MNE_STEMS = "m&e_stems"
+    OPTIONALS_ONLY = "optionals_only"
+    PRINTMASTER_ONLY = "printmaster_only"
+
+
+class Language(StrEnum):
+    """Enums for language codes."""
+
+    NO_LINGUISTIC_CONTENT = "ZXX"
+    QUALIFIED_FOR_ALL_LANGUAGES = "QAL"
+    SEMI_TEXTLESS = "STX"
+    ENGLISH = "ENG"
+    AFRIKAANS = "AFK"
+    ALBANIAN = "SQI"
+    AMERICAN_SIGN_LANGUAGE = "ASE"
+    ARABIC_MODERN_STANDARD = "MSA"
+    ARABIC_EGYPTIAN = "ARE"
+    ARABIC_UAE_LEBANON = "ARL"
+    ARABIC_CLASSICAL_FORMAL = "QCA"
+    ARABIC_SYRIAN = "ASY"
+    ARAMAIC = "ARC"
+    ARMENIAN = "HYE"
+    AZERBAIJANI = "AZE"
+    BELARUSIAN = "BEL"
+    BOSNIAN = "BOS"
+    BRITISH_SIGN_LANGUAGE = "BFI"
+    BULGARIAN = "BUL"
+    BURMESE = "BUR"
+    CATALAN_VALENCIAN = "SCA"
+    CHEROKEE = "CHR"
+    CHINESE_CANTONESE = "CNT"
+    CHINESE_MANDARIN_PRC = "PRC"
+    CHINESE_MANDARIN_TAIWAN = "QMT"
+    CHINESE_MIN_NAN = "TAI"
+    CHINESE_SIMPLIFIED_CHARACTERS = "CMN"
+    CHINESE_SIMPLIFIED_CHARACTERS_MALAYSIA = "ZM1"
+    CHINESE_SIMPLIFIED_CHARACTERS_PRC = "CN1"
+    CHINESE_SIMPLIFIED_CHARACTERS_SINGAPORE = "ZS1"
+    CHINESE_TRADITIONAL_CHARACTERS = "CM1"
+    CHINESE_TRADITIONAL_CHARACTERS_HONG_KONG = "YU1"
+    CHINESE_TRADITIONAL_CHARACTERS_TAIWAN = "ZT1"
+    CHINESE_WU = "WUU"
+    CHOCTAW = "CHO"
+    COMANCHE = "COM"
+    CROATIAN = "CRO"
+    CZECH = "CZE"
+    DANISH = "DAN"
+    DUTCH = "DUT"
+    DUTCH_FLEMISH = "DFD"
+    ENGLISH_AUSTRALIAN = "AUS"
+    ENGLISH_BRITISH = "EUK"
+    ENGLISH_FOR_INDONESIA = "ENI"
+    ENGLISH_FOR_PHILIPPINES = "ENP"
+    ESTONIAN = "EST"
+    FARSI_PERSIAN = "PER"
+    FINNISH = "FIN"
+    FLEMISH = "FLM"
+    FRENCH_CANADIAN_QUEBECOIS = "FRC"
+    FRENCH_FRANCE = "FRP"
+    GEORGIAN = "GEO"
+    GERMAN = "GER"
+    GERMAN_AUSTRIAN = "AST"
+    GERMAN_SWISS_ALSATIAN = "SWI"
+    GREEK_MODERN = "GRK"
+    HAWAIIAN = "HAW"
+    HEBREW = "HEB"
+    HINDI = "HIN"
+    HUNGARIAN = "HUN"
+    ICELANDIC = "ICE"
+    INDONESIAN_BAHASA = "INB"
+    ITALIAN = "ITA"
+    JAPANESE = "JPN"
+    KANNADA = "KAN"
+    KAZAKH = "KAZ"
+    KOREAN = "KOR"
+    LAKOTA = "LKT"
+    LATIN = "LAT"
+    LATVIAN = "LTV"
+    LITHUANIAN = "LTH"
+    LUXEMBOURGISH = "LTZ"
+    MACEDONIAN = "MAS"
+    MALAY_BAHASA = "MAB"
+    MALAYALAM = "MYM"
+    MAORI = "MAO"
+    MOHAWK = "MOH"
+    MONGOLIAN = "MON"
+    NORTHERN_SAMI = "SME"
+    NORWEGIAN = "NOR"
+    OJIBWE = "OJI"
+    PANJABI = "PAN"
+    POLISH = "POL"
+    PORTUGUESE_BRAZILIAN = "PTB"
+    PORTUGUESE_EUROPEAN = "PTE"
+    PUSHTO = "PUS"
+    ROMANIAN_MOLDAVIAN = "ROM"
+    RUSSIAN = "RUS"
+    SERBIAN = "SER"
+    SLAVIC = "SLA"
+    SLOVAK = "SLK"
+    SLOVENIAN = "SLV"
+    SOMALI = "SOM"
+    SPANISH_ARGENTINIAN = "SPA"
+    SPANISH_CASTILIAN = "SPC"
+    SPANISH_CHILEAN = "ECH"
+    SPANISH_LATIN_AMERICAN = "LAS"
+    SPANISH_MEXICAN = "SPM"
+    SWEDISH = "SWE"
+    TAGALOG = "TAG"
+    TAIWANESE_MIN_NAN = "TAI"
+    TAMIL = "TAM"
+    TELUGU = "TEL"
+    THAI = "THA"
+    THAI_ISAN = "TTS"
+    TURKISH = "TUR"
+    UKRAINIAN = "UKR"
+    URDU = "URD"
+    VIETNAMESE = "VIE"
+    UNDETERMINED = "UND"
+
+
+class Format(StrEnum):
+    """Enums for supported audio channel configurations."""
+
+    ONE_ZERO = "1.0"
+    TWO_ZERO = "2.0"
+    THREE_ZERO = "3.0"
+    LCRS = "LCRS"
+    FIVE_ZERO = "5.0"
+    FIVE_ZERO_TWO = "5.0.2"
+    SEVEN_ZERO = "7.0"
+    SEVEN_ONE = "7.1"
+    FIVE_ONE = "5.1"
+    FIVE_ONE_ONE = "5.1.1"
+    FIVE_ONE_TWO = "5.1.2"
+    FIVE_ZERO_FOUR = "5.0.4"
+    SEVEN_ZERO_TWO = "7.0.2"
+    FIVE_ONE_FOUR = "5.1.4"
+    SEVEN_ONE_TWO = "7.1.2"
+    SEVEN_ZERO_FOUR = "7.0.4"
+    SEVEN_ONE_FOUR = "7.1.4"
+    SEVEN_ONE_FIVE = "7.1.5"
+    SEVEN_ZERO_SIX = "7.0.6"
+    NINE_ZERO_FOUR = "9.0.4"
+    SEVEN_ONE_SIX = "7.1.6"
+    NINE_ONE_FOUR = "9.1.4"
+    NINE_ZERO_SIX = "9.0.6"
+    NINE_ONE_SIX = "9.1.6"
+    IMAX5 = "imax5"
+    IMAX6 = "imax6"
+    IMAX12 = "imax12"
+    ATMOS = "atmos"
+    ALL_FROM_ESSENCE = "all_from_essence"
+
+
+class StemType(StrEnum):
+    """Enums for stem types."""
+
+    PRINTMASTER = "printmaster"
+    MNE = "mne"
+    DME = "dme"
+    WIDES = "wides"
+    ALL_FROM_ESSENCE = "all_from_essence"
+
+
+class FrameRate(StrEnum):
+    """Enums for frame rates."""
+
+    TWENTY_THREE = "23"
+    TWENTY_FOUR = "24"
+    TWENTY_FIVE = "25"
+    TWENTY_NINE = "29"
+    TWENTY_NINE_DROP_FRAME = "29DF"
+    THIRTY = "30"
+    ALL_FROM_ESSENCE = "all_from_essence"
+
+
+class InputStemType(StrEnum):
+    """Enums for input source stem types."""
+
+    PRINTMASTER = "audio/pm"
+    DX_COMP = "audio/dxcomp"
+    FX_COMP = "audio/fxcomp"
+    MX_COMP = "audio/mxcomp"
+    DX = "audio/dx"
+    MX = "audio/mx"
+    FX = "audio/fx"
+    BG = "audio/bg"
+    FOL = "audio/fol"
+    LG = "audio/lg"
+    PFX = "audio/pfx"
+    ADR = "audio/adr"
+    SONG = "audio/sng"
+    SCORE = "audio/scr"
+    VOX = "audio/vox"
+    FIX = "audio/fix"
+    FFFX = "audio/fffx"
+    MNE = "audio/mne"
+    MNE_MX = "audio/mnemx"
+    OPT_A = "audio/opta"
+    OPT_B = "audio/optb"
+    OPT_C = "audio/optc"
+    OPT_D = "audio/optd"
+    OPT_E = "audio/opte"
+    OPT_F = "audio/optf"
+    OPT_G = "audio/optg"
+    AUDIO_DESCRIPTION = "audio/audiodescription"
+    ARCH = "audio/arch"
+    VO = "audio/vo"
+    CRD = "audio/crd"
+    NAR = "audio/nar"
+
+
+class PackageType(StrEnum):
+    """Enums for the different types of packages that can be created in a workflow."""
+
+    ADM = "adm"
+    DTS = "dts"
+    IMAX_ENHANCED = "imax_enhanced"
+    DOLBY = "dolby"
+    DCP_MXF = "dcp_mxf"
+    MULTI_MONO_REELS = "multi_mono_reels"
+    SUPER_SESSION = "super_session"
+    INTERLEAVED = "interleaved"
+    MOV = "mov"
+    MULTI_MONO = "multi_mono"
+    # IAB_MXF = "iab_mxf"