dagster-hightouch 0.1.8__py3-none-any.whl → 0.28.13__py3-none-any.whl

dagster_hightouch/__init__.py

@@ -1,17 +1,15 @@
-from dagster._core.libraries import DagsterLibraryRegistry
-from .resources import ConfigurableHightouchResource, HightouchResource
-from .ops import hightouch_sync_op
-from .component import HightouchSyncComponent
+from dagster_shared.libraries import DagsterLibraryRegistry
 
-__version__ = "0.1.8"
+from dagster_hightouch.component import HightouchSyncComponent
+from dagster_hightouch.ops import hightouch_sync_op
+from dagster_hightouch.resources import ConfigurableHightouchResource, HightouchResource
+from dagster_hightouch.version import __version__ as __version__
 
-DagsterLibraryRegistry.register(
-    "dagster-hightouch", __version__, is_dagster_package=True
-)
+DagsterLibraryRegistry.register("dagster-hightouch", __version__, is_dagster_package=True)
 
 __all__ = [
     "ConfigurableHightouchResource",
     "HightouchResource",
-    "hightouch_sync_op",
     "HightouchSyncComponent",
+    "hightouch_sync_op",
 ]

dagster_hightouch/component.py

@@ -3,21 +3,14 @@ from collections.abc import Mapping
 from typing import Any
 
 import dagster as dg
-from dagster.components import (
-    Component,
-    Model,
-    Resolvable,
-    ResolvedAssetSpec,
-    ComponentLoadContext,
-)
+from dagster.components import Component, ComponentLoadContext, Model, Resolvable, ResolvedAssetSpec
 from pydantic import Field
 
-from .resources import ConfigurableHightouchResource
+from dagster_hightouch.resources import ConfigurableHightouchResource
 
 
 class HightouchSyncComponent(Component, Resolvable, Model):
-    """
-    Represents a Hightouch sync as a Dagster asset.
+    """Represents a Hightouch sync as a Dagster asset.
 
     This component allows you to trigger a Hightouch sync and monitor its completion
     as part of your Dagster asset graph. When materialized, it calls the Hightouch API,
@@ -69,8 +62,7 @@ class HightouchSyncComponent(Component, Resolvable, Model):
             # Summing all failed rows (adds, changes, removes) for accurate reporting
             failed_rows = result.sync_run_details.get("failedRows", {})
             total_failed = sum(
-                failed_rows.get(k, 0)
-                for k in ["addedCount", "changedCount", "removedCount"]
+                failed_rows.get(k, 0) for k in ["addedCount", "changedCount", "removedCount"]
             )
 
             yield dg.MaterializeResult(
@@ -82,9 +74,7 @@ class HightouchSyncComponent(Component, Resolvable, Model):
                     "failed_adds": failed_rows.get("addedCount", 0),
                     "failed_changes": failed_rows.get("changedCount", 0),
                     "failed_removes": failed_rows.get("removedCount", 0),
-                    "destination_details": dg.MetadataValue.json(
-                        result.destination_details
-                    ),
+                    "destination_details": dg.MetadataValue.json(result.destination_details),
                     "query_size": result.sync_run_details.get("querySize"),
                     "completion_ratio": result.sync_run_details.get("completionRatio"),
                     "failed_rows": result.sync_run_details.get("failedRows", {}).get(

dagster_hightouch/ops.py

@@ -1,10 +1,7 @@
 from dagster import AssetMaterialization, Field, In, Noneable, Nothing, Out, Output, op
-from dagster_hightouch.utils import (
-    generate_metadata_from_parsed_run,
-    parse_sync_run_details,
-)
 
-from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
+from dagster_hightouch.resources import DEFAULT_POLL_INTERVAL, HightouchOutput
+from dagster_hightouch.utils import generate_metadata_from_parsed_run, parse_sync_run_details
 
 
 @op(
@@ -22,8 +19,7 @@ from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
         "poll_interval": Field(
             float,
             default_value=DEFAULT_POLL_INTERVAL,
-            description="The time (in seconds) that will be waited between successive "
-            "polls.",
+            description="The time (in seconds) that will be waited between successive polls.",
         ),
         "fail_on_warning": Field(
             bool,
@@ -40,13 +36,11 @@ from .resources import DEFAULT_POLL_INTERVAL, HightouchOutput
     tags={"kind": "hightouch"},
 )
 def hightouch_sync_op(context):
-    """
-    Executes a Hightouch sync for a given ``sync_id``, and polls until that sync
+    """Executes a Hightouch sync for a given ``sync_id``, and polls until that sync
     completes, raising an error if it is unsuccessful. It outputs a HightouchOutput
     which contains the details of the Hightouch connector after the sync run
     successfully completes.
     """
-
     hightouch_output: HightouchOutput = context.resources.hightouch.sync_and_poll(
         sync_id=context.op_config["sync_id"],
         fail_on_warning=context.op_config["fail_on_warning"],
@@ -55,9 +49,7 @@ def hightouch_sync_op(context):
     )
     destination_type = hightouch_output.destination_details.get("type")
     destination_slug = hightouch_output.destination_details.get("slug")
-    sync_object = hightouch_output.sync_details.get("configuration", dict()).get(
-        "object"
-    )
+    sync_object = hightouch_output.sync_details.get("configuration", dict()).get("object")
     if sync_object:
         asset_name = ["hightouch", destination_type, destination_slug, sync_object]
     else:

dagster_hightouch/resources.py

@@ -5,19 +5,11 @@ from typing import Any, Optional
 from urllib.parse import urljoin
 
 import requests
-
-from dagster import (
-    Failure,
-    Field,
-    StringSource,
-    get_dagster_logger,
-    resource,
-    ConfigurableResource,
-)
+from dagster import ConfigurableResource, Failure, Field, StringSource, get_dagster_logger, resource
 
 import dagster_hightouch
-from . import utils
-from .types import HightouchOutput
+from dagster_hightouch import utils
+from dagster_hightouch.types import HightouchOutput
 
 HIGHTOUCH_API_BASE = "https://api.hightouch.io/api/v1/"
 DEFAULT_POLL_INTERVAL = 3
@@ -34,8 +26,7 @@ WARNING = "warning"
 
 
 class HightouchResource:
-    """
-    Client for the Hightouch REST API.
+    """Client for the Hightouch REST API.
 
     This class provides methods to interface with Hightouch endpoints,
     primarily for triggering syncs and polling for their status.
@@ -59,10 +50,8 @@ class HightouchResource:
     def api_base_url(self) -> str:
         return HIGHTOUCH_API_BASE
 
-    def make_request(
-        self, method: str, endpoint: str, params: dict[str, Any] | None = None
-    ):
-        """Creates and sends a request to the desired Hightouch API endpoint
+    def make_request(self, method: str, endpoint: str, params: dict[str, Any] | None = None):
+        """Creates and sends a request to the desired Hightouch API endpoint.
 
         Args:
             method (str): The http method use for this request (e.g. "GET", "POST").
@@ -72,7 +61,6 @@ class HightouchResource:
         Returns:
             Dict[str, Any]: Parsed json data from the response to this request
         """
-
         user_agent = f"HightouchDagsterOp/{dagster_hightouch.__version__}"
         headers = {"Authorization": f"Bearer {self._api_key}", "User-Agent": user_agent}
 
@@ -97,9 +85,7 @@ class HightouchResource:
 
         raise Failure("Exceeded max number of retries.")
 
-    def get_sync_run_details(
-        self, sync_id: str, sync_request_id: str
-    ) -> list[dict[str, Any]]:
+    def get_sync_run_details(self, sync_id: str, sync_request_id: str) -> list[dict[str, Any]]:
         """Get details about a given sync run from the Hightouch API.
 
         Args:
@@ -110,9 +96,7 @@ class HightouchResource:
             Dict[str, Any]: Parsed json data from the response
         """
         params = {"runId": sync_request_id}
-        return self.make_request(
-            method="GET", endpoint=f"syncs/{sync_id}/runs", params=params
-        )
+        return self.make_request(method="GET", endpoint=f"syncs/{sync_id}/runs", params=params)
 
     def get_destination_details(self, destination_id: str) -> dict[str, Any]:
         """Get details about a destination from the Hightouch API.
@@ -123,9 +107,7 @@ class HightouchResource:
         Returns:
             Dict[str, Any]: Parsed json data from the response
         """
-        return self.make_request(
-            method="GET", endpoint=f"destinations/{destination_id}"
-        )
+        return self.make_request(method="GET", endpoint=f"destinations/{destination_id}")
 
     def get_sync_details(self, sync_id: str) -> dict[str, Any]:
         """Get details about a given sync from the Hightouch API.
@@ -139,7 +121,7 @@ class HightouchResource:
         return self.make_request(method="GET", endpoint=f"syncs/{sync_id}")
 
     def start_sync(self, sync_id: str) -> str:
-        """Trigger a sync and initiate a sync run
+        """Trigger a sync and initiate a sync run.
 
         Args:
             sync_id (str): The Hightouch Sync ID.
@@ -147,9 +129,7 @@ class HightouchResource:
         Returns:
             str: The sync request ID created by the Hightouch API.
         """
-        return self.make_request(method="POST", endpoint=f"syncs/{sync_id}/trigger")[
-            "id"
-        ]
+        return self.make_request(method="POST", endpoint=f"syncs/{sync_id}/trigger")["id"]
 
     def poll_sync(
         self,
@@ -159,7 +139,7 @@ class HightouchResource:
         poll_interval: float = DEFAULT_POLL_INTERVAL,
         poll_timeout: float | None = None,
     ) -> tuple[dict[str, Any], dict[str, Any], dict[str, Any]]:
-        """Poll for the completion of a sync
+        """Poll for the completion of a sync.
 
         Args:
             sync_id (str): The Hightouch Sync ID
@@ -204,10 +184,8 @@ class HightouchResource:
                     sync_id,
                     sync_request_id,
                 )
-            if (
-                poll_timeout
-                and datetime.datetime.now()
-                > poll_start + datetime.timedelta(seconds=poll_timeout)
+            if poll_timeout and datetime.datetime.now() > poll_start + datetime.timedelta(
+                seconds=poll_timeout
             ):
                 raise Failure(
                     f"Sync {sync_id} for request: {sync_request_id}' time out after "
@@ -216,9 +194,7 @@ class HightouchResource:
 
             time.sleep(poll_interval)
         sync_details = self.get_sync_details(sync_id)
-        destination_details = self.get_destination_details(
-            sync_details["destinationId"]
-        )
+        destination_details = self.get_destination_details(sync_details["destinationId"])
 
         return (sync_details, sync_run_details, destination_details)
 
@@ -229,8 +205,7 @@ class HightouchResource:
         poll_interval: float = DEFAULT_POLL_INTERVAL,
         poll_timeout: float | None = None,
     ) -> HightouchOutput:
-        """
-        Initialize a sync run for the given sync id, and polls until it completes
+        """Initialize a sync run for the given sync id, and polls until it completes.
 
         Args:
             sync_id (str): The Hightouch Sync ID
@@ -239,6 +214,7 @@ class HightouchResource:
             poll_interval (float): The time in seconds that will be waited between succcessive polls
             poll_timeout (float): The maximum time that will be waited before this operation
                 times out.
+
         Returns:
             :py:class:`~HightouchOutput`:
                 Object containing details about the Hightouch sync run
@@ -277,8 +253,7 @@ class HightouchResource:
     description="This resource helps manage Fivetran connectors",
 )
 def ht_resource(context) -> HightouchResource:
-    """
-    This resource allows users to programatically interface with the Hightouch REST API to triggers
+    """This resource allows users to programatically interface with the Hightouch REST API to triggers
     syncs and monitor their progress.
     """
     return HightouchResource(
@@ -290,8 +265,7 @@ def ht_resource(context) -> HightouchResource:
 
 
 class ConfigurableHightouchResource(ConfigurableResource):
-    """
-    A resource for connecting to the Hightouch API using pythonic configuration.
+    """A resource for connecting to the Hightouch API using pythonic configuration.
 
     This resource is the recommended way to manage Hightouch connections in
     modern Dagster (1.0+).
@@ -326,10 +300,6 @@ class ConfigurableHightouchResource(ConfigurableResource):
             fail_on_warning=fail_on_warning
             if fail_on_warning is not None
             else self.fail_on_warning,
-            poll_interval=poll_interval
-            if poll_interval is not None
-            else self.poll_interval,
-            poll_timeout=poll_timeout
-            if poll_timeout is not None
-            else self.poll_timeout,
+            poll_interval=poll_interval if poll_interval is not None else self.poll_interval,
+            poll_timeout=poll_timeout if poll_timeout is not None else self.poll_timeout,
         )

dagster_hightouch/types.py

@@ -12,8 +12,8 @@ class HightouchOutput(
         ],
     )
 ):
-    """
-    Contains recorded information about the state of a Hightouch sync after a sync completes.
+    """Contains recorded information about the state of a Hightouch sync after a sync completes.
+
     Attributes:
         sync_details (Dict[str, Any]):
             https://hightouch.io/docs/api-reference/#operation/GetSync

dagster_hightouch/utils.py

@@ -1,6 +1,6 @@
 from dateutil import parser
 
-from .types import SyncRunParsedOutput
+from dagster_hightouch.types import SyncRunParsedOutput
 
 
 def parse_sync_run_details(sync_run_details) -> SyncRunParsedOutput:

dagster_hightouch/version.py

@@ -1 +1 @@
-__version__ = "0.28.12"
+__version__ = "0.28.13"

dagster_hightouch-0.28.13.dist-info/METADATA

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: dagster-hightouch
+Version: 0.28.13
+Summary: Package for integrating Hightouch with Dagster.
+Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-hightouch
+Author: Dagster Labs
+Author-email: hello@dagsterlabs.com
+License: Apache-2.0
+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: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10,<3.14
+License-File: LICENSE
+Requires-Dist: dagster==1.12.13
+Requires-Dist: requests
+Requires-Dist: python-dateutil
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

dagster_hightouch-0.28.13.dist-info/RECORD

@@ -0,0 +1,14 @@
+dagster_hightouch/__init__.py,sha256=vJ3L8sXCPCudvnStDwc2LI7_QK41d-o3om9tMlKkvd4,554
+dagster_hightouch/component.py,sha256=5kU-doyYyWEIyxO2U1R7LBjZB3ADCH1c5In50Ur0Myc,3585
+dagster_hightouch/ops.py,sha256=W53cPL2K2v8oh4ZJKB0dpEMaeu1OM14LvhVlgfJi1iE,2921
+dagster_hightouch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dagster_hightouch/resources.py,sha256=1UrRGwV9HWji1WIN5qn-Tuxag5YGNSSIR0iNtzac5JQ,11524
+dagster_hightouch/types.py,sha256=_w7HgO66oyCWCFJmNIZBipJJTGaNvvtp6Nm4NQ08VP8,1282
+dagster_hightouch/utils.py,sha256=1zik0n8ko2p4pUddd3t1gE01za9FHBUcxIXej8eykLU,2883
+dagster_hightouch/version.py,sha256=V__meM42MWuoz8aUqc0jpG42uTRWaiUA_MsUAt6BdlY,24
+dagster_hightouch-0.28.13.dist-info/licenses/LICENSE,sha256=4lsMW-RCvfVD4_F57wrmpe3vX1xwUk_OAKKmV_XT7Z0,11348
+dagster_hightouch-0.28.13.dist-info/METADATA,sha256=bdnfSgaqLZ8dh27KgBm3AD___qubpFk1Bwic7q4yLTg,935
+dagster_hightouch-0.28.13.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+dagster_hightouch-0.28.13.dist-info/entry_points.txt,sha256=8_wDE9eM6V0IqKFnIn-eqvdALvvMCajY5TdEKyVmDwY,72
+dagster_hightouch-0.28.13.dist-info/top_level.txt,sha256=oMoqAW8f7myyEz6FG5zNzVQr3RzPdYm67ekvSD96N54,18
+dagster_hightouch-0.28.13.dist-info/RECORD,,

{dagster_hightouch-0.1.8.dist-info → dagster_hightouch-0.28.13.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

dagster_hightouch-0.28.13.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[dagster_dg_cli.registry_modules]
+dagster_hightouch = dagster_hightouch

dagster_hightouch-0.1.8.dist-info/METADATA

@@ -1,97 +0,0 @@
-Metadata-Version: 2.4
-Name: dagster-hightouch
-Version: 0.1.8
-Summary: Dagster library for Hightouch
-Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-hightouch
-Author: Dagster Labs
-Author-email: hello@dagsterlabs.com
-License: Apache-2.0
-Requires-Python: >=3.10,<3.14
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: dagster>=1.8.0
-Requires-Dist: requests>=2.0
-Requires-Dist: python-dateutil>=2.8.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-python
-
-## dagster-hightouch
-
-A Dagster library for triggering syncs in Hightouch.
-
-### Installation
-
-To install the library, use pip alongside your existing Dagster environment.
-
-```bash
-pip install dagster-hightouch
-```
-
-### Configuration
-
-First, you'll need to specify your [Hightouch API](https://hightouch.com/docs/developer-tools/api-guide/) key as a resource.
-
-```python
-# resources.py
-from dagster_hightouch.resources import ht_resource as hightouch_resource
-
-ht_resource = hightouch_resource.configured(
-    {"api_key": "555555-4444-3333-2222-1111111111"},
-)
-```
-
-### Ops
-
-The `hightouch_sync_op` will call the Hightouch API to trigger
-a sync and monitor it until it completes.
-
-```python
-from dagster import ScheduleDefinition, get_dagster_logger, job
-from dagster_hightouch.ops import hightouch_sync_op
-from .resources import ht_resource
-
-# Sync IDs are set as constants. You can also use
-# the sync slug, read the documentation for other
-# options.
-
-HT_WS = "23620"
-HT_ORG = "39619"
-
-# We define two configured sync ops
-run_ht_sync_workspaces = hightouch_sync_op.configured(
-    {"sync_id": HT_WS}, name="hightouch_sfdc_workspaces"
-)
-run_ht_sync_orgs = hightouch_sync_op.configured(
-    {"sync_id": HT_ORG}, name="hightouch_sfdc_organizations"
-)
-
-# And create a job with the defined resources, specifying the dependencies.
-@job(
-    resource_defs={
-        "hightouch": ht_resource,
-    }
-)
-def ht_sfdc_job():
-
-    ht_orgs = run_ht_sync_orgs(start_after=ht_contacts)
-    run_ht_sync_workspaces(start_after=ht_orgs)
-
-# And we schedule it to run every 30 mins.
-every_30_schedule = ScheduleDefinition(job=ht_sfdc_job, cron_schedule="*/30 * * * *")
-```
-
-### Components (Modern)
-
-You can now use Hightouch as a Dagster Component. This allows you to define syncs in YAML.
-
-```yaml
-# code/component.yaml
-type: HightouchSyncComponent
-attributes:
-  sync_id: "12345"
-  asset:
-    key: ["hightouch", "my_sync_asset"]
-```

dagster_hightouch-0.1.8.dist-info/RECORD

@@ -1,14 +0,0 @@
-dagster_hightouch/__init__.py,sha256=bUtjgrae_pvQ9zQDbXLX09Szv1gU5K9RaCtQdRz5Xs4,465
-dagster_hightouch/component.py,sha256=pzCjdXxLxK7qBOoxotCmlpr-47dn8vP7PvuXyvzocbM,3660
-dagster_hightouch/ops.py,sha256=8pXqqrGP8tLBL1nsQv0A0fd7UfU1V72CyUb82IRyk8s,2952
-dagster_hightouch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dagster_hightouch/resources.py,sha256=tA-oT-1J6G4Fcuz9XIOG0Lkxr_HixFQI-6U47QmiQOs,11739
-dagster_hightouch/types.py,sha256=nI7BTLpXCvYM3HUQLK3nxa1FKnl-G0_bJIHp2BYialc,1286
-dagster_hightouch/utils.py,sha256=-mSN0aglUIwsxBiBRgj0cHi5B5SVXWk3K-rezMyPKaM,2866
-dagster_hightouch/version.py,sha256=1WEy1K1rD5aYOP4qevjehq-uhsiK733U8NKj3tvYXW4,24
-dagster_hightouch-0.1.8.dist-info/licenses/LICENSE,sha256=4lsMW-RCvfVD4_F57wrmpe3vX1xwUk_OAKKmV_XT7Z0,11348
-dagster_hightouch-0.1.8.dist-info/METADATA,sha256=bZV-qYuc18xDmkgHWlckp2pgVFiy4dCr1cfG0G2rKAo,2489
-dagster_hightouch-0.1.8.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-dagster_hightouch-0.1.8.dist-info/entry_points.txt,sha256=FNsunIn3oGoK-0cyaf7VRy-hlzhRB1em38guc30kPcw,122
-dagster_hightouch-0.1.8.dist-info/top_level.txt,sha256=oMoqAW8f7myyEz6FG5zNzVQr3RzPdYm67ekvSD96N54,18
-dagster_hightouch-0.1.8.dist-info/RECORD,,

dagster_hightouch-0.1.8.dist-info/entry_points.txt

@@ -1,5 +0,0 @@
-[dagster.components]
-dagster_hightouch = dagster_hightouch
-
-[dagster_dg_cli.plugin]
-dagster_hightouch = dagster_hightouch