prefecthq / prefect-hightouch Goto Github PK

Create a task that retrieves the details for a Hightouch sync run. The task should accept a HightouchCredentials block and the ID of the Hightouch sync run. The task should return the full details of the specified sync run.

Link to relevant route in Hightouch API docs: https://hightouch.com/docs/api-reference#operation/ListSyncRuns

Create a flow that triggers a Hightouch sync and waits for it to reach a terminal state.

The flow should accept:

• a HightouchCredentials block
• a sync ID
• a flag to specify if a full resync should be performed
• an optional number of seconds to wait for completion
• an optional poll frequency

The flow should return the final details of the final sync run when successful. The flow should raise if the sync run was unsuccessful for any reason.

prefect block register -m prefect_hightouch.credentials
Warning!  Failed to load collection 'prefect_hightouch': ModuleNotFoundError: No module named 'attr'
Unable to load prefect_hightouch.credentials. Please make sure the module is installed in your current environment

I've verified the package is installed in my conda environment.

(hightouch_sfdc_syncs) dylanbhughes@Dylans-MacBook-Pro-2 ~/d/f/s/p/c/hightouch_sfdc_syncs> prefect version
Warning!  Failed to load collection 'prefect_hightouch': ModuleNotFoundError: No module named 'attr'
Version:             2.7.1
API version:         0.8.3
Python version:      3.10.0
Git commit:          33f7de50
Built:               Thu, Dec 8, 2022 4:09 PM
OS/Arch:             darwin/arm64
Profile:             cloud2_dw
Server type:         cloud

Weird that the warning is being returned in the prefect version call as well?

Create a task that triggers a Hightouch sync. The task should accept a HightouchCredentials block, a sync ID, and a flag to specify whether or not to do a full resync. The task should return the ID of the triggered sync run.

Link to Hightouch API documentation for the route: https://hightouch.com/docs/api-reference#operation/TriggerRun

Create a task that is capable of performing a generic API call against the Hightouch API. The task should consume a HightouchCredentials block along with the necessary info to perform an API call (HTTP method, URI, body, params, etc.). The task should return the body of the API response.

Add a HightouchClient class that is responsible for encapsulating the logic around interacting with the Hightouch API. The client should handle authentication and session management with the API. There should be one public method that can be used to execute any generic call to the Hightouch API. Each other public method should be an abstraction around a given API route and have parameters matching what is expected for the route/body/params required for the given API route.

For the issue, only the method to call an arbitrary endpoint in the Hightouch API is necessary.

Add a block that can store a Hightouch API key. The block should also expose a get_client method that returns an authenticated Hightouch client that can be used to interact with the Hightouch API.

Hello,
Contrary to what's suggested in the Readme, it looks like this package is not in PyPi. Is it still being developed? Do you have plans to release it? And until it's released, can the V1 tasks be used as a substitute?
Thanks!

Edit: Turns out this package is just a boilerplate… A "disclaimer" somewhere to highlight that it's not useable yet would be useful!

    Can we add a log statement saying that we successfully triggered the sync and potentially give a URL to the Hightouch app to view progress?

Originally posted by @desertaxle in #12 (comment)