prefect-slack

Welcome!

prefect-slack is a collection of prebuilt Prefect tasks that can be used to quickly construct Prefect flows.

Getting Started

Python setup

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-slack:

pip install prefect-slack

Then, register to view the block on Prefect Cloud:

prefect block register -m prefect_slack

Note, to use the load method on blocks, you must already have a block document saved through code or saved through the UI.

Slack setup

In order to use tasks in the collection, you'll first need to create a Slack app and install it in your Slack workspace. You can create a Slack app by navigating to the apps page for your Slack account and selecting Create New App.

For tasks that require a Bot user OAuth token, you can get a token for your app by navigating to your app's OAuth & Permissions page.

For tasks that require a Webhook URL, you can generate new Webhook URLs by navigating to your app's Incoming Webhooks page.

Slack's Basic app setup guide provides additional details on setting up a Slack app.

Write and run a flow

from prefect import flow
from prefect.context import get_run_context
from prefect_slack import SlackCredentials
from prefect_slack.messages import send_chat_message


@flow
def example_send_message_flow():
   context = get_run_context()

   # Run other tasks and subflows here

   token = "xoxb-your-bot-token-here"
   send_chat_message(
         slack_credentials=SlackCredentials(token=token),
         channel="#prefect",
         text=f"Flow run {context.flow_run.name} completed :tada:"
   )

example_send_message_flow()

Use with_options to customize options on any existing task or flow:

from prefect import flow
from prefect.context import get_run_context
from prefect_slack import SlackCredentials
from prefect_slack.messages import send_chat_message

custom_send_chat_message = send_chat_message.with_options(
    name="My custom task name",
    retries=2,
    retry_delay_seconds=10,
)
 
@flow
def example_with_options_flow():

    slack_credentials = SlackCredentials.load("my_slack_token")
    custom_send_chat_message(
            slack_credentials=slack_credentials,
            channel="#prefect",
            text=f"Flow run {context.flow_run.name} completed :tada:"
    )

example_with_options_flow()

For more tips on how to use tasks and flows in a Collection, check out Using Collections!

Resources

If you encounter any bugs while using prefect-slack, feel free to open an issue in the prefect-slack repository.

If you have any questions or issues while using prefect-slack, you can find help in either the Prefect Discourse forum or the Prefect Slack community

Feel free to ⭐️ or watch prefect-slack for updates too!

Development

If you'd like to install a version of prefect-slack for development, first clone the repository and then perform an editable install with pip:

git clone https://github.com/PrefectHQ/prefect-slack.git

cd prefect-slack/

pip install -e ".[dev]"