Skip to content

Commit 31e189b

Browse files
authored
Put deprecation notice and heightened focus on migration to latest version of the SDK, removed references of support for old version of the SDK, removed no-longer-applicable badges. (#1198)
1 parent 7d32abb commit 31e189b

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# Python slackclient
22

3+
## Important Notice
4+
5+
**This [`slackclient`](https://pypi.org/project/slackclient/) PyPI project is in maintenance mode now** and [`slack-sdk`](https://pypi.org/project/slack-sdk/) project is the successor. The v3 SDK provides more functionalities such as Socket Mode, OAuth flow module, SCIM API, Audit Logs API, better asyncio support, retry handlers, and many more.
6+
7+
Refer to [the migration guide](https://slack.dev/python-slack-sdk/v3-migration/index.html#from-slackclient-2-x) to learn how to smoothly migrate your existing code.
8+
9+
## Overview
10+
311
The Python `slackclient` library is a developer kit for interfacing with the Slack Web API and Real Time Messaging (RTM) API on Python 3.6 and above.
412

513
**Comprehensive documentation on using the Slack Python can be found at [https://slack.dev/python-slackclient/](https://slack.dev/python-slackclient/)**
614

7-
[![pypi package][pypi-image]][pypi-url]
8-
[![Build Status][travis-image]][travis-url]
9-
[![Python Version][python-version]][pypi-url]
10-
[![codecov][codecov-image]][codecov-url]
11-
[![contact][contact-image]][contact-url]
12-
1315
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.
1416

1517
The **Python slackclient** allows interaction with:
@@ -189,7 +191,7 @@ When in async mode its important to remember to await or run/run_until_complete
189191

190192
#### Slackclient as a script
191193

192-
```python
194+
```python
193195
import asyncio
194196
import os
195197
from slack import WebClient
@@ -326,10 +328,10 @@ If you're migrating from v1.x of slackclient to v2.x, Please follow our migratio
326328

327329
---
328330

329-
If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:
330-
331-
Use our [Github Issue Tracker][gh-issues] for reporting bugs or requesting features.
332-
Visit the [Slack Community][slack-community] for getting help using Slack Developer Kit for Python or just generally bond with your fellow Slack developers.
331+
We no longer provide support for v1 or v2 of this SDK and only maintain the latest v3 version. If you would like support
332+
from this project's maintainers please consider updating to the latest version of the SDK first. Otherwise, you may visit the
333+
[Slack Community][slack-community] for getting help using Slack Developer Kit for Python or just generally bond with your
334+
fellow Slack developers.
333335

334336
<!-- Markdown links -->
335337

0 commit comments

Comments
 (0)