hatchet-sdk 0.44.0__tar.gz → 1.22.2__tar.gz

hatchet_sdk-1.22.2/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: hatchet-sdk
+Version: 1.22.2
+Summary: This is the official Python SDK for Hatchet, a distributed, fault-tolerant task queue. The SDK allows you to easily integrate Hatchet's task scheduling and workflow orchestration capabilities into your Python applications.
+License: MIT
+Author: Alexander Belanger
+Author-email: alexander@hatchet.run
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: otel
+Provides-Extra: v0-sdk
+Requires-Dist: aiohttp (>=3.10.5,<4.0.0)
+Requires-Dist: grpcio (>=1.76.0,<2.0.0)
+Requires-Dist: grpcio-tools (>=1.76.0,<2.0.0)
+Requires-Dist: opentelemetry-api (>=1.28.0,<2.0.0) ; extra == "otel"
+Requires-Dist: opentelemetry-distro (>=0.49b0) ; extra == "otel"
+Requires-Dist: opentelemetry-exporter-otlp (>=1.28.0,<2.0.0) ; extra == "otel"
+Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.28.0,<2.0.0) ; extra == "otel"
+Requires-Dist: opentelemetry-instrumentation (>=0.49b0) ; extra == "otel"
+Requires-Dist: opentelemetry-sdk (>=1.28.0,<2.0.0) ; extra == "otel"
+Requires-Dist: prometheus-client (>=0.21.1)
+Requires-Dist: protobuf (>=6.30.0,<7.0.0)
+Requires-Dist: pydantic (>=2.6.3,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.7.1,<3.0.0)
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: tenacity (>=8.4.1)
+Requires-Dist: urllib3 (>=2.6.0,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Hatchet Python SDK
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/hatchet-sdk.svg)](https://badge.fury.io/py/hatchet-sdk)
+[![Documentation](https://img.shields.io/badge/docs-hatchet.run-blue)](https://docs.hatchet.run)
+[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](https://opensource.org/licenses/MIT)
+
+</div>
+
+This is the official Python SDK for [Hatchet](https://hatchet.run), a distributed, fault-tolerant task queue. The SDK allows you to easily integrate Hatchet's task scheduling and workflow orchestration capabilities into your Python applications.
+
+## Installation
+
+Install the SDK using pip:
+
+```bash
+pip install hatchet-sdk
+```
+
+Or using poetry:
+
+```bash
+poetry add hatchet-sdk
+```
+
+## Quick Start
+
+For examples of how to use the Hatchet Python SDK, including worker setup and task execution, please see our [official documentation](https://docs.hatchet.run/home/setup).
+
+## Features
+
+- 🔄 **Workflow Orchestration**: Define complex workflows with dependencies and parallel execution
+- 🔁 **Automatic Retries**: Configure retry policies for handling transient failures
+- 📊 **Observability**: Track workflow progress and monitor execution metrics
+- ⏰ **Scheduling**: Schedule workflows to run at specific times or on a recurring basis
+- 🔄 **Event-Driven**: Trigger workflows based on events in your system
+
+## Documentation
+
+For detailed documentation, examples, and best practices, visit:
+- [Hatchet Documentation](https://docs.hatchet.run)
+- [Examples](https://github.com/hatchet-dev/hatchet/tree/main/sdks/python/examples)
+
+## Contributing
+
+We welcome contributions! Please check out our [contributing guidelines](https://docs.hatchet.run/contributing) and join our [Discord community](https://hatchet.run/discord) for discussions and support.
+
+## License
+
+This SDK is released under the MIT License. See [LICENSE](https://github.com/hatchet-dev/hatchet/blob/main/LICENSE) for details.
+

hatchet_sdk-1.22.2/README.md

@@ -0,0 +1,51 @@
+# Hatchet Python SDK
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/hatchet-sdk.svg)](https://badge.fury.io/py/hatchet-sdk)
+[![Documentation](https://img.shields.io/badge/docs-hatchet.run-blue)](https://docs.hatchet.run)
+[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](https://opensource.org/licenses/MIT)
+
+</div>
+
+This is the official Python SDK for [Hatchet](https://hatchet.run), a distributed, fault-tolerant task queue. The SDK allows you to easily integrate Hatchet's task scheduling and workflow orchestration capabilities into your Python applications.
+
+## Installation
+
+Install the SDK using pip:
+
+```bash
+pip install hatchet-sdk
+```
+
+Or using poetry:
+
+```bash
+poetry add hatchet-sdk
+```
+
+## Quick Start
+
+For examples of how to use the Hatchet Python SDK, including worker setup and task execution, please see our [official documentation](https://docs.hatchet.run/home/setup).
+
+## Features
+
+- 🔄 **Workflow Orchestration**: Define complex workflows with dependencies and parallel execution
+- 🔁 **Automatic Retries**: Configure retry policies for handling transient failures
+- 📊 **Observability**: Track workflow progress and monitor execution metrics
+- ⏰ **Scheduling**: Schedule workflows to run at specific times or on a recurring basis
+- 🔄 **Event-Driven**: Trigger workflows based on events in your system
+
+## Documentation
+
+For detailed documentation, examples, and best practices, visit:
+- [Hatchet Documentation](https://docs.hatchet.run)
+- [Examples](https://github.com/hatchet-dev/hatchet/tree/main/sdks/python/examples)
+
+## Contributing
+
+We welcome contributions! Please check out our [contributing guidelines](https://docs.hatchet.run/contributing) and join our [Discord community](https://hatchet.run/discord) for discussions and support.
+
+## License
+
+This SDK is released under the MIT License. See [LICENSE](https://github.com/hatchet-dev/hatchet/blob/main/LICENSE) for details.

{hatchet_sdk-0.44.0 → hatchet_sdk-1.22.2}/hatchet_sdk/__init__.py

@@ -1,6 +1,19 @@
-from hatchet_sdk.clients.rest.models.accept_invite_request import AcceptInviteRequest
+from hatchet_sdk.clients.admin import (
+    ScheduleTriggerWorkflowOptions,
+    TriggerWorkflowOptions,
+)
+from hatchet_sdk.clients.events import PushEventOptions
+from hatchet_sdk.clients.listeners.durable_event_listener import (
+    RegisterDurableEventRequest,
+)
+from hatchet_sdk.clients.listeners.run_event_listener import (
+    RunEventListener,
+    StepRunEventType,
+    WorkflowRunEventType,
+)
 
 # import models into sdk package
+from hatchet_sdk.clients.rest.models.accept_invite_request import AcceptInviteRequest
 from hatchet_sdk.clients.rest.models.api_error import APIError
 from hatchet_sdk.clients.rest.models.api_errors import APIErrors
 from hatchet_sdk.clients.rest.models.api_meta import APIMeta
@@ -68,7 +81,6 @@ from hatchet_sdk.clients.rest.models.pull_request_state import PullRequestState
 from hatchet_sdk.clients.rest.models.reject_invite_request import RejectInviteRequest
 from hatchet_sdk.clients.rest.models.replay_event_request import ReplayEventRequest
 from hatchet_sdk.clients.rest.models.rerun_step_run_request import RerunStepRunRequest
-from hatchet_sdk.clients.rest.models.step import Step
 from hatchet_sdk.clients.rest.models.step_run import StepRun
 from hatchet_sdk.clients.rest.models.step_run_diff import StepRunDiff
 from hatchet_sdk.clients.rest.models.step_run_status import StepRunStatus
@@ -92,6 +104,7 @@ from hatchet_sdk.clients.rest.models.user_tenant_memberships_list import (
     UserTenantMembershipsList,
 )
 from hatchet_sdk.clients.rest.models.user_tenant_public import UserTenantPublic
+from hatchet_sdk.clients.rest.models.v1_task_status import V1TaskStatus
 from hatchet_sdk.clients.rest.models.worker_list import WorkerList
 from hatchet_sdk.clients.rest.models.workflow import Workflow
 from hatchet_sdk.clients.rest.models.workflow_deployment_config import (
@@ -117,32 +130,48 @@ from hatchet_sdk.clients.rest.models.workflow_version_definition import (
     WorkflowVersionDefinition,
 )
 from hatchet_sdk.clients.rest.models.workflow_version_meta import WorkflowVersionMeta
+from hatchet_sdk.conditions import (
+    Condition,
+    OrGroup,
+    ParentCondition,
+    SleepCondition,
+    UserEventCondition,
+    or_,
+)
+from hatchet_sdk.config import ClientConfig, ClientTLSConfig, OpenTelemetryConfig
+from hatchet_sdk.context.context import Context, DurableContext
+from hatchet_sdk.context.worker_context import WorkerContext
 from hatchet_sdk.contracts.workflows_pb2 import (
-    ConcurrencyLimitStrategy,
     CreateWorkflowVersionOpts,
     RateLimitDuration,
-    StickyStrategy,
     WorkerLabelComparator,
 )
-from hatchet_sdk.utils.aio_utils import sync_to_async
-
-from .client import new_client
-from .clients.admin import (
-    ChildTriggerWorkflowOptions,
-    DedupeViolationErr,
-    ScheduleTriggerWorkflowOptions,
-    TriggerWorkflowOptions,
+from hatchet_sdk.exceptions import (
+    DedupeViolationError,
+    FailedTaskRunExceptionGroup,
+    NonRetryableException,
+    TaskRunError,
 )
-from .clients.events import PushEventOptions
-from .clients.run_event_listener import StepRunEventType, WorkflowRunEventType
-from .context.context import Context
-from .context.worker_context import WorkerContext
-from .hatchet import ClientConfig, Hatchet, concurrency, on_failure_step, step, workflow
-from .worker import Worker, WorkerStartOptions, WorkerStatus
-from .workflow import ConcurrencyExpression
+from hatchet_sdk.features.cel import CELEvaluationResult, CELFailure, CELSuccess
+from hatchet_sdk.features.runs import BulkCancelReplayOpts, RunFilter
+from hatchet_sdk.hatchet import Hatchet
+from hatchet_sdk.runnables.task import Depends, Task
+from hatchet_sdk.runnables.types import (
+    ConcurrencyExpression,
+    ConcurrencyLimitStrategy,
+    DefaultFilter,
+    EmptyModel,
+    StickyStrategy,
+    TaskDefaults,
+    WorkflowConfig,
+)
+from hatchet_sdk.runnables.workflow import TaskRunRef
+from hatchet_sdk.utils.opentelemetry import OTelAttribute
+from hatchet_sdk.utils.serde import remove_null_unicode_character
+from hatchet_sdk.worker.worker import Worker, WorkerStartOptions, WorkerStatus
+from hatchet_sdk.workflow_run import WorkflowRunRef
 
 __all__ = [
-    "AcceptInviteRequest",
     "APIError",
     "APIErrors",
     "APIMeta",
@@ -150,11 +179,28 @@ __all__ = [
     "APIMetaIntegration",
     "APIResourceMeta",
     "APIToken",
+    "AcceptInviteRequest",
+    "BulkCancelReplayOpts",
+    "CELEvaluationResult",
+    "CELFailure",
+    "CELSuccess",
+    "ClientConfig",
+    "ClientTLSConfig",
+    "ConcurrencyExpression",
+    "ConcurrencyLimitStrategy",
+    "Condition",
+    "Context",
     "CreateAPITokenRequest",
     "CreateAPITokenResponse",
     "CreatePullRequestFromStepRun",
     "CreateTenantInviteRequest",
     "CreateTenantRequest",
+    "CreateWorkflowVersionOpts",
+    "DedupeViolationError",
+    "DefaultFilter",
+    "Depends",
+    "DurableContext",
+    "EmptyModel",
     "Event",
     "EventData",
     "EventKeyList",
@@ -162,10 +208,12 @@ __all__ = [
     "EventOrderByDirection",
     "EventOrderByField",
     "EventWorkflowRunSummary",
+    "FailedTaskRunExceptionGroup",
     "GetStepRunDiffResponse",
     "GithubAppInstallation",
     "GithubBranch",
     "GithubRepo",
+    "Hatchet",
     "Job",
     "JobRun",
     "JobRunStatus",
@@ -178,17 +226,33 @@ __all__ = [
     "LogLineList",
     "LogLineOrderByDirection",
     "LogLineOrderByField",
+    "NonRetryableException",
+    "OTelAttribute",
+    "OpenTelemetryConfig",
+    "OrGroup",
     "PaginationResponse",
+    "ParentCondition",
     "PullRequest",
     "PullRequestState",
+    "PushEventOptions",
+    "RateLimitDuration",
+    "RegisterDurableEventRequest",
     "RejectInviteRequest",
     "ReplayEventRequest",
     "RerunStepRunRequest",
-    "Step",
+    "RunEventListener",
+    "RunFilter",
+    "ScheduleTriggerWorkflowOptions",
+    "SleepCondition",
     "StepRun",
     "StepRunDiff",
+    "StepRunEventType",
     "StepRunStatus",
-    "sync_to_async",
+    "StickyStrategy",
+    "Task",
+    "TaskDefaults",
+    "TaskRunError",
+    "TaskRunRef",
     "Tenant",
     "TenantInvite",
     "TenantInviteList",
@@ -196,21 +260,32 @@ __all__ = [
     "TenantMember",
     "TenantMemberList",
     "TenantMemberRole",
+    "TriggerWorkflowOptions",
     "TriggerWorkflowRunRequest",
     "UpdateTenantInviteRequest",
     "User",
+    "UserEventCondition",
     "UserLoginRequest",
     "UserRegisterRequest",
     "UserTenantMembershipsList",
     "UserTenantPublic",
+    "V1TaskStatus",
+    "Worker",
     "Worker",
+    "WorkerContext",
     "WorkerLabelComparator",
     "WorkerList",
+    "WorkerStartOptions",
+    "WorkerStatus",
     "Workflow",
+    "Workflow",
+    "WorkflowConfig",
     "WorkflowDeploymentConfig",
     "WorkflowList",
     "WorkflowRun",
+    "WorkflowRunEventType",
     "WorkflowRunList",
+    "WorkflowRunRef",
     "WorkflowRunStatus",
     "WorkflowRunTriggeredBy",
     "WorkflowTag",
@@ -220,28 +295,7 @@ __all__ = [
     "WorkflowVersion",
     "WorkflowVersionDefinition",
     "WorkflowVersionMeta",
-    "ConcurrencyLimitStrategy",
-    "CreateWorkflowVersionOpts",
-    "RateLimitDuration",
-    "StickyStrategy",
-    "new_client",
-    "ChildTriggerWorkflowOptions",
-    "DedupeViolationErr",
-    "ScheduleTriggerWorkflowOptions",
-    "TriggerWorkflowOptions",
-    "PushEventOptions",
-    "StepRunEventType",
-    "WorkflowRunEventType",
-    "Context",
-    "WorkerContext",
-    "ClientConfig",
-    "Hatchet",
-    "concurrency",
-    "on_failure_step",
-    "step",
+    "or_",
+    "remove_null_unicode_character",
     "workflow",
-    "Worker",
-    "WorkerStartOptions",
-    "WorkerStatus",
-    "ConcurrencyExpression",
 ]

hatchet_sdk-1.22.2/hatchet_sdk/client.py

@@ -0,0 +1,57 @@
+from hatchet_sdk.clients.admin import AdminClient
+from hatchet_sdk.clients.dispatcher.dispatcher import DispatcherClient
+from hatchet_sdk.clients.events import EventClient
+from hatchet_sdk.clients.listeners.run_event_listener import RunEventListenerClient
+from hatchet_sdk.clients.listeners.workflow_listener import PooledWorkflowRunListener
+from hatchet_sdk.config import ClientConfig
+from hatchet_sdk.features.cel import CELClient
+from hatchet_sdk.features.cron import CronClient
+from hatchet_sdk.features.filters import FiltersClient
+from hatchet_sdk.features.logs import LogsClient
+from hatchet_sdk.features.metrics import MetricsClient
+from hatchet_sdk.features.rate_limits import RateLimitsClient
+from hatchet_sdk.features.runs import RunsClient
+from hatchet_sdk.features.scheduled import ScheduledClient
+from hatchet_sdk.features.tenant import TenantClient
+from hatchet_sdk.features.workers import WorkersClient
+from hatchet_sdk.features.workflows import WorkflowsClient
+
+
+class Client:
+    def __init__(
+        self,
+        config: ClientConfig,
+        event_client: EventClient | None = None,
+        admin_client: AdminClient | None = None,
+        dispatcher_client: DispatcherClient | None = None,
+        workflow_listener: PooledWorkflowRunListener | None = None,
+        debug: bool = False,
+    ):
+        self.config = config
+        self.dispatcher = dispatcher_client or DispatcherClient(config)
+        self.event = event_client or EventClient(config)
+        self.listener = RunEventListenerClient(config)
+        self.workflow_listener = workflow_listener or PooledWorkflowRunListener(config)
+
+        self.log_interceptor = config.logger
+        self.debug = debug
+
+        self.cel = CELClient(self.config)
+        self.cron = CronClient(self.config)
+        self.filters = FiltersClient(self.config)
+        self.logs = LogsClient(self.config)
+        self.metrics = MetricsClient(self.config)
+        self.rate_limits = RateLimitsClient(self.config)
+        self.runs = RunsClient(
+            config=self.config,
+            workflow_run_event_listener=self.listener,
+            workflow_run_listener=self.workflow_listener,
+        )
+        self.scheduled = ScheduledClient(self.config)
+        self.tenant = TenantClient(self.config)
+        self.workers = WorkersClient(self.config)
+        self.workflows = WorkflowsClient(self.config)
+
+        self.admin = admin_client or AdminClient(
+            config, self.workflow_listener, self.listener, self.runs
+        )