dagster-hightouch 0.1.7__py3-none-any.whl → 0.28.13__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dagster_hightouch/__init__.py +13 -5
- dagster_hightouch/component.py +86 -0
- dagster_hightouch/ops.py +6 -14
- dagster_hightouch/py.typed +0 -0
- dagster_hightouch/resources.py +65 -37
- dagster_hightouch/types.py +2 -2
- dagster_hightouch/utils.py +1 -1
- dagster_hightouch/version.py +1 -0
- dagster_hightouch-0.28.13.dist-info/METADATA +28 -0
- dagster_hightouch-0.28.13.dist-info/RECORD +14 -0
- {dagster_hightouch-0.1.7.dist-info → dagster_hightouch-0.28.13.dist-info}/WHEEL +1 -1
- dagster_hightouch-0.28.13.dist-info/entry_points.txt +2 -0
- dagster_hightouch-0.28.13.dist-info/licenses/LICENSE +201 -0
- dagster_hightouch-0.1.7.dist-info/METADATA +0 -73
- dagster_hightouch-0.1.7.dist-info/RECORD +0 -9
- {dagster_hightouch-0.1.7.dist-info → dagster_hightouch-0.28.13.dist-info}/top_level.txt +0 -0
dagster_hightouch/__init__.py
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
|
-
from
|
|
1
|
+
from dagster_shared.libraries import DagsterLibraryRegistry
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
from dagster_hightouch.component import HightouchSyncComponent
|
|
4
|
+
from dagster_hightouch.ops import hightouch_sync_op
|
|
5
|
+
from dagster_hightouch.resources import ConfigurableHightouchResource, HightouchResource
|
|
6
|
+
from dagster_hightouch.version import __version__ as __version__
|
|
4
7
|
|
|
5
|
-
DagsterLibraryRegistry.register(
|
|
6
|
-
|
|
7
|
-
|
|
8
|
+
DagsterLibraryRegistry.register("dagster-hightouch", __version__, is_dagster_package=True)
|
|
9
|
+
|
|
10
|
+
__all__ = [
|
|
11
|
+
"ConfigurableHightouchResource",
|
|
12
|
+
"HightouchResource",
|
|
13
|
+
"HightouchSyncComponent",
|
|
14
|
+
"hightouch_sync_op",
|
|
15
|
+
]
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import os
|
|
2
|
+
from collections.abc import Mapping
|
|
3
|
+
from typing import Any
|
|
4
|
+
|
|
5
|
+
import dagster as dg
|
|
6
|
+
from dagster.components import Component, ComponentLoadContext, Model, Resolvable, ResolvedAssetSpec
|
|
7
|
+
from pydantic import Field
|
|
8
|
+
|
|
9
|
+
from dagster_hightouch.resources import ConfigurableHightouchResource
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class HightouchSyncComponent(Component, Resolvable, Model):
|
|
13
|
+
"""Represents a Hightouch sync as a Dagster asset.
|
|
14
|
+
|
|
15
|
+
This component allows you to trigger a Hightouch sync and monitor its completion
|
|
16
|
+
as part of your Dagster asset graph. When materialized, it calls the Hightouch API,
|
|
17
|
+
polls for completion, and reports metadata such as rows processed and sync status.
|
|
18
|
+
|
|
19
|
+
Attributes:
|
|
20
|
+
sync_id (str): The ID of the Hightouch sync. Can be a literal string or
|
|
21
|
+
an environment variable (e.g., "$HIGHTOUCH_SYNC_ID").
|
|
22
|
+
asset (ResolvedAssetSpec): The specification of the asset that this
|
|
23
|
+
sync produces.
|
|
24
|
+
|
|
25
|
+
Example:
|
|
26
|
+
.. code-block:: yaml
|
|
27
|
+
|
|
28
|
+
type: HightouchSyncComponent
|
|
29
|
+
attributes:
|
|
30
|
+
sync_id: "12345"
|
|
31
|
+
asset:
|
|
32
|
+
key: ["marketing", "salesforce_sync"]
|
|
33
|
+
"""
|
|
34
|
+
|
|
35
|
+
asset: ResolvedAssetSpec
|
|
36
|
+
sync_id: str = Field(
|
|
37
|
+
description="The ID of the Hightouch sync, or an environment variable starting with $"
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
@classmethod
|
|
41
|
+
def get_additional_scope(cls) -> Mapping[str, Any]:
|
|
42
|
+
return {}
|
|
43
|
+
|
|
44
|
+
def build_defs(self, context: ComponentLoadContext) -> dg.Definitions:
|
|
45
|
+
# Create a unique function name based on the asset key to avoid conflicts when multiple Hightouch components are loaded
|
|
46
|
+
actual_sync_id = self.sync_id
|
|
47
|
+
if actual_sync_id.startswith("$"):
|
|
48
|
+
env_var_name = actual_sync_id[1:]
|
|
49
|
+
actual_sync_id = os.getenv(env_var_name)
|
|
50
|
+
if not actual_sync_id:
|
|
51
|
+
raise ValueError(f"Environment variable '{env_var_name}' not found.")
|
|
52
|
+
asset_key_str = "_".join(self.asset.key.path)
|
|
53
|
+
function_name = f"hightouch_sync_{asset_key_str}"
|
|
54
|
+
|
|
55
|
+
@dg.multi_asset(
|
|
56
|
+
name=function_name,
|
|
57
|
+
specs=[self.asset],
|
|
58
|
+
)
|
|
59
|
+
def _assets(hightouch: ConfigurableHightouchResource):
|
|
60
|
+
result = hightouch.sync_and_poll(actual_sync_id)
|
|
61
|
+
|
|
62
|
+
# Summing all failed rows (adds, changes, removes) for accurate reporting
|
|
63
|
+
failed_rows = result.sync_run_details.get("failedRows", {})
|
|
64
|
+
total_failed = sum(
|
|
65
|
+
failed_rows.get(k, 0) for k in ["addedCount", "changedCount", "removedCount"]
|
|
66
|
+
)
|
|
67
|
+
|
|
68
|
+
yield dg.MaterializeResult(
|
|
69
|
+
asset_key=self.asset.key,
|
|
70
|
+
metadata={
|
|
71
|
+
"sync_details": dg.MetadataValue.json(result.sync_details),
|
|
72
|
+
"sync_run_details": dg.MetadataValue.json(result.sync_run_details),
|
|
73
|
+
"total_failed_rows": total_failed,
|
|
74
|
+
"failed_adds": failed_rows.get("addedCount", 0),
|
|
75
|
+
"failed_changes": failed_rows.get("changedCount", 0),
|
|
76
|
+
"failed_removes": failed_rows.get("removedCount", 0),
|
|
77
|
+
"destination_details": dg.MetadataValue.json(result.destination_details),
|
|
78
|
+
"query_size": result.sync_run_details.get("querySize"),
|
|
79
|
+
"completion_ratio": result.sync_run_details.get("completionRatio"),
|
|
80
|
+
"failed_rows": result.sync_run_details.get("failedRows", {}).get(
|
|
81
|
+
"addedCount", 0
|
|
82
|
+
),
|
|
83
|
+
},
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
return dg.Definitions(assets=[_assets])
|
dagster_hightouch/ops.py
CHANGED
|
@@ -1,10 +1,7 @@
|
|
|
1
1
|
from dagster import AssetMaterialization, Field, In, Noneable, Nothing, Out, Output, op
|
|
2
|
-
from dagster_hightouch.utils import (
|
|
3
|
-
generate_metadata_from_parsed_run,
|
|
4
|
-
parse_sync_run_details,
|
|
5
|
-
)
|
|
6
2
|
|
|
7
|
-
from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
|
|
3
|
+
from dagster_hightouch.resources import DEFAULT_POLL_INTERVAL, HightouchOutput
|
|
4
|
+
from dagster_hightouch.utils import generate_metadata_from_parsed_run, parse_sync_run_details
|
|
8
5
|
|
|
9
6
|
|
|
10
7
|
@op(
|
|
@@ -17,13 +14,12 @@ from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
|
|
|
17
14
|
),
|
|
18
15
|
config_schema={
|
|
19
16
|
"sync_id": Field(
|
|
20
|
-
str, is_required=True, description="The Sync ID that this op will
|
|
17
|
+
str, is_required=True, description="The Sync ID that this op will trigger."
|
|
21
18
|
),
|
|
22
19
|
"poll_interval": Field(
|
|
23
20
|
float,
|
|
24
21
|
default_value=DEFAULT_POLL_INTERVAL,
|
|
25
|
-
description="The time (in seconds) that will be waited between successive "
|
|
26
|
-
"polls.",
|
|
22
|
+
description="The time (in seconds) that will be waited between successive polls.",
|
|
27
23
|
),
|
|
28
24
|
"fail_on_warning": Field(
|
|
29
25
|
bool,
|
|
@@ -40,13 +36,11 @@ from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
|
|
|
40
36
|
tags={"kind": "hightouch"},
|
|
41
37
|
)
|
|
42
38
|
def hightouch_sync_op(context):
|
|
43
|
-
"""
|
|
44
|
-
Executes a Hightouch sync for a given ``sync_id``, and polls until that sync
|
|
39
|
+
"""Executes a Hightouch sync for a given ``sync_id``, and polls until that sync
|
|
45
40
|
completes, raising an error if it is unsuccessful. It outputs a HightouchOutput
|
|
46
41
|
which contains the details of the Hightouch connector after the sync run
|
|
47
42
|
successfully completes.
|
|
48
43
|
"""
|
|
49
|
-
|
|
50
44
|
hightouch_output: HightouchOutput = context.resources.hightouch.sync_and_poll(
|
|
51
45
|
sync_id=context.op_config["sync_id"],
|
|
52
46
|
fail_on_warning=context.op_config["fail_on_warning"],
|
|
@@ -55,9 +49,7 @@ def hightouch_sync_op(context):
|
|
|
55
49
|
)
|
|
56
50
|
destination_type = hightouch_output.destination_details.get("type")
|
|
57
51
|
destination_slug = hightouch_output.destination_details.get("slug")
|
|
58
|
-
sync_object = hightouch_output.sync_details.get("configuration", dict()).get(
|
|
59
|
-
"object"
|
|
60
|
-
)
|
|
52
|
+
sync_object = hightouch_output.sync_details.get("configuration", dict()).get("object")
|
|
61
53
|
if sync_object:
|
|
62
54
|
asset_name = ["hightouch", destination_type, destination_slug, sync_object]
|
|
63
55
|
else:
|
|
File without changes
|
dagster_hightouch/resources.py
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
import datetime
|
|
2
2
|
import logging
|
|
3
3
|
import time
|
|
4
|
-
from typing import Any
|
|
4
|
+
from typing import Any, Optional
|
|
5
5
|
from urllib.parse import urljoin
|
|
6
6
|
|
|
7
7
|
import requests
|
|
8
|
-
|
|
9
|
-
from dagster import Failure, Field, StringSource, get_dagster_logger, resource
|
|
8
|
+
from dagster import ConfigurableResource, Failure, Field, StringSource, get_dagster_logger, resource
|
|
10
9
|
|
|
11
10
|
import dagster_hightouch
|
|
12
|
-
from
|
|
13
|
-
from .types import HightouchOutput
|
|
11
|
+
from dagster_hightouch import utils
|
|
12
|
+
from dagster_hightouch.types import HightouchOutput
|
|
14
13
|
|
|
15
14
|
HIGHTOUCH_API_BASE = "https://api.hightouch.io/api/v1/"
|
|
16
15
|
DEFAULT_POLL_INTERVAL = 3
|
|
@@ -27,8 +26,12 @@ WARNING = "warning"
|
|
|
27
26
|
|
|
28
27
|
|
|
29
28
|
class HightouchResource:
|
|
30
|
-
"""
|
|
31
|
-
|
|
29
|
+
"""Client for the Hightouch REST API.
|
|
30
|
+
|
|
31
|
+
This class provides methods to interface with Hightouch endpoints,
|
|
32
|
+
primarily for triggering syncs and polling for their status.
|
|
33
|
+
|
|
34
|
+
Note: For modern Dagster pipelines, use :class:`ConfigurableHightouchResource`.
|
|
32
35
|
"""
|
|
33
36
|
|
|
34
37
|
def __init__(
|
|
@@ -47,10 +50,8 @@ class HightouchResource:
|
|
|
47
50
|
def api_base_url(self) -> str:
|
|
48
51
|
return HIGHTOUCH_API_BASE
|
|
49
52
|
|
|
50
|
-
def make_request(
|
|
51
|
-
|
|
52
|
-
):
|
|
53
|
-
"""Creates and sends a request to the desired Hightouch API endpoint
|
|
53
|
+
def make_request(self, method: str, endpoint: str, params: dict[str, Any] | None = None):
|
|
54
|
+
"""Creates and sends a request to the desired Hightouch API endpoint.
|
|
54
55
|
|
|
55
56
|
Args:
|
|
56
57
|
method (str): The http method use for this request (e.g. "GET", "POST").
|
|
@@ -60,7 +61,6 @@ class HightouchResource:
|
|
|
60
61
|
Returns:
|
|
61
62
|
Dict[str, Any]: Parsed json data from the response to this request
|
|
62
63
|
"""
|
|
63
|
-
|
|
64
64
|
user_agent = f"HightouchDagsterOp/{dagster_hightouch.__version__}"
|
|
65
65
|
headers = {"Authorization": f"Bearer {self._api_key}", "User-Agent": user_agent}
|
|
66
66
|
|
|
@@ -85,9 +85,7 @@ class HightouchResource:
|
|
|
85
85
|
|
|
86
86
|
raise Failure("Exceeded max number of retries.")
|
|
87
87
|
|
|
88
|
-
def get_sync_run_details(
|
|
89
|
-
self, sync_id: str, sync_request_id: str
|
|
90
|
-
) -> list[dict[str, Any]]:
|
|
88
|
+
def get_sync_run_details(self, sync_id: str, sync_request_id: str) -> list[dict[str, Any]]:
|
|
91
89
|
"""Get details about a given sync run from the Hightouch API.
|
|
92
90
|
|
|
93
91
|
Args:
|
|
@@ -98,9 +96,7 @@ class HightouchResource:
|
|
|
98
96
|
Dict[str, Any]: Parsed json data from the response
|
|
99
97
|
"""
|
|
100
98
|
params = {"runId": sync_request_id}
|
|
101
|
-
return self.make_request(
|
|
102
|
-
method="GET", endpoint=f"syncs/{sync_id}/runs", params=params
|
|
103
|
-
)
|
|
99
|
+
return self.make_request(method="GET", endpoint=f"syncs/{sync_id}/runs", params=params)
|
|
104
100
|
|
|
105
101
|
def get_destination_details(self, destination_id: str) -> dict[str, Any]:
|
|
106
102
|
"""Get details about a destination from the Hightouch API.
|
|
@@ -111,9 +107,7 @@ class HightouchResource:
|
|
|
111
107
|
Returns:
|
|
112
108
|
Dict[str, Any]: Parsed json data from the response
|
|
113
109
|
"""
|
|
114
|
-
return self.make_request(
|
|
115
|
-
method="GET", endpoint=f"destinations/{destination_id}"
|
|
116
|
-
)
|
|
110
|
+
return self.make_request(method="GET", endpoint=f"destinations/{destination_id}")
|
|
117
111
|
|
|
118
112
|
def get_sync_details(self, sync_id: str) -> dict[str, Any]:
|
|
119
113
|
"""Get details about a given sync from the Hightouch API.
|
|
@@ -127,7 +121,7 @@ class HightouchResource:
|
|
|
127
121
|
return self.make_request(method="GET", endpoint=f"syncs/{sync_id}")
|
|
128
122
|
|
|
129
123
|
def start_sync(self, sync_id: str) -> str:
|
|
130
|
-
"""Trigger a sync and initiate a sync run
|
|
124
|
+
"""Trigger a sync and initiate a sync run.
|
|
131
125
|
|
|
132
126
|
Args:
|
|
133
127
|
sync_id (str): The Hightouch Sync ID.
|
|
@@ -135,9 +129,7 @@ class HightouchResource:
|
|
|
135
129
|
Returns:
|
|
136
130
|
str: The sync request ID created by the Hightouch API.
|
|
137
131
|
"""
|
|
138
|
-
return self.make_request(method="POST", endpoint=f"syncs/{sync_id}/trigger")[
|
|
139
|
-
"id"
|
|
140
|
-
]
|
|
132
|
+
return self.make_request(method="POST", endpoint=f"syncs/{sync_id}/trigger")["id"]
|
|
141
133
|
|
|
142
134
|
def poll_sync(
|
|
143
135
|
self,
|
|
@@ -147,7 +139,7 @@ class HightouchResource:
|
|
|
147
139
|
poll_interval: float = DEFAULT_POLL_INTERVAL,
|
|
148
140
|
poll_timeout: float | None = None,
|
|
149
141
|
) -> tuple[dict[str, Any], dict[str, Any], dict[str, Any]]:
|
|
150
|
-
"""Poll for the completion of a sync
|
|
142
|
+
"""Poll for the completion of a sync.
|
|
151
143
|
|
|
152
144
|
Args:
|
|
153
145
|
sync_id (str): The Hightouch Sync ID
|
|
@@ -192,10 +184,8 @@ class HightouchResource:
|
|
|
192
184
|
sync_id,
|
|
193
185
|
sync_request_id,
|
|
194
186
|
)
|
|
195
|
-
if (
|
|
196
|
-
poll_timeout
|
|
197
|
-
and datetime.datetime.now()
|
|
198
|
-
> poll_start + datetime.timedelta(seconds=poll_timeout)
|
|
187
|
+
if poll_timeout and datetime.datetime.now() > poll_start + datetime.timedelta(
|
|
188
|
+
seconds=poll_timeout
|
|
199
189
|
):
|
|
200
190
|
raise Failure(
|
|
201
191
|
f"Sync {sync_id} for request: {sync_request_id}' time out after "
|
|
@@ -204,9 +194,7 @@ class HightouchResource:
|
|
|
204
194
|
|
|
205
195
|
time.sleep(poll_interval)
|
|
206
196
|
sync_details = self.get_sync_details(sync_id)
|
|
207
|
-
destination_details = self.get_destination_details(
|
|
208
|
-
sync_details["destinationId"]
|
|
209
|
-
)
|
|
197
|
+
destination_details = self.get_destination_details(sync_details["destinationId"])
|
|
210
198
|
|
|
211
199
|
return (sync_details, sync_run_details, destination_details)
|
|
212
200
|
|
|
@@ -217,8 +205,7 @@ class HightouchResource:
|
|
|
217
205
|
poll_interval: float = DEFAULT_POLL_INTERVAL,
|
|
218
206
|
poll_timeout: float | None = None,
|
|
219
207
|
) -> HightouchOutput:
|
|
220
|
-
"""
|
|
221
|
-
Initialize a sync run for the given sync id, and polls until it completes
|
|
208
|
+
"""Initialize a sync run for the given sync id, and polls until it completes.
|
|
222
209
|
|
|
223
210
|
Args:
|
|
224
211
|
sync_id (str): The Hightouch Sync ID
|
|
@@ -227,6 +214,7 @@ class HightouchResource:
|
|
|
227
214
|
poll_interval (float): The time in seconds that will be waited between succcessive polls
|
|
228
215
|
poll_timeout (float): The maximum time that will be waited before this operation
|
|
229
216
|
times out.
|
|
217
|
+
|
|
230
218
|
Returns:
|
|
231
219
|
:py:class:`~HightouchOutput`:
|
|
232
220
|
Object containing details about the Hightouch sync run
|
|
@@ -265,8 +253,7 @@ class HightouchResource:
|
|
|
265
253
|
description="This resource helps manage Fivetran connectors",
|
|
266
254
|
)
|
|
267
255
|
def ht_resource(context) -> HightouchResource:
|
|
268
|
-
"""
|
|
269
|
-
This resource allows users to programatically interface with the Hightouch REST API to triggers
|
|
256
|
+
"""This resource allows users to programatically interface with the Hightouch REST API to triggers
|
|
270
257
|
syncs and monitor their progress.
|
|
271
258
|
"""
|
|
272
259
|
return HightouchResource(
|
|
@@ -275,3 +262,44 @@ def ht_resource(context) -> HightouchResource:
|
|
|
275
262
|
request_max_retries=context.resource_config["request_max_retries"],
|
|
276
263
|
request_retry_delay=context.resource_config["request_retry_delay"],
|
|
277
264
|
)
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
class ConfigurableHightouchResource(ConfigurableResource):
|
|
268
|
+
"""A resource for connecting to the Hightouch API using pythonic configuration.
|
|
269
|
+
|
|
270
|
+
This resource is the recommended way to manage Hightouch connections in
|
|
271
|
+
modern Dagster (1.0+).
|
|
272
|
+
|
|
273
|
+
Attributes:
|
|
274
|
+
api_key (str): Your Hightouch API key.
|
|
275
|
+
request_max_retries (int): Maximum number of retries for API requests. Defaults to 3.
|
|
276
|
+
request_retry_delay (float): Delay between retries in seconds. Defaults to 0.25.
|
|
277
|
+
"""
|
|
278
|
+
|
|
279
|
+
api_key: str
|
|
280
|
+
request_max_retries: int = 3
|
|
281
|
+
request_retry_delay: float = 0.25
|
|
282
|
+
fail_on_warning: bool = False
|
|
283
|
+
poll_interval: float = DEFAULT_POLL_INTERVAL
|
|
284
|
+
poll_timeout: Optional[float] = None
|
|
285
|
+
|
|
286
|
+
def sync_and_poll(
|
|
287
|
+
self,
|
|
288
|
+
sync_id: str,
|
|
289
|
+
fail_on_warning: Optional[bool] = None,
|
|
290
|
+
poll_interval: Optional[float] = None,
|
|
291
|
+
poll_timeout: Optional[float] = None,
|
|
292
|
+
) -> HightouchOutput:
|
|
293
|
+
inner_resource = HightouchResource(
|
|
294
|
+
api_key=self.api_key,
|
|
295
|
+
request_max_retries=self.request_max_retries,
|
|
296
|
+
request_retry_delay=self.request_retry_delay,
|
|
297
|
+
)
|
|
298
|
+
return inner_resource.sync_and_poll(
|
|
299
|
+
sync_id=sync_id,
|
|
300
|
+
fail_on_warning=fail_on_warning
|
|
301
|
+
if fail_on_warning is not None
|
|
302
|
+
else self.fail_on_warning,
|
|
303
|
+
poll_interval=poll_interval if poll_interval is not None else self.poll_interval,
|
|
304
|
+
poll_timeout=poll_timeout if poll_timeout is not None else self.poll_timeout,
|
|
305
|
+
)
|
dagster_hightouch/types.py
CHANGED
|
@@ -12,8 +12,8 @@ class HightouchOutput(
|
|
|
12
12
|
],
|
|
13
13
|
)
|
|
14
14
|
):
|
|
15
|
-
"""
|
|
16
|
-
|
|
15
|
+
"""Contains recorded information about the state of a Hightouch sync after a sync completes.
|
|
16
|
+
|
|
17
17
|
Attributes:
|
|
18
18
|
sync_details (Dict[str, Any]):
|
|
19
19
|
https://hightouch.io/docs/api-reference/#operation/GetSync
|
dagster_hightouch/utils.py
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.28.13"
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dagster-hightouch
|
|
3
|
+
Version: 0.28.13
|
|
4
|
+
Summary: Package for integrating Hightouch with Dagster.
|
|
5
|
+
Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-hightouch
|
|
6
|
+
Author: Dagster Labs
|
|
7
|
+
Author-email: hello@dagsterlabs.com
|
|
8
|
+
License: Apache-2.0
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
13
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Requires-Python: >=3.10,<3.14
|
|
16
|
+
License-File: LICENSE
|
|
17
|
+
Requires-Dist: dagster==1.12.13
|
|
18
|
+
Requires-Dist: requests
|
|
19
|
+
Requires-Dist: python-dateutil
|
|
20
|
+
Dynamic: author
|
|
21
|
+
Dynamic: author-email
|
|
22
|
+
Dynamic: classifier
|
|
23
|
+
Dynamic: home-page
|
|
24
|
+
Dynamic: license
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
Dynamic: requires-dist
|
|
27
|
+
Dynamic: requires-python
|
|
28
|
+
Dynamic: summary
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
dagster_hightouch/__init__.py,sha256=vJ3L8sXCPCudvnStDwc2LI7_QK41d-o3om9tMlKkvd4,554
|
|
2
|
+
dagster_hightouch/component.py,sha256=5kU-doyYyWEIyxO2U1R7LBjZB3ADCH1c5In50Ur0Myc,3585
|
|
3
|
+
dagster_hightouch/ops.py,sha256=W53cPL2K2v8oh4ZJKB0dpEMaeu1OM14LvhVlgfJi1iE,2921
|
|
4
|
+
dagster_hightouch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
dagster_hightouch/resources.py,sha256=1UrRGwV9HWji1WIN5qn-Tuxag5YGNSSIR0iNtzac5JQ,11524
|
|
6
|
+
dagster_hightouch/types.py,sha256=_w7HgO66oyCWCFJmNIZBipJJTGaNvvtp6Nm4NQ08VP8,1282
|
|
7
|
+
dagster_hightouch/utils.py,sha256=1zik0n8ko2p4pUddd3t1gE01za9FHBUcxIXej8eykLU,2883
|
|
8
|
+
dagster_hightouch/version.py,sha256=V__meM42MWuoz8aUqc0jpG42uTRWaiUA_MsUAt6BdlY,24
|
|
9
|
+
dagster_hightouch-0.28.13.dist-info/licenses/LICENSE,sha256=4lsMW-RCvfVD4_F57wrmpe3vX1xwUk_OAKKmV_XT7Z0,11348
|
|
10
|
+
dagster_hightouch-0.28.13.dist-info/METADATA,sha256=bdnfSgaqLZ8dh27KgBm3AD___qubpFk1Bwic7q4yLTg,935
|
|
11
|
+
dagster_hightouch-0.28.13.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
|
|
12
|
+
dagster_hightouch-0.28.13.dist-info/entry_points.txt,sha256=8_wDE9eM6V0IqKFnIn-eqvdALvvMCajY5TdEKyVmDwY,72
|
|
13
|
+
dagster_hightouch-0.28.13.dist-info/top_level.txt,sha256=oMoqAW8f7myyEz6FG5zNzVQr3RzPdYm67ekvSD96N54,18
|
|
14
|
+
dagster_hightouch-0.28.13.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Dagster Labs, Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: dagster-hightouch
|
|
3
|
-
Version: 0.1.7
|
|
4
|
-
Summary: Dagster library for Hightouch
|
|
5
|
-
Requires-Python: >=3.10
|
|
6
|
-
Description-Content-Type: text/markdown
|
|
7
|
-
Requires-Dist: dagster>=0.14
|
|
8
|
-
Requires-Dist: requests>=2.0
|
|
9
|
-
|
|
10
|
-
## dagster-hightouch
|
|
11
|
-
|
|
12
|
-
A Dagster library for triggering syncs in Hightouch.
|
|
13
|
-
|
|
14
|
-
### Installation
|
|
15
|
-
|
|
16
|
-
To install the library, use pip alongside your existing Dagster environment.
|
|
17
|
-
|
|
18
|
-
```bash
|
|
19
|
-
pip install dagster-hightouch
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### Configuration
|
|
23
|
-
|
|
24
|
-
First, you'll need to specify your [Hightouch API](https://hightouch.com/docs/developer-tools/api-guide/) key as a resource.
|
|
25
|
-
|
|
26
|
-
```python
|
|
27
|
-
# resources.py
|
|
28
|
-
from dagster_hightouch.resources import ht_resource as hightouch_resource
|
|
29
|
-
|
|
30
|
-
ht_resource = hightouch_resource.configured(
|
|
31
|
-
{"api_key": "555555-4444-3333-2222-1111111111"},
|
|
32
|
-
)
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### Ops
|
|
36
|
-
|
|
37
|
-
The `hightouch_sync_op` will call the Hightouch API to trigger
|
|
38
|
-
a sync and monitor it until it completes.
|
|
39
|
-
|
|
40
|
-
```python
|
|
41
|
-
from dagster import ScheduleDefinition, get_dagster_logger, job
|
|
42
|
-
from dagster_hightouch.ops import hightouch_sync_op
|
|
43
|
-
from .resources import ht_resource
|
|
44
|
-
|
|
45
|
-
# Sync IDs are set as constants. You can also use
|
|
46
|
-
# the sync slug, read the documentation for other
|
|
47
|
-
# options.
|
|
48
|
-
|
|
49
|
-
HT_WS = "23620"
|
|
50
|
-
HT_ORG = "39619"
|
|
51
|
-
|
|
52
|
-
# We define two configured sync ops
|
|
53
|
-
run_ht_sync_workspaces = hightouch_sync_op.configured(
|
|
54
|
-
{"sync_id": HT_WS}, name="hightouch_sfdc_workspaces"
|
|
55
|
-
)
|
|
56
|
-
run_ht_sync_orgs = hightouch_sync_op.configured(
|
|
57
|
-
{"sync_id": HT_ORG}, name="hightouch_sfdc_organizations"
|
|
58
|
-
)
|
|
59
|
-
|
|
60
|
-
# And create a job with the defined resources, specifying the dependencies.
|
|
61
|
-
@job(
|
|
62
|
-
resource_defs={
|
|
63
|
-
"hightouch": ht_resource,
|
|
64
|
-
}
|
|
65
|
-
)
|
|
66
|
-
def ht_sfdc_job():
|
|
67
|
-
|
|
68
|
-
ht_orgs = run_ht_sync_orgs(start_after=ht_contacts)
|
|
69
|
-
run_ht_sync_workspaces(start_after=ht_orgs)
|
|
70
|
-
|
|
71
|
-
# And we schedule it to run every 30 mins.
|
|
72
|
-
every_30_schedule = ScheduleDefinition(job=ht_sfdc_job, cron_schedule="*/30 * * * *")
|
|
73
|
-
```
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
dagster_hightouch/__init__.py,sha256=j6plWaGtVFecF4O7wHji63WP13pQzWHvtmTmqPzDtdw,181
|
|
2
|
-
dagster_hightouch/ops.py,sha256=8_NMNKlj1VzFLoiBA__tn7y9qghtijhuLuKdtKkA4Ak,2951
|
|
3
|
-
dagster_hightouch/resources.py,sha256=HodHBIzIlOKF51EYCvomkiXHFfyjFFYdtwZE2Vw1VKw,9887
|
|
4
|
-
dagster_hightouch/types.py,sha256=nI7BTLpXCvYM3HUQLK3nxa1FKnl-G0_bJIHp2BYialc,1286
|
|
5
|
-
dagster_hightouch/utils.py,sha256=-mSN0aglUIwsxBiBRgj0cHi5B5SVXWk3K-rezMyPKaM,2866
|
|
6
|
-
dagster_hightouch-0.1.7.dist-info/METADATA,sha256=qQvA_h8BflOIGtLXk3fZVkVgGNqKJCxtufuvecC58mA,1876
|
|
7
|
-
dagster_hightouch-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
8
|
-
dagster_hightouch-0.1.7.dist-info/top_level.txt,sha256=oMoqAW8f7myyEz6FG5zNzVQr3RzPdYm67ekvSD96N54,18
|
|
9
|
-
dagster_hightouch-0.1.7.dist-info/RECORD,,
|
|
File without changes
|