Python slackclient

The Python slackclient is a developer kit for interfacing with the Slack Web API and Real Time Messaging (RTM) API on Python 3.6 and above.

Comprehensive documentation on using the Slack Python can be found at https://slack.dev/python-slackclient/

Whether you're building a custom app for your team, or integrating a third party service into your Slack workflows, Slack Developer Kit for Python allows you to leverage the flexibility of Python to get your project up and running as quickly as possible.

The Python slackclient allows interaction with:

The Slack web api methods available at our Api Docs site
Interaction with our RTM API

If you want to use our Events API, please check the Slack Events API adapter for Python.

Details on the Tokens and Authentication can be found in our Auth Guide.

Requirements
Installation
Getting started tutorial
Basic Usage of the Web Client
- Sending a message to Slack
- Uploading files to Slack
Basic Usage of the RTM Client
Async Usage
- Slackclient as a script
- Slackclient in a framework
Advanced Options
Migrating from v1.x
Support

Requirements

This library requires Python 3.6 and above. If you require Python 2, please use our SlackClient - v1.x. If you're unsure how to check what version of Python you're on, you can check it using the following:

Note: You may need to use python3 before your commands to ensure you use the correct Python path. e.g. python3 --version

python --version

-- or --

python3 --version

Installation

We recommend using PyPI to install the Slack Developer Kit for Python.

$ pip3 install slackclient

Getting started tutorial

We've created this tutorial to build a basic Slack app in less than 10 minutes. It requires some general programming knowledge, and Python basics. It focuses on the interacting with Slack's Web and RTM API. Use it to give you an idea of how to use this SDK.

Read the tutorial to get started!

Basic Usage of the Web Client

Slack provide a Web API that gives you the ability to build applications that interact with Slack in a variety of ways. This Development Kit is a module based wrapper that makes interaction with that API easier. We have a basic example here with some of the more common uses but a full list of the available methods are available here. More detailed examples can be found in our [Basic Usage][https://slack.dev/python-slackclient/basic_usage.html] guide

Sending a message to Slack

One of the most common use-cases is sending a message to Slack. If you want to send a message as your app, or as a user, this method can do both. In our examples, we specify the channel name, however it is recommended to use the channel_id where possible.

    import os
    import slack

    client = slack.WebClient(token=os.environ['SLACK_API_TOKEN'])

    response = client.chat_postMessage(
        channel='#random',
        text="Hello world!")
    assert response["ok"]
    assert response["message"]["text"] == "Hello world!"

Here we also ensure that the response back from Slack is a successful one and that the message is the one we sent by using the assert statement.

Uploading files to Slack

We've changed the process for uploading files to Slack to be much easier and straight forward. You can now just include a path to the file directly in the API call and upload it that way. You can find the details on this api call here

    import os
    import slack

    client = slack.WebClient(token=os.environ['SLACK_API_TOKEN'])

    response = client.files_upload(
        channels='#random',
        file="my_file.pdf")
    assert response["ok"]

Basic Usage of the RTM Client

The Real Time Messaging (RTM) API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as users.

If you prefer events to be pushed to you instead, we recommend using the HTTP-based Events API instead. Most event types supported by the RTM API are also available in the Events API. You can check out our Python Slack Events Adaptor if you want to use this API instead.

An RTMClient allows apps to communicate with the Slack Platform's RTM API.

The event-driven architecture of this client allows you to simply link callbacks to their corresponding events. When an event occurs this client executes your callback while passing along any information it receives. We also give you the ability to call our web client from inside your callbacks.

In our example below, we watch for a message event that contains "Hello" and if its received, we call the say_hello() function. We then issue a call to the web client to post back to the channel saying "Hi" to the user.

    import os
    import slack

    @slack.RTMClient.run_on(event='message')
    def say_hello(**payload):
        data = payload['data']
        web_client = payload['web_client']
        rtm_client = payload['rtm_client']
        if 'Hello' in data['text']:
            channel_id = data['channel']
            thread_ts = data['ts']
            user = data['user']

            web_client.chat_postMessage(
                channel=channel_id,
                text=f"Hi <@{user}>!",
                thread_ts=thread_ts
            )

    slack_token = os.environ["SLACK_API_TOKEN"]
    rtm_client = slack.RTMClient(token=slack_token)
    rtm_client.start()

Async usage

slackclient v2 and higher uses aiohttp and asyncio to enable async functionality.

Normal usage of the library does not run it in async, hence a kwarg of run_async=True is needed.

When in async mode its important to remember to await or run/run_until_complete the call.

Slackclient as a script

import os
import slack
import asyncio

loop = asyncio.get_event_loop()

client = slack.WebClient(
    token=os.environ['SLACK_API_TOKEN'],
    run_async=True
    )

response = loop.run_until_complete(client.chat_postMessage(
        channel='#random',
        text="Hello world!"
        )
        )
assert response["ok"]
assert response["message"]["text"] == "Hello world!"

Slackclient in a framework

If you are using a framework invoking the asyncio event loop like : sanic/jupyter notebook/etc.

import os
import slack


client = slack.WebClient(
    token=os.environ['SLACK_API_TOKEN'],
    run_async=True
    )

async def send_async_message(channel='#random', text='')
    response = await client.chat_postMessage(
            channel=channel,
            text=text
            )
    assert response["ok"]
    assert response["message"]["text"] == "Hello world!"

Advanced Options

The Python slackclient v2 now uses AIOHttp under the hood.

Looking for a performance boost? Installing the optional dependencies (aiodns) may help speed up DNS resolving by the client. We've included it as an extra called "optional":

$ pip3 install slackclient[optional]

Interested in SSL or Proxy support? Simply use their built-in SSL and Proxy arguments. You can pass these options directly into both the RTM and the Web client.

import os
import slack

client = slack.WebClient(token=os.environ['SLACK_API_TOKEN'], ssl=sslcert, proxy=proxyinfo)

We will always follow the standard process in AIOHttp for those proxy and SSL settings so for more information, check out their documentation page linked here.

Migrating from v1

If you're migrating from v1.x of slackclient to v2.x, Please follow our migration guide to ensure your app continues working after updating.

Check out the Migration Guide here!

Support

If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:

Use our Github Issue Tracker for reporting bugs or requesting features. Visit the Bot Developer Hangout for getting help using Slack Developer Kit for Python or just generally bond with your fellow Slack developers.

spumer/python-slackclient