Description

<h1 align="center">Python Slack SDK</h1> <p align="center"> <a href="https://github.com/slackapi/python-slack-sdk/actions/workflows/ci-build.yml"> <img alt="Tests" src="https://img.shields.io/github/actions/workflow/status/slackapi/python-slack-sdk/ci-build.yml"></a> <a href="https://codecov.io/gh/slackapi/python-slack-sdk"> <img alt="Codecov" src="https://img.shields.io/codecov/c/gh/slackapi/python-slack-sdk"></a> <a href="https://pepy.tech/project/slack-sdk"> <img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/slack-sdk"></a> <br> <a href="https://pypi.org/project/slack-sdk/"> <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/slack-sdk"></a> <a href="https://pypi.org/project/slack-sdk/"> <img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/slack-sdk.svg"></a> <a href="https://docs.slack.dev/tools/python-slack-sdk/"> <img alt="Documentation" src="https://img.shields.io/badge/dev-docs-yellow"></a> </p> The Slack platform offers several APIs to build apps. Each Slack API delivers part of the capabilities from the platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of Slack’s APIs. They are small and powerful when used independently, and work seamlessly when used together, too. **Comprehensive documentation on using the Slack Python can be found at [https://docs.slack.dev/tools/python-slack-sdk/](https://docs.slack.dev/tools/python-slack-sdk/)** --- 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 Slack SDK** allows interaction with: - `slack_sdk.web`: for calling the [Web API methods][api-methods] - `slack_sdk.webhook`: for utilizing the [Incoming Webhooks](https://docs.slack.dev/messaging/sending-messages-using-incoming-webhooks/) and [`response_url`s in payloads](https://docs.slack.dev/interactivity/handling-user-interaction/#message_responses) - `slack_sdk.signature`: for [verifying incoming requests from the Slack API server](https://docs.slack.dev/authentication/verifying-requests-from-slack/) - `slack_sdk.socket_mode`: for receiving and sending messages over [Socket Mode](https://docs.slack.dev/apis/events-api/using-socket-mode/) connections - `slack_sdk.audit_logs`: for utilizing [Audit Logs APIs](https://docs.slack.dev/admins/audit-logs-api/) - `slack_sdk.scim`: for utilizing [SCIM APIs](https://docs.slack.dev/admins/scim-api/) - `slack_sdk.oauth`: for implementing the [Slack OAuth flow](https://docs.slack.dev/authentication/installing-with-oauth/) - `slack_sdk.models`: for constructing [Block Kit](https://docs.slack.dev/block-kit/) UI components using easy-to-use builders - `slack_sdk.rtm`: for utilizing the [RTM API][rtm-docs] If you want to use our [Events API][events-docs] and Interactivity features, please check the [Bolt for Python][bolt-python] library. Details on the Tokens and Authentication can be found in our [Auth Guide](https://docs.slack.dev/tools/python-slack-sdk/installation/). ## slackclient is in maintenance mode Are you looking for [slackclient](https://pypi.org/project/slackclient/)? The slackclient project is in maintenance mode now and this [`slack_sdk`](https://pypi.org/project/slack-sdk/) is the successor. If you have time to make a migration to slack_sdk v3, please follow [our migration guide](https://docs.slack.dev/tools/python-slack-sdk/v3-migration/) to ensure your app continues working after updating. ## Table of contents * [Requirements](#requirements) * [Installation](#installation) * [Getting started tutorial](#getting-started-tutorial) * [Basic Usage of the Web Client](#basic-usage-of-the-web-client) * [Sending a message to Slack](#sending-a-message-to-slack) * [Uploading files to Slack](#uploading-files-to-slack) * [Async usage](#async-usage) * [WebClient as a script](#asyncwebclient-in-a-script) * [WebClient in a framework](#asyncwebclient-in-a-framework) * [Advanced Options](#advanced-options) * [SSL](#ssl) * [Proxy](#proxy) * [DNS performance](#dns-performance) * [Example](#example) * [Migrating from v1](#migrating-from-v1) * [Support](#support) * [Development](#development) ### Requirements --- This library requires Python 3.7 and above. 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` ```bash python --version -- or -- python3 --version ``` ### Installation We recommend using [PyPI][pypi] to install the Slack Developer Kit for Python. ```bash $ pip install slack_sdk ``` ### Getting started tutorial --- We've created this [tutorial](https://github