capo-codecatalyst 0.1.0__py3-none-any.whl

capo_codecatalyst/types/workflow_run_status.py

@@ -0,0 +1,5 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowRunStatus``."""
+
+from typing import TypeAlias
+
+WorkflowRunStatus: TypeAlias = str

capo_codecatalyst/types/workflow_run_status_reason.py

@@ -0,0 +1,18 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowRunStatusReason``."""
+
+from typing_extensions import TypedDict
+
+
+class WorkflowRunStatusReason(TypedDict, closed=True):
+    pass
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowRunStatusReason) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> WorkflowRunStatusReason:
+    out: WorkflowRunStatusReason = {}  # type: ignore[typeddict-item]
+    return out

capo_codecatalyst/types/workflow_run_status_reasons.py

@@ -0,0 +1,35 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowRunStatusReasons``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_codecatalyst.types.workflow_run_status_reason
+
+WorkflowRunStatusReasons: TypeAlias = list[
+    "capo_codecatalyst.types.workflow_run_status_reason.WorkflowRunStatusReason"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowRunStatusReasons) -> list:
+    import capo_codecatalyst.types.workflow_run_status_reason
+
+    out: list = []
+    for item in value:
+        out.append(
+            capo_codecatalyst.types.workflow_run_status_reason.serialize_json(item)
+        )
+    return out
+
+
+def deserialize_json(data: list) -> WorkflowRunStatusReasons:
+    import capo_codecatalyst.types.workflow_run_status_reason
+
+    out: WorkflowRunStatusReasons = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(
+            capo_codecatalyst.types.workflow_run_status_reason.deserialize_json(item)
+        )
+    return out

capo_codecatalyst/types/workflow_run_summaries.py

@@ -0,0 +1,31 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowRunSummaries``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_codecatalyst.types.workflow_run_summary
+
+WorkflowRunSummaries: TypeAlias = list[
+    "capo_codecatalyst.types.workflow_run_summary.WorkflowRunSummary"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowRunSummaries) -> list:
+    import capo_codecatalyst.types.workflow_run_summary
+
+    out: list = []
+    for item in value:
+        out.append(capo_codecatalyst.types.workflow_run_summary.serialize_json(item))
+    return out
+
+
+def deserialize_json(data: list) -> WorkflowRunSummaries:
+    import capo_codecatalyst.types.workflow_run_summary
+
+    out: WorkflowRunSummaries = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(capo_codecatalyst.types.workflow_run_summary.deserialize_json(item))
+    return out

capo_codecatalyst/types/workflow_run_summary.py

@@ -0,0 +1,119 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowRunSummary``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+from capo_codecatalyst.errors import DeserializationError
+
+if TYPE_CHECKING:
+    import capo_codecatalyst.types.timestamp
+    import capo_codecatalyst.types.uuid
+    import capo_codecatalyst.types.workflow_run_status
+    import capo_codecatalyst.types.workflow_run_status_reasons
+
+
+class WorkflowRunSummary(TypedDict, closed=True):
+    id: "capo_codecatalyst.types.uuid.Uuid"
+    """<p>The system-generated unique ID of the workflow run.</p>"""
+    workflow_id: "capo_codecatalyst.types.uuid.Uuid"
+    """<p>The system-generated unique ID of the workflow.</p>"""
+    workflow_name: "str"
+    """<p>The name of the workflow.</p>"""
+    status: "capo_codecatalyst.types.workflow_run_status.WorkflowRunStatus"
+    """<p>The status of the workflow run.</p>"""
+    status_reasons: NotRequired[
+        "capo_codecatalyst.types.workflow_run_status_reasons.WorkflowRunStatusReasons"
+    ]
+    """<p>The reasons for the workflow run status.</p>"""
+    start_time: "capo_codecatalyst.types.timestamp.Timestamp"
+    r"""<p>The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a>.</p>"""
+    end_time: NotRequired["capo_codecatalyst.types.timestamp.Timestamp"]
+    r"""<p>The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a> </p>"""
+    last_updated_time: "capo_codecatalyst.types.timestamp.Timestamp"
+    r"""<p>The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a> </p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowRunSummary) -> dict:
+    out: dict = {}
+    out["id"] = value["id"]
+    out["workflowId"] = value["workflow_id"]
+    out["workflowName"] = value["workflow_name"]
+    out["status"] = value["status"]
+    if "status_reasons" in value:
+        import capo_codecatalyst.types.workflow_run_status_reasons
+
+        out["statusReasons"] = (
+            capo_codecatalyst.types.workflow_run_status_reasons.serialize_json(
+                value["status_reasons"]
+            )
+        )
+    import capo_codecatalyst._protocol.serialize
+
+    out["startTime"] = capo_codecatalyst._protocol.serialize.fmt_date_time(
+        value["start_time"]
+    )
+    if "end_time" in value:
+        import capo_codecatalyst._protocol.serialize
+
+        out["endTime"] = capo_codecatalyst._protocol.serialize.fmt_date_time(
+            value["end_time"]
+        )
+    import capo_codecatalyst._protocol.serialize
+
+    out["lastUpdatedTime"] = capo_codecatalyst._protocol.serialize.fmt_date_time(
+        value["last_updated_time"]
+    )
+    return out
+
+
+def deserialize_json(data: dict) -> WorkflowRunSummary:
+    out: WorkflowRunSummary = {}  # type: ignore[typeddict-item]
+    if data.get("id") is not None:
+        out["id"] = data["id"]
+    else:
+        raise DeserializationError("WorkflowRunSummary.id required")
+    if data.get("workflowId") is not None:
+        out["workflow_id"] = data["workflowId"]
+    else:
+        raise DeserializationError("WorkflowRunSummary.workflow_id required")
+    if data.get("workflowName") is not None:
+        out["workflow_name"] = data["workflowName"]
+    else:
+        raise DeserializationError("WorkflowRunSummary.workflow_name required")
+    if data.get("status") is not None:
+        out["status"] = data["status"]
+    else:
+        raise DeserializationError("WorkflowRunSummary.status required")
+    if data.get("statusReasons") is not None:
+        import capo_codecatalyst.types.workflow_run_status_reasons
+
+        out["status_reasons"] = (
+            capo_codecatalyst.types.workflow_run_status_reasons.deserialize_json(
+                data["statusReasons"]
+            )
+        )
+    if data.get("startTime") is not None:
+        import datetime
+
+        out["start_time"] = datetime.datetime.fromisoformat(
+            data["startTime"].replace("Z", "+00:00")
+        )
+    else:
+        raise DeserializationError("WorkflowRunSummary.start_time required")
+    if data.get("endTime") is not None:
+        import datetime
+
+        out["end_time"] = datetime.datetime.fromisoformat(
+            data["endTime"].replace("Z", "+00:00")
+        )
+    if data.get("lastUpdatedTime") is not None:
+        import datetime
+
+        out["last_updated_time"] = datetime.datetime.fromisoformat(
+            data["lastUpdatedTime"].replace("Z", "+00:00")
+        )
+    else:
+        raise DeserializationError("WorkflowRunSummary.last_updated_time required")
+    return out

capo_codecatalyst/types/workflow_sort_criteria.py

@@ -0,0 +1,18 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowSortCriteria``."""
+
+from typing_extensions import TypedDict
+
+
+class WorkflowSortCriteria(TypedDict, closed=True):
+    pass
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowSortCriteria) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> WorkflowSortCriteria:
+    out: WorkflowSortCriteria = {}  # type: ignore[typeddict-item]
+    return out

capo_codecatalyst/types/workflow_sort_criteria_list.py

@@ -0,0 +1,33 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowSortCriteriaList``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_codecatalyst.types.workflow_sort_criteria
+
+WorkflowSortCriteriaList: TypeAlias = list[
+    "capo_codecatalyst.types.workflow_sort_criteria.WorkflowSortCriteria"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowSortCriteriaList) -> list:
+    import capo_codecatalyst.types.workflow_sort_criteria
+
+    out: list = []
+    for item in value:
+        out.append(capo_codecatalyst.types.workflow_sort_criteria.serialize_json(item))
+    return out
+
+
+def deserialize_json(data: list) -> WorkflowSortCriteriaList:
+    import capo_codecatalyst.types.workflow_sort_criteria
+
+    out: WorkflowSortCriteriaList = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(
+            capo_codecatalyst.types.workflow_sort_criteria.deserialize_json(item)
+        )
+    return out

capo_codecatalyst/types/workflow_status.py

@@ -0,0 +1,5 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowStatus``."""
+
+from typing import TypeAlias
+
+WorkflowStatus: TypeAlias = str

capo_codecatalyst/types/workflow_summaries.py

@@ -0,0 +1,31 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowSummaries``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_codecatalyst.types.workflow_summary
+
+WorkflowSummaries: TypeAlias = list[
+    "capo_codecatalyst.types.workflow_summary.WorkflowSummary"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowSummaries) -> list:
+    import capo_codecatalyst.types.workflow_summary
+
+    out: list = []
+    for item in value:
+        out.append(capo_codecatalyst.types.workflow_summary.serialize_json(item))
+    return out
+
+
+def deserialize_json(data: list) -> WorkflowSummaries:
+    import capo_codecatalyst.types.workflow_summary
+
+    out: WorkflowSummaries = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(capo_codecatalyst.types.workflow_summary.deserialize_json(item))
+    return out

capo_codecatalyst/types/workflow_summary.py

@@ -0,0 +1,123 @@
+"""Generated from Smithy shape ``com.amazonaws.codecatalyst#WorkflowSummary``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import TypedDict
+
+from capo_codecatalyst.errors import DeserializationError
+
+if TYPE_CHECKING:
+    import capo_codecatalyst.types.source_repository_branch_string
+    import capo_codecatalyst.types.source_repository_name_string
+    import capo_codecatalyst.types.timestamp
+    import capo_codecatalyst.types.uuid
+    import capo_codecatalyst.types.workflow_definition_summary
+    import capo_codecatalyst.types.workflow_run_mode
+    import capo_codecatalyst.types.workflow_status
+
+
+class WorkflowSummary(TypedDict, closed=True):
+    id: "capo_codecatalyst.types.uuid.Uuid"
+    """<p>The system-generated unique ID of a workflow.</p>"""
+    name: "str"
+    """<p>The name of the workflow.</p>"""
+    source_repository_name: "capo_codecatalyst.types.source_repository_name_string.SourceRepositoryNameString"
+    """<p>The name of the source repository where the workflow definition file is stored.</p>"""
+    source_branch_name: "capo_codecatalyst.types.source_repository_branch_string.SourceRepositoryBranchString"
+    """<p>The name of the branch of the source repository where the workflow definition file is stored.</p>"""
+    definition: (
+        "capo_codecatalyst.types.workflow_definition_summary.WorkflowDefinitionSummary"
+    )
+    """<p>Information about the workflow definition file.</p>"""
+    created_time: "capo_codecatalyst.types.timestamp.Timestamp"
+    r"""<p>The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a> </p>"""
+    last_updated_time: "capo_codecatalyst.types.timestamp.Timestamp"
+    r"""<p>The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href=\"https://www.rfc-editor.org/rfc/rfc3339#section-5.6\">RFC 3339</a> </p>"""
+    run_mode: "capo_codecatalyst.types.workflow_run_mode.WorkflowRunMode"
+    """<p>The run mode of the workflow.</p>"""
+    status: "capo_codecatalyst.types.workflow_status.WorkflowStatus"
+    """<p>The status of the workflow.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: WorkflowSummary) -> dict:
+    out: dict = {}
+    out["id"] = value["id"]
+    out["name"] = value["name"]
+    out["sourceRepositoryName"] = value["source_repository_name"]
+    out["sourceBranchName"] = value["source_branch_name"]
+    import capo_codecatalyst.types.workflow_definition_summary
+
+    out["definition"] = (
+        capo_codecatalyst.types.workflow_definition_summary.serialize_json(
+            value["definition"]
+        )
+    )
+    import capo_codecatalyst._protocol.serialize
+
+    out["createdTime"] = capo_codecatalyst._protocol.serialize.fmt_date_time(
+        value["created_time"]
+    )
+    import capo_codecatalyst._protocol.serialize
+
+    out["lastUpdatedTime"] = capo_codecatalyst._protocol.serialize.fmt_date_time(
+        value["last_updated_time"]
+    )
+    out["runMode"] = value["run_mode"]
+    out["status"] = value["status"]
+    return out
+
+
+def deserialize_json(data: dict) -> WorkflowSummary:
+    out: WorkflowSummary = {}  # type: ignore[typeddict-item]
+    if data.get("id") is not None:
+        out["id"] = data["id"]
+    else:
+        raise DeserializationError("WorkflowSummary.id required")
+    if data.get("name") is not None:
+        out["name"] = data["name"]
+    else:
+        raise DeserializationError("WorkflowSummary.name required")
+    if data.get("sourceRepositoryName") is not None:
+        out["source_repository_name"] = data["sourceRepositoryName"]
+    else:
+        raise DeserializationError("WorkflowSummary.source_repository_name required")
+    if data.get("sourceBranchName") is not None:
+        out["source_branch_name"] = data["sourceBranchName"]
+    else:
+        raise DeserializationError("WorkflowSummary.source_branch_name required")
+    if data.get("definition") is not None:
+        import capo_codecatalyst.types.workflow_definition_summary
+
+        out["definition"] = (
+            capo_codecatalyst.types.workflow_definition_summary.deserialize_json(
+                data["definition"]
+            )
+        )
+    else:
+        raise DeserializationError("WorkflowSummary.definition required")
+    if data.get("createdTime") is not None:
+        import datetime
+
+        out["created_time"] = datetime.datetime.fromisoformat(
+            data["createdTime"].replace("Z", "+00:00")
+        )
+    else:
+        raise DeserializationError("WorkflowSummary.created_time required")
+    if data.get("lastUpdatedTime") is not None:
+        import datetime
+
+        out["last_updated_time"] = datetime.datetime.fromisoformat(
+            data["lastUpdatedTime"].replace("Z", "+00:00")
+        )
+    else:
+        raise DeserializationError("WorkflowSummary.last_updated_time required")
+    if data.get("runMode") is not None:
+        out["run_mode"] = data["runMode"]
+    else:
+        raise DeserializationError("WorkflowSummary.run_mode required")
+    if data.get("status") is not None:
+        out["status"] = data["status"]
+    else:
+        raise DeserializationError("WorkflowSummary.status required")
+    return out

capo_codecatalyst-0.1.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: capo-codecatalyst
+Version: 0.1.0
+Summary: Python SDK for Codecatalyst.
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: zapros>=0.13.0
+Dynamic: license-file
+
+# Getting Started
+
+## Installation
+
+```
+pip install capo-codecatalyst
+```
+
+## Usage
+
+```python
+from capo_codecatalyst import AsyncCodeCatalystClient
+
+
+async def main():
+    async with AsyncCodeCatalystClient() as code_catalyst:
+        # Example: call the get_user_details operation
+        response = await code_catalyst.get_user_details()
+        print(response["user_id"])
+```
+
+## Error Handling
+
+The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.
+
+```python
+from capo_codecatalyst import AsyncCodeCatalystClient
+from capo_codecatalyst.error import AccessDeniedException
+
+
+async def main():
+    async with AsyncCodeCatalystClient() as code_catalyst:
+        try:
+            await code_catalyst.get_user_details()
+        except AccessDeniedException as e:
+            print(f"Error: {e}")
+            print(e.data)  # additional error data
+```
+
+## Retrying
+
+The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their `is_retryable` and `is_throttling_error` attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the `@retryable` trait, are raised immediately without further attempts.
+
+The number of attempts defaults to 3 and can be changed at the client level via `retry_max_attempts`, or per call via `config_overrides`.
+
+```python
+from capo_codecatalyst import AsyncCodeCatalystClient
+
+
+async def main():
+    async with AsyncCodeCatalystClient() as code_catalyst:
+        # Default: 3 attempts for every operation
+        response = await code_catalyst.get_user_details()
+
+        # Override per operation
+        response = await code_catalyst.get_user_details(config_overrides={"retry_max_attempts": 5})
+
+        # Disable retries for this call
+        response = await code_catalyst.get_user_details(config_overrides={"retry_max_attempts": 1})
+```