You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-21Lines changed: 27 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
1
# Python slackclient
2
+
2
3
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.
3
4
5
+
**Comprehensive documentation on using the Slack Python can be found at [https://slack.dev/python-slackclient/](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.
13
15
14
16
The **Python slackclient** allows interaction with:
@@ -18,28 +20,29 @@ The **Python slackclient** allows interaction with:
18
20
19
21
If you want to use our [Events API][events-docs], please check the [Slack Events API adapter for Python][python-slack-events-api].
20
22
21
-
Details on the Tokens and Authentication can be found in our [Auth Guide][auth-guide].
23
+
Details on the Tokens and Authentication can be found in our [Auth Guide][https://slack.dev/python-slackclient/auth.html].
22
24
23
25
## Table of contents
24
26
25
-
*[Requirements](#requirements)
26
-
*[Installation](#installation)
27
-
*[Getting started tutorial](#getting-started-tutorial)
28
-
*[Basic Usage of the Web Client](#basic-usage-of-the-web-client)
29
-
*[Sending a message to Slack](#sending-a-message-to-slack)
30
-
*[Uploading files to Slack](#uploading-files-to-slack)
31
-
*[Basic Usage of the RTM Client](#basic-usage-of-the-rtm-client)
32
-
*[Advanced Options](#advanced-options)
33
-
*[Migrating from v1.x](#migrating-from-v1)
34
-
*[Support](#support)
27
+
-[Requirements](#requirements)
28
+
-[Installation](#installation)
29
+
-[Getting started tutorial](#getting-started-tutorial)
30
+
-[Basic Usage of the Web Client](#basic-usage-of-the-web-client)
31
+
-[Sending a message to Slack](#sending-a-message-to-slack)
32
+
-[Uploading files to Slack](#uploading-files-to-slack)
33
+
-[Basic Usage of the RTM Client](#basic-usage-of-the-rtm-client)
34
+
-[Advanced Options](#advanced-options)
35
+
-[Migrating from v1.x](#migrating-from-v1)
36
+
-[Support](#support)
35
37
36
38
### Requirements
39
+
37
40
---
41
+
38
42
This library requires Python 3.6 and above. If you require Python 2, please use our [SlackClient - v1.x][slackclientv1]. If you're unsure how to check what version of Python you're on, you can check it using the following:
39
43
40
44
> **Note:** You may need to use `python3` before your commands to ensure you use the correct Python path. e.g. `python3 --version`
41
45
42
-
43
46
```bash
44
47
python --version
45
48
@@ -52,23 +55,23 @@ python3 --version
52
55
53
56
We recommend using [PyPI][pypi] to install the Slack Developer Kit for Python.
54
57
55
-
56
58
```bash
57
59
pip3 install slackclient==2.0.0
58
60
```
59
61
60
62
### Getting started tutorial
63
+
61
64
---
62
65
63
66
We've created this [tutorial](/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.
64
67
65
68
**[Read the tutorial to get started!](/tutorial)**
66
69
67
70
### Basic Usage of the Web Client
68
-
---
69
71
70
-
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][api-methods]. More detailed examples can be found in our [Basic Usage][basic-usage] guide
72
+
---
71
73
74
+
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][api-methods]. More detailed examples can be found in our [Basic Usage][https://slack.dev/python-slackclient/basic_usage.html] guide
72
75
73
76
#### Sending a message to Slack
74
77
@@ -89,7 +92,6 @@ One of the most common use-cases is sending a message to Slack. If you want to s
89
92
90
93
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.
91
94
92
-
93
95
#### Uploading files to Slack
94
96
95
97
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][files.upload]
@@ -107,6 +109,7 @@ We've changed the process for uploading files to Slack to be much easier and str
107
109
```
108
110
109
111
### Basic Usage of the RTM Client
112
+
110
113
---
111
114
112
115
The [Real Time Messaging (RTM) API][rtm-docs] is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as users.
@@ -154,36 +157,39 @@ The Python slackclient v2 now uses [AIOHttp][aiohttp] under the hood so it allow
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][aiohttp].
163
166
164
167
### Migrating from v1
168
+
165
169
---
166
-
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.
170
+
171
+
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.
167
172
168
173
**[Check out the Migration Guide here!](https://github.com/slackapi/python-slackclient/wiki/Migrating-to-2.x)**
169
174
170
175
### Support
176
+
171
177
---
172
178
173
179
If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:
174
180
175
181
Use our [Github Issue Tracker][gh-issues] for reporting bugs or requesting features.
176
182
Visit the [Bot Developer Hangout][bd-hangout] for getting help using Slack Developer Kit for Python or just generally bond with your fellow Slack developers.
0 commit comments