First Steps¶

1. Import¶

Start with the basics, which is importing the necessary classes and methods. (DotFlow, action)

Python 3.8+

from dotflow import DotFlow, action

# Code below omitted 👇

👀 Full file preview

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()

2. Callback function¶

Create a my_callback function to receive execution information of a task. It is not necessary to include this function, as you will still have a report at the end of the execution in the instantiated object of the DotFlow class. This my_callback function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter. More details

Python 3.8+

# Code above omitted 👆

def my_callback(*args, **kwargs):
    print(args, kwargs)

# Code below omitted 👇

👀 Full file preview

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()

3. Task function¶

Now, create the function responsible for executing your task. It's very simple; just use the action decorator above the function, and that's it—you've created a task.

Python 3.8+

# Code above omitted 👆

@action
def my_task():
    print("task")

# Code below omitted 👇

👀 Full file preview

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()

4. DotFlow Class¶

Instantiate the DotFlow class in a workflow variable to be used in the following steps. More details.

Python 3.8+

# Code above omitted 👆

workflow = DotFlow()

# Code below omitted 👇

👀 Full file preview

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()

5. Add Task¶

Now, simply add the my_task and my_callback functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow. More details

Python 3.8+

# Code above omitted 👆

workflow.task.add(step=my_task, callback=my_callback)

# Code below omitted 👇

👀 Full file preview

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()

6. Start¶

Finally, just execute the workflow with the following code snippet. More details

Python 3.8+

# Code above omitted 👆

workflow.start()

👀 Full file preview

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()

Full Code¶

The simplest file could look like this:

Python 3.8+

from dotflow import DotFlow, action


def my_callback(*args, **kwargs):
    print(args, kwargs)


@action
def my_task():
    print("task")


workflow = DotFlow()
workflow.task.add(step=my_task, callback=my_callback)
workflow.start()