dagster-hightouch 0.1.6__tar.gz → 0.1.8__tar.gz

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.
Files changed (25) hide show
  1. dagster_hightouch-0.1.8/LICENSE +201 -0
  2. dagster_hightouch-0.1.8/MANIFEST.in +5 -0
  3. {dagster_hightouch-0.1.6/dagster_hightouch.egg-info → dagster_hightouch-0.1.8}/PKG-INFO +27 -3
  4. dagster_hightouch-0.1.6/PKG-INFO → dagster_hightouch-0.1.8/README.md +13 -9
  5. dagster_hightouch-0.1.8/dagster_hightouch/__init__.py +17 -0
  6. dagster_hightouch-0.1.8/dagster_hightouch/component.py +96 -0
  7. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/dagster_hightouch/ops.py +1 -1
  8. dagster_hightouch-0.1.8/dagster_hightouch/py.typed +0 -0
  9. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/dagster_hightouch/resources.py +68 -10
  10. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/dagster_hightouch/types.py +4 -4
  11. dagster_hightouch-0.1.8/dagster_hightouch/utils.py +73 -0
  12. dagster_hightouch-0.1.8/dagster_hightouch/version.py +1 -0
  13. dagster_hightouch-0.1.6/README.md → dagster_hightouch-0.1.8/dagster_hightouch.egg-info/PKG-INFO +33 -0
  14. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/dagster_hightouch.egg-info/SOURCES.txt +8 -0
  15. dagster_hightouch-0.1.8/dagster_hightouch.egg-info/entry_points.txt +5 -0
  16. dagster_hightouch-0.1.8/dagster_hightouch.egg-info/not-zip-safe +1 -0
  17. dagster_hightouch-0.1.8/dagster_hightouch.egg-info/requires.txt +3 -0
  18. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/pyproject.toml +15 -3
  19. dagster_hightouch-0.1.8/setup.py +48 -0
  20. dagster_hightouch-0.1.6/dagster_hightouch/__init__.py +0 -5
  21. dagster_hightouch-0.1.6/dagster_hightouch/utils.py +0 -59
  22. dagster_hightouch-0.1.6/dagster_hightouch.egg-info/requires.txt +0 -2
  23. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/dagster_hightouch.egg-info/dependency_links.txt +0 -0
  24. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/dagster_hightouch.egg-info/top_level.txt +0 -0
  25. {dagster_hightouch-0.1.6 → dagster_hightouch-0.1.8}/setup.cfg +0 -0
@@ -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.
@@ -0,0 +1,5 @@
1
+ include README.md
2
+ include LICENSE
3
+ include dagster_hightouch/py.typed
4
+ exclude Makefile
5
+ prune dagster_hightouch_tests
@@ -1,11 +1,22 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: dagster-hightouch
3
- Version: 0.1.6
3
+ Version: 0.1.8
4
4
  Summary: Dagster library for Hightouch
5
- Requires-Python: >=3.8
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
+ Requires-Python: >=3.10,<3.14
6
10
  Description-Content-Type: text/markdown
7
- Requires-Dist: dagster>=0.14
11
+ License-File: LICENSE
12
+ Requires-Dist: dagster>=1.8.0
8
13
  Requires-Dist: requests>=2.0
14
+ Requires-Dist: python-dateutil>=2.8.0
15
+ Dynamic: author
16
+ Dynamic: author-email
17
+ Dynamic: home-page
18
+ Dynamic: license-file
19
+ Dynamic: requires-python
9
20
 
10
21
  ## dagster-hightouch
11
22
 
@@ -71,3 +82,16 @@ def ht_sfdc_job():
71
82
  # And we schedule it to run every 30 mins.
72
83
  every_30_schedule = ScheduleDefinition(job=ht_sfdc_job, cron_schedule="*/30 * * * *")
73
84
  ```
85
+
86
+ ### Components (Modern)
87
+
88
+ You can now use Hightouch as a Dagster Component. This allows you to define syncs in YAML.
89
+
90
+ ```yaml
91
+ # code/component.yaml
92
+ type: HightouchSyncComponent
93
+ attributes:
94
+ sync_id: "12345"
95
+ asset:
96
+ key: ["hightouch", "my_sync_asset"]
97
+ ```
@@ -1,12 +1,3 @@
1
- Metadata-Version: 2.4
2
- Name: dagster-hightouch
3
- Version: 0.1.6
4
- Summary: Dagster library for Hightouch
5
- Requires-Python: >=3.8
6
- Description-Content-Type: text/markdown
7
- Requires-Dist: dagster>=0.14
8
- Requires-Dist: requests>=2.0
9
-
10
1
  ## dagster-hightouch
11
2
 
12
3
  A Dagster library for triggering syncs in Hightouch.
@@ -71,3 +62,16 @@ def ht_sfdc_job():
71
62
  # And we schedule it to run every 30 mins.
72
63
  every_30_schedule = ScheduleDefinition(job=ht_sfdc_job, cron_schedule="*/30 * * * *")
73
64
  ```
65
+
66
+ ### Components (Modern)
67
+
68
+ You can now use Hightouch as a Dagster Component. This allows you to define syncs in YAML.
69
+
70
+ ```yaml
71
+ # code/component.yaml
72
+ type: HightouchSyncComponent
73
+ attributes:
74
+ sync_id: "12345"
75
+ asset:
76
+ key: ["hightouch", "my_sync_asset"]
77
+ ```
@@ -0,0 +1,17 @@
1
+ from dagster._core.libraries import DagsterLibraryRegistry
2
+ from .resources import ConfigurableHightouchResource, HightouchResource
3
+ from .ops import hightouch_sync_op
4
+ from .component import HightouchSyncComponent
5
+
6
+ __version__ = "0.1.8"
7
+
8
+ DagsterLibraryRegistry.register(
9
+ "dagster-hightouch", __version__, is_dagster_package=True
10
+ )
11
+
12
+ __all__ = [
13
+ "ConfigurableHightouchResource",
14
+ "HightouchResource",
15
+ "hightouch_sync_op",
16
+ "HightouchSyncComponent",
17
+ ]
@@ -0,0 +1,96 @@
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 (
7
+ Component,
8
+ Model,
9
+ Resolvable,
10
+ ResolvedAssetSpec,
11
+ ComponentLoadContext,
12
+ )
13
+ from pydantic import Field
14
+
15
+ from .resources import ConfigurableHightouchResource
16
+
17
+
18
+ class HightouchSyncComponent(Component, Resolvable, Model):
19
+ """
20
+ Represents a Hightouch sync as a Dagster asset.
21
+
22
+ This component allows you to trigger a Hightouch sync and monitor its completion
23
+ as part of your Dagster asset graph. When materialized, it calls the Hightouch API,
24
+ polls for completion, and reports metadata such as rows processed and sync status.
25
+
26
+ Attributes:
27
+ sync_id (str): The ID of the Hightouch sync. Can be a literal string or
28
+ an environment variable (e.g., "$HIGHTOUCH_SYNC_ID").
29
+ asset (ResolvedAssetSpec): The specification of the asset that this
30
+ sync produces.
31
+
32
+ Example:
33
+ .. code-block:: yaml
34
+
35
+ type: HightouchSyncComponent
36
+ attributes:
37
+ sync_id: "12345"
38
+ asset:
39
+ key: ["marketing", "salesforce_sync"]
40
+ """
41
+
42
+ asset: ResolvedAssetSpec
43
+ sync_id: str = Field(
44
+ description="The ID of the Hightouch sync, or an environment variable starting with $"
45
+ )
46
+
47
+ @classmethod
48
+ def get_additional_scope(cls) -> Mapping[str, Any]:
49
+ return {}
50
+
51
+ def build_defs(self, context: ComponentLoadContext) -> dg.Definitions:
52
+ # Create a unique function name based on the asset key to avoid conflicts when multiple Hightouch components are loaded
53
+ actual_sync_id = self.sync_id
54
+ if actual_sync_id.startswith("$"):
55
+ env_var_name = actual_sync_id[1:]
56
+ actual_sync_id = os.getenv(env_var_name)
57
+ if not actual_sync_id:
58
+ raise ValueError(f"Environment variable '{env_var_name}' not found.")
59
+ asset_key_str = "_".join(self.asset.key.path)
60
+ function_name = f"hightouch_sync_{asset_key_str}"
61
+
62
+ @dg.multi_asset(
63
+ name=function_name,
64
+ specs=[self.asset],
65
+ )
66
+ def _assets(hightouch: ConfigurableHightouchResource):
67
+ result = hightouch.sync_and_poll(actual_sync_id)
68
+
69
+ # Summing all failed rows (adds, changes, removes) for accurate reporting
70
+ failed_rows = result.sync_run_details.get("failedRows", {})
71
+ total_failed = sum(
72
+ failed_rows.get(k, 0)
73
+ for k in ["addedCount", "changedCount", "removedCount"]
74
+ )
75
+
76
+ yield dg.MaterializeResult(
77
+ asset_key=self.asset.key,
78
+ metadata={
79
+ "sync_details": dg.MetadataValue.json(result.sync_details),
80
+ "sync_run_details": dg.MetadataValue.json(result.sync_run_details),
81
+ "total_failed_rows": total_failed,
82
+ "failed_adds": failed_rows.get("addedCount", 0),
83
+ "failed_changes": failed_rows.get("changedCount", 0),
84
+ "failed_removes": failed_rows.get("removedCount", 0),
85
+ "destination_details": dg.MetadataValue.json(
86
+ result.destination_details
87
+ ),
88
+ "query_size": result.sync_run_details.get("querySize"),
89
+ "completion_ratio": result.sync_run_details.get("completionRatio"),
90
+ "failed_rows": result.sync_run_details.get("failedRows", {}).get(
91
+ "addedCount", 0
92
+ ),
93
+ },
94
+ )
95
+
96
+ return dg.Definitions(assets=[_assets])
@@ -17,7 +17,7 @@ from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
17
17
  ),
18
18
  config_schema={
19
19
  "sync_id": Field(
20
- str, is_required=True, description="The Sync ID that this op will triger."
20
+ str, is_required=True, description="The Sync ID that this op will trigger."
21
21
  ),
22
22
  "poll_interval": Field(
23
23
  float,
File without changes
@@ -1,12 +1,19 @@
1
1
  import datetime
2
2
  import logging
3
3
  import time
4
- from typing import Any, Dict, List, Optional, Tuple
4
+ from typing import Any, Optional
5
5
  from urllib.parse import urljoin
6
6
 
7
7
  import requests
8
8
 
9
- from dagster import Failure, Field, StringSource, get_dagster_logger, resource
9
+ from dagster import (
10
+ Failure,
11
+ Field,
12
+ StringSource,
13
+ get_dagster_logger,
14
+ resource,
15
+ ConfigurableResource,
16
+ )
10
17
 
11
18
  import dagster_hightouch
12
19
  from . import utils
@@ -28,7 +35,12 @@ WARNING = "warning"
28
35
 
29
36
  class HightouchResource:
30
37
  """
31
- this class exposes methods on top of the Hightouch REST API.
38
+ Client for the Hightouch REST API.
39
+
40
+ This class provides methods to interface with Hightouch endpoints,
41
+ primarily for triggering syncs and polling for their status.
42
+
43
+ Note: For modern Dagster pipelines, use :class:`ConfigurableHightouchResource`.
32
44
  """
33
45
 
34
46
  def __init__(
@@ -48,7 +60,7 @@ class HightouchResource:
48
60
  return HIGHTOUCH_API_BASE
49
61
 
50
62
  def make_request(
51
- self, method: str, endpoint: str, params: Optional[Dict[str, Any]] = None
63
+ self, method: str, endpoint: str, params: dict[str, Any] | None = None
52
64
  ):
53
65
  """Creates and sends a request to the desired Hightouch API endpoint
54
66
 
@@ -87,7 +99,7 @@ class HightouchResource:
87
99
 
88
100
  def get_sync_run_details(
89
101
  self, sync_id: str, sync_request_id: str
90
- ) -> List[Dict[str, Any]]:
102
+ ) -> list[dict[str, Any]]:
91
103
  """Get details about a given sync run from the Hightouch API.
92
104
 
93
105
  Args:
@@ -102,7 +114,7 @@ class HightouchResource:
102
114
  method="GET", endpoint=f"syncs/{sync_id}/runs", params=params
103
115
  )
104
116
 
105
- def get_destination_details(self, destination_id: str) -> Dict[str, Any]:
117
+ def get_destination_details(self, destination_id: str) -> dict[str, Any]:
106
118
  """Get details about a destination from the Hightouch API.
107
119
 
108
120
  Args:
@@ -115,7 +127,7 @@ class HightouchResource:
115
127
  method="GET", endpoint=f"destinations/{destination_id}"
116
128
  )
117
129
 
118
- def get_sync_details(self, sync_id: str) -> Dict[str, Any]:
130
+ def get_sync_details(self, sync_id: str) -> dict[str, Any]:
119
131
  """Get details about a given sync from the Hightouch API.
120
132
 
121
133
  Args:
@@ -145,8 +157,8 @@ class HightouchResource:
145
157
  sync_request_id: str,
146
158
  fail_on_warning: bool = False,
147
159
  poll_interval: float = DEFAULT_POLL_INTERVAL,
148
- poll_timeout: Optional[float] = None,
149
- ) -> Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]:
160
+ poll_timeout: float | None = None,
161
+ ) -> tuple[dict[str, Any], dict[str, Any], dict[str, Any]]:
150
162
  """Poll for the completion of a sync
151
163
 
152
164
  Args:
@@ -215,7 +227,7 @@ class HightouchResource:
215
227
  sync_id: str,
216
228
  fail_on_warning: bool = False,
217
229
  poll_interval: float = DEFAULT_POLL_INTERVAL,
218
- poll_timeout: Optional[float] = None,
230
+ poll_timeout: float | None = None,
219
231
  ) -> HightouchOutput:
220
232
  """
221
233
  Initialize a sync run for the given sync id, and polls until it completes
@@ -275,3 +287,49 @@ def ht_resource(context) -> HightouchResource:
275
287
  request_max_retries=context.resource_config["request_max_retries"],
276
288
  request_retry_delay=context.resource_config["request_retry_delay"],
277
289
  )
290
+
291
+
292
+ class ConfigurableHightouchResource(ConfigurableResource):
293
+ """
294
+ A resource for connecting to the Hightouch API using pythonic configuration.
295
+
296
+ This resource is the recommended way to manage Hightouch connections in
297
+ modern Dagster (1.0+).
298
+
299
+ Attributes:
300
+ api_key (str): Your Hightouch API key.
301
+ request_max_retries (int): Maximum number of retries for API requests. Defaults to 3.
302
+ request_retry_delay (float): Delay between retries in seconds. Defaults to 0.25.
303
+ """
304
+
305
+ api_key: str
306
+ request_max_retries: int = 3
307
+ request_retry_delay: float = 0.25
308
+ fail_on_warning: bool = False
309
+ poll_interval: float = DEFAULT_POLL_INTERVAL
310
+ poll_timeout: Optional[float] = None
311
+
312
+ def sync_and_poll(
313
+ self,
314
+ sync_id: str,
315
+ fail_on_warning: Optional[bool] = None,
316
+ poll_interval: Optional[float] = None,
317
+ poll_timeout: Optional[float] = None,
318
+ ) -> HightouchOutput:
319
+ inner_resource = HightouchResource(
320
+ api_key=self.api_key,
321
+ request_max_retries=self.request_max_retries,
322
+ request_retry_delay=self.request_retry_delay,
323
+ )
324
+ return inner_resource.sync_and_poll(
325
+ sync_id=sync_id,
326
+ fail_on_warning=fail_on_warning
327
+ if fail_on_warning is not None
328
+ else self.fail_on_warning,
329
+ poll_interval=poll_interval
330
+ if poll_interval is not None
331
+ else self.poll_interval,
332
+ poll_timeout=poll_timeout
333
+ if poll_timeout is not None
334
+ else self.poll_timeout,
335
+ )
@@ -1,14 +1,14 @@
1
1
  from collections import namedtuple
2
- from typing import Any, Dict, NamedTuple
2
+ from typing import Any, NamedTuple
3
3
 
4
4
 
5
5
  class HightouchOutput(
6
6
  NamedTuple(
7
7
  "_HightouchOutput",
8
8
  [
9
- ("sync_details", Dict[str, Any]),
10
- ("sync_run_details", Dict[str, Any]),
11
- ("destination_details", Dict[str, Any]),
9
+ ("sync_details", dict[str, Any]),
10
+ ("sync_run_details", dict[str, Any]),
11
+ ("destination_details", dict[str, Any]),
12
12
  ],
13
13
  )
14
14
  ):
@@ -0,0 +1,73 @@
1
+ from dateutil import parser
2
+
3
+ from .types import SyncRunParsedOutput
4
+
5
+
6
+ def parse_sync_run_details(sync_run_details) -> SyncRunParsedOutput:
7
+ created_at = None
8
+ started_at = None
9
+ finished_at = None
10
+ elapsed_seconds = None
11
+
12
+ if sync_run_details.get("createdAt"):
13
+ created_at = parser.parse(sync_run_details["createdAt"])
14
+ if sync_run_details.get("startedAt"):
15
+ started_at = parser.parse(sync_run_details["startedAt"])
16
+ if sync_run_details.get("finishedAt"):
17
+ finished_at = parser.parse(sync_run_details["finishedAt"])
18
+
19
+ if finished_at and started_at:
20
+ elapsed_seconds = (finished_at - started_at).seconds
21
+
22
+ planned_add = sync_run_details["plannedRows"].get("addedCount")
23
+ planned_change = sync_run_details["plannedRows"].get("changedCount")
24
+ planned_remove = sync_run_details["plannedRows"].get("removedCount")
25
+
26
+ successful_add = sync_run_details["successfulRows"].get("addedCount")
27
+ successful_change = sync_run_details["successfulRows"].get("changedCount")
28
+ successful_remove = sync_run_details["successfulRows"].get("removedCount")
29
+
30
+ failed_add = sync_run_details["failedRows"].get("addedCount")
31
+ failed_change = sync_run_details["failedRows"].get("changedCount")
32
+ failed_remove = sync_run_details["failedRows"].get("removedCount")
33
+
34
+ query_size = sync_run_details.get("querySize")
35
+ status = sync_run_details.get("status")
36
+ completion_ratio = float(sync_run_details.get("completionRatio", 0))
37
+ error = sync_run_details.get("error")
38
+
39
+ return SyncRunParsedOutput(
40
+ created_at=created_at,
41
+ started_at=started_at,
42
+ finished_at=finished_at,
43
+ elapsed_seconds=elapsed_seconds,
44
+ planned_add=planned_add,
45
+ planned_change=planned_change,
46
+ planned_remove=planned_remove,
47
+ successful_add=successful_add,
48
+ successful_change=successful_change,
49
+ successful_remove=successful_remove,
50
+ failed_add=failed_add,
51
+ failed_change=failed_change,
52
+ failed_remove=failed_remove,
53
+ query_size=query_size,
54
+ status=status,
55
+ completion_ratio=completion_ratio,
56
+ error=error,
57
+ )
58
+
59
+
60
+ def generate_metadata_from_parsed_run(parsed_output: SyncRunParsedOutput):
61
+ return {
62
+ "elapsed_seconds": parsed_output.elapsed_seconds or 0,
63
+ "planned_add": parsed_output.planned_add,
64
+ "planned_change": parsed_output.planned_change,
65
+ "planned_remove": parsed_output.planned_remove,
66
+ "successful_add": parsed_output.successful_add,
67
+ "successful_change": parsed_output.successful_change,
68
+ "successful_remove": parsed_output.successful_remove,
69
+ "failed_add": parsed_output.failed_add,
70
+ "failed_change": parsed_output.failed_change,
71
+ "failed_remove": parsed_output.failed_remove,
72
+ "query_size": parsed_output.query_size,
73
+ }
@@ -0,0 +1 @@
1
+ __version__ = "0.28.12"
@@ -1,3 +1,23 @@
1
+ Metadata-Version: 2.4
2
+ Name: dagster-hightouch
3
+ Version: 0.1.8
4
+ Summary: Dagster library for Hightouch
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
+ Requires-Python: >=3.10,<3.14
10
+ Description-Content-Type: text/markdown
11
+ License-File: LICENSE
12
+ Requires-Dist: dagster>=1.8.0
13
+ Requires-Dist: requests>=2.0
14
+ Requires-Dist: python-dateutil>=2.8.0
15
+ Dynamic: author
16
+ Dynamic: author-email
17
+ Dynamic: home-page
18
+ Dynamic: license-file
19
+ Dynamic: requires-python
20
+
1
21
  ## dagster-hightouch
2
22
 
3
23
  A Dagster library for triggering syncs in Hightouch.
@@ -62,3 +82,16 @@ def ht_sfdc_job():
62
82
  # And we schedule it to run every 30 mins.
63
83
  every_30_schedule = ScheduleDefinition(job=ht_sfdc_job, cron_schedule="*/30 * * * *")
64
84
  ```
85
+
86
+ ### Components (Modern)
87
+
88
+ You can now use Hightouch as a Dagster Component. This allows you to define syncs in YAML.
89
+
90
+ ```yaml
91
+ # code/component.yaml
92
+ type: HightouchSyncComponent
93
+ attributes:
94
+ sync_id: "12345"
95
+ asset:
96
+ key: ["hightouch", "my_sync_asset"]
97
+ ```
@@ -1,12 +1,20 @@
1
+ LICENSE
2
+ MANIFEST.in
1
3
  README.md
2
4
  pyproject.toml
5
+ setup.py
3
6
  dagster_hightouch/__init__.py
7
+ dagster_hightouch/component.py
4
8
  dagster_hightouch/ops.py
9
+ dagster_hightouch/py.typed
5
10
  dagster_hightouch/resources.py
6
11
  dagster_hightouch/types.py
7
12
  dagster_hightouch/utils.py
13
+ dagster_hightouch/version.py
8
14
  dagster_hightouch.egg-info/PKG-INFO
9
15
  dagster_hightouch.egg-info/SOURCES.txt
10
16
  dagster_hightouch.egg-info/dependency_links.txt
17
+ dagster_hightouch.egg-info/entry_points.txt
18
+ dagster_hightouch.egg-info/not-zip-safe
11
19
  dagster_hightouch.egg-info/requires.txt
12
20
  dagster_hightouch.egg-info/top_level.txt
@@ -0,0 +1,5 @@
1
+ [dagster.components]
2
+ dagster_hightouch = dagster_hightouch
3
+
4
+ [dagster_dg_cli.plugin]
5
+ dagster_hightouch = dagster_hightouch
@@ -0,0 +1,3 @@
1
+ dagster>=1.8.0
2
+ requests>=2.0
3
+ python-dateutil>=2.8.0
@@ -2,18 +2,27 @@
2
2
  name = "dagster-hightouch"
3
3
  description = "Dagster library for Hightouch"
4
4
  readme = "README.md"
5
- requires-python = ">=3.8"
5
+ requires-python = ">=3.10"
6
+ license = { text = "Apache-2.0" }
6
7
  dependencies = [
7
- "dagster>=0.14",
8
+ "dagster>=1.8.0",
8
9
  "requests>=2.0",
10
+ "python-dateutil>=2.8.0",
9
11
  ]
10
12
  dynamic = ["version"]
11
13
 
14
+ [project.entry-points."dagster.components"]
15
+ dagster_hightouch = "dagster_hightouch"
16
+
17
+ [project.entry-points."dagster_dg_cli.plugin"]
18
+ dagster_hightouch = "dagster_hightouch"
19
+
12
20
  [tool.uv]
13
21
  dev-dependencies = [
14
22
  "pyright>=1.1.386",
15
23
  "pytest",
16
- "ruff>=0.7.2",
24
+ "ruff==0.11.5",
25
+ "dagster-components",
17
26
  ]
18
27
 
19
28
  [build-system]
@@ -25,3 +34,6 @@ packages = ["dagster_hightouch"]
25
34
 
26
35
  [tool.setuptools.dynamic]
27
36
  version = {attr = "dagster_hightouch.__version__"}
37
+
38
+ [tool.ruff]
39
+ required-version = "==0.11.5"
@@ -0,0 +1,48 @@
1
+ from pathlib import Path
2
+ from setuptools import find_packages, setup
3
+
4
+
5
+ def get_version() -> str:
6
+ version: dict[str, str] = {}
7
+ with open(
8
+ Path(__file__).parent / "dagster_hightouch/version.py", encoding="utf8"
9
+ ) as fp:
10
+ exec(fp.read(), version)
11
+ return version["__version__"]
12
+
13
+
14
+ ver = get_version()
15
+
16
+ pin = "" if ver == "1!0+dev" else f"=={ver}"
17
+
18
+ setup(
19
+ name="dagster-hightouch",
20
+ version=ver,
21
+ author="Dagster Labs",
22
+ author_email="hello@dagsterlabs.com",
23
+ license="Apache-2.0",
24
+ description="Package for integrating Hightouch with Dagster.",
25
+ url="https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-hightouch",
26
+ classifiers=[
27
+ "Programming Language :: Python :: 3.10",
28
+ "Programming Language :: Python :: 3.11",
29
+ "Programming Language :: Python :: 3.12",
30
+ "Programming Language :: Python :: 3.13",
31
+ "License :: OSI Approved :: Apache Software License",
32
+ "Operating System :: OS Independent",
33
+ ],
34
+ packages=find_packages(exclude=["dagster_hightouch_tests*"]),
35
+ include_package_data=True,
36
+ python_requires=">=3.10,<3.14",
37
+ install_requires=[
38
+ "dagster==1.12.12",
39
+ "requests",
40
+ "python-dateutil",
41
+ ],
42
+ entry_points={
43
+ "dagster_dg_cli.registry_modules": [
44
+ "dagster_hightouch = dagster_hightouch",
45
+ ],
46
+ },
47
+ zip_safe=False,
48
+ )
@@ -1,5 +0,0 @@
1
- from dagster._core.libraries import DagsterLibraryRegistry
2
-
3
- __version__ = "0.1.6"
4
-
5
- DagsterLibraryRegistry.register("dagster-hightouch", __version__)
@@ -1,59 +0,0 @@
1
- from typing import Type
2
-
3
- from dateutil import parser
4
-
5
- from .types import SyncRunParsedOutput
6
-
7
-
8
- def parse_sync_run_details(sync_run_details) -> Type[SyncRunParsedOutput]:
9
- x = SyncRunParsedOutput
10
-
11
- x.created_at = None
12
- x.started_at = None
13
- x.finished_at = None
14
- x.elapsed_seconds = None
15
-
16
- if sync_run_details.get("createdAt"):
17
- x.created_at = parser.parse(sync_run_details["createdAt"])
18
- if sync_run_details.get("startedAt"):
19
- x.started_at = parser.parse(sync_run_details["startedAt"])
20
- if sync_run_details.get("finishedAt"):
21
- x.finished_at = parser.parse(sync_run_details["finishedAt"])
22
-
23
- if x.finished_at and x.started_at:
24
- x.elapsed_seconds = (x.finished_at - x.started_at).seconds
25
-
26
- x.planned_add = sync_run_details["plannedRows"].get("addedCount")
27
- x.planned_change = sync_run_details["plannedRows"].get("changedCount")
28
- x.planned_remove = sync_run_details["plannedRows"].get("removedCount")
29
-
30
- x.successful_add = sync_run_details["successfulRows"].get("addedCount")
31
- x.successful_change = sync_run_details["successfulRows"].get("changedCount")
32
- x.successful_remove = sync_run_details["successfulRows"].get("removedCount")
33
-
34
- x.failed_add = sync_run_details["failedRows"].get("addedCount")
35
- x.failed_change = sync_run_details["failedRows"].get("changedCount")
36
- x.failed_remove = sync_run_details["failedRows"].get("removedCount")
37
-
38
- x.query_size = sync_run_details.get("querySize")
39
- x.status = sync_run_details.get("status")
40
- x.completion_ratio = float(sync_run_details.get("completionRatio", 0))
41
- x.error = sync_run_details.get("error")
42
-
43
- return x
44
-
45
-
46
- def generate_metadata_from_parsed_run(parsed_output: SyncRunParsedOutput):
47
- return {
48
- "elapsed_seconds": parsed_output.elapsed_seconds or 0,
49
- "planned_add": parsed_output.planned_add,
50
- "planned_change": parsed_output.planned_change,
51
- "planned_remove": parsed_output.planned_remove,
52
- "successful_add": parsed_output.successful_add,
53
- "successful_change": parsed_output.successful_change,
54
- "successful_remove": parsed_output.successful_remove,
55
- "failed_add": parsed_output.failed_add,
56
- "failed_change": parsed_output.failed_change,
57
- "failed_remove": parsed_output.failed_remove,
58
- "query_size": parsed_output.query_size,
59
- }
@@ -1,2 +0,0 @@
1
- dagster>=0.14
2
- requests>=2.0