-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Taras Priadka
committed
Dec 8, 2023
1 parent
14d273e
commit b37a58e
Showing
5 changed files
with
83 additions
and
3 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Automation Example - Interval Trigger | ||
|
||
Note: This document is a work in progress and is subject to change. | ||
|
||
We will walk through the process of creating an [automation](overview.md) using `Interval` trigger on Latch which will run automation workflow hourly. We assume that you understand how to write and register [Workflows](../basics/what_is_a_workflow.md) on Latch. | ||
|
||
**Terms:** | ||
- _Automation Workflow_: workflow which will be called by automation. This is the workflow we create in [step 1](#1-create-the-automation-workflow) of this tutorial. | ||
|
||
## 1: Create the Automation Workflow | ||
Below is a simple workflow example which creates folder `output` with a file locally and pushes it to Latch Data. | ||
|
||
Note: to upload `LatchDir` or `` | ||
|
||
1. Initialize a new workflow using `latch init automation-wf`. | ||
2. Replace `__init__.py` and `task.py` with the following sample code. | ||
```python | ||
# __init__.py | ||
|
||
from wf.task import task | ||
|
||
from latch.resources.workflow import workflow | ||
from latch.types.directory import LatchDir, LatchOutputDir | ||
from latch.types.file import LatchFile | ||
from latch.types.metadata import LatchAuthor, LatchMetadata, LatchParameter | ||
|
||
metadata = LatchMetadata( | ||
display_name="Interval Automation Workflow", | ||
author=LatchAuthor( | ||
name="Your Name", | ||
), | ||
# Note: parameters have to be empty for this workflow to be successfully run by the automation | ||
parameters={}, | ||
) | ||
|
||
|
||
@workflow(metadata) | ||
def workflow() -> None: | ||
task() | ||
``` | ||
|
||
```python | ||
# task.py | ||
|
||
import os | ||
from urllib.parse import urljoin | ||
|
||
from latch import message | ||
from latch.resources.tasks import small_task | ||
from latch.types.directory import LatchDir, LatchFile, LatchOutputDir | ||
|
||
@small_task | ||
def task() -> LatchDir: | ||
os.mkdir("output") | ||
with open("output/hello_world.txt", 'w') as file: | ||
file.write("Hello World!") | ||
|
||
return LatchDir("output", "LDATA PATH FOR THE DIRECTORY") | ||
``` | ||
|
||
3. Register the sample target workflow with Latch using | ||
```shell-session | ||
$ latch register --remote --yes automation-wf | ||
``` | ||
5. Test the workflow by running it on Latch | ||
|
||
## 2. Create Automation | ||
|
||
Navigate to [Automations](https://console.latch.bio/automations) tab via **Worfklows** > **Automations** and click on the **Create Automation** button. | ||
|
||
1. Input an **Automation Name** and **Description**. | ||
|
||
2. Select the `Event Type` as `Interval`. | ||
|
||
3. Specify `Interval` to 1 hour. | ||
|
||
4. Select the automation workflow that you have just registered with Latch. | ||
|
||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters