forked from slackapi/python-slack-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetup.py
More file actions
357 lines (314 loc) · 11.9 KB
/
setup.py
File metadata and controls
357 lines (314 loc) · 11.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# -*- coding: utf-8 -*-
import codecs
import os
import subprocess
import sys
from shutil import rmtree
from setuptools import setup, find_packages, Command
here = os.path.abspath(os.path.dirname(__file__))
__version__ = None
exec(open(f"{here}/slack_sdk/version.py").read())
long_description = ""
with codecs.open(os.path.join(here, "README.md"), encoding="utf-8") as readme:
long_description = readme.read()
validate_dependencies = [
"pytest>=6.2.5,<7",
"pytest-asyncio<1", # for async
"Flask-Sockets>=0.2,<1",
"Flask>=1,<2", # TODO: Flask-Sockets is not yet compatible with Flask 2.x
"Werkzeug<2", # TODO: Flask-Sockets is not yet compatible with Flask 2.x
"itsdangerous==1.1.0", # TODO: Flask-Sockets is not yet compatible with Flask 2.x
"Jinja2==3.0.3", # https://github.com/pallets/flask/issues/4494
"pytest-cov>=2,<3",
"flake8>=5,<6",
"black==22.8.0",
"click==8.0.4", # black is affected by https://github.com/pallets/click/issues/2225
"psutil>=5,<6",
# used only under slack_sdk/*_store
"boto3<=2",
# TODO: Upgrade to v2
"moto>=3,<4", # For AWS tests
]
codegen_dependencies = [
"black==22.10.0",
]
needs_pytest = {"pytest", "test", "ptr"}.intersection(sys.argv)
pytest_runner = ["pytest-runner"] if needs_pytest else []
class BaseCommand(Command):
user_options = []
@staticmethod
def status(s):
"""Prints things in bold."""
print("\033[1m{0}\033[0m".format(s))
def initialize_options(self):
pass
def finalize_options(self):
pass
def _run(self, s, command):
try:
self.status(s + "\n" + " ".join(command))
subprocess.check_call(command)
except subprocess.CalledProcessError as error:
sys.exit(error.returncode)
class UploadCommand(BaseCommand):
"""Support setup.py upload. Thanks @kennethreitz!"""
description = "Build and publish the package."
def run(self):
self._run(
"Installing upload dependencies ...",
[sys.executable, "-m", "pip", "install", "wheel"],
)
try:
self.status("Removing previous builds ...")
rmtree(os.path.join(here, "dist"))
rmtree(os.path.join(here, "build"))
except OSError:
pass
self._run(
"Building Source and Wheel (universal) distribution ...",
[sys.executable, "setup.py", "sdist", "bdist_wheel", "--universal"],
)
self._run(
"Installing Twine dependency ...",
[sys.executable, "-m", "pip", "install", "twine"],
)
self._run(
"Uploading the package to PyPI via Twine ...",
[sys.executable, "-m", "twine", "upload", "dist/*"],
)
class CodegenCommand(BaseCommand):
def run(self):
self._run(
"Installing required dependencies ...",
[sys.executable, "-m", "pip", "install"] + codegen_dependencies,
)
header = (
"# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
"#\n"
"# *** DO NOT EDIT THIS FILE ***\n"
"#\n"
"# 1) Modify slack_sdk/web/client.py\n"
"# 2) Run `python setup.py codegen`\n"
"#\n"
"# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
"\n"
)
with open(f"{here}/slack_sdk/web/client.py", "r") as original:
source = original.read()
import re
async_source = header + source
async_source = re.sub(" def ", " async def ", async_source)
async_source = re.sub("from asyncio import Future\n", "", async_source)
async_source = re.sub("return self.api_call\(", "return await self.api_call(", async_source)
async_source = re.sub("-> SlackResponse", "-> AsyncSlackResponse", async_source)
async_source = re.sub(
"from .base_client import BaseClient, SlackResponse",
"from .async_base_client import AsyncBaseClient, AsyncSlackResponse",
async_source,
)
# from slack_sdk import WebClient
async_source = re.sub(
"class WebClient\(BaseClient\):",
"class AsyncWebClient(AsyncBaseClient):",
async_source,
)
async_source = re.sub(
"from slack_sdk import WebClient",
"from slack_sdk.web.async_client import AsyncWebClient",
async_source,
)
async_source = re.sub("= WebClient\(", "= AsyncWebClient(", async_source)
async_source = re.sub(
" self.files_getUploadURLExternal\(",
" await self.files_getUploadURLExternal(",
async_source,
)
async_source = re.sub(
" self.files_completeUploadExternal\(",
" await self.files_completeUploadExternal(",
async_source,
)
async_source = re.sub(
" self.files_info\(",
" await self.files_info(",
async_source,
)
async_source = re.sub(
"_attach_full_file_metadata",
"_attach_full_file_metadata_async",
async_source,
)
async_source = re.sub(
" _attach_full_file_metadata_async\(",
" await _attach_full_file_metadata_async(",
async_source,
)
with open(f"{here}/slack_sdk/web/async_client.py", "w") as output:
output.write(async_source)
legacy_source = header + "from asyncio import Future\n" + source
legacy_source = re.sub("-> SlackResponse", "-> Union[Future, SlackResponse]", legacy_source)
legacy_source = re.sub(
"from .base_client import BaseClient, SlackResponse",
"from .legacy_base_client import LegacyBaseClient, SlackResponse",
legacy_source,
)
legacy_source = re.sub(
"class WebClient\(BaseClient\):",
"class LegacyWebClient(LegacyBaseClient):",
legacy_source,
)
legacy_source = re.sub(
"from slack_sdk import WebClient",
"from slack_sdk.web.legacy_client import LegacyWebClient",
legacy_source,
)
legacy_source = re.sub("= WebClient\(", "= LegacyWebClient(", legacy_source)
with open(f"{here}/slack_sdk/web/legacy_client.py", "w") as output:
output.write(legacy_source)
self._run(
"Running black (code formatter) ... ",
[sys.executable, "-m", "black", f"{here}/slack_sdk"],
)
class ValidateCommand(BaseCommand):
"""Support setup.py validate."""
description = "Run Python static code analyzer (flake8), formatter (black) and unit tests (pytest)."
user_options = [("test-target=", "i", "tests/{test-target}")]
def initialize_options(self):
self.test_target = ""
def run(self):
self._run(
"Installing test dependencies ...",
[sys.executable, "-m", "pip", "install"] + validate_dependencies,
)
self._run("Running black ...", [sys.executable, "-m", "black", f"{here}/slack"])
self._run("Running black ...", [sys.executable, "-m", "black", f"{here}/slack_sdk"])
self._run("Running flake8 for legacy packages ...", [sys.executable, "-m", "flake8", f"{here}/slack"])
self._run("Running flake8 for slack_sdk package ...", [sys.executable, "-m", "flake8", f"{here}/slack_sdk"])
target = self.test_target.replace("tests/", "", 1)
self._run(
"Running unit tests ...",
[
sys.executable,
"-m",
"pytest",
"--cov-report=xml",
f"--cov={here}/slack_sdk",
f"tests/{target}",
],
)
class UnitTestsCommand(BaseCommand):
"""Support setup.py validate."""
description = "Run unit tests (pytest)."
user_options = [("test-target=", "i", "tests/{test-target}")]
def initialize_options(self):
self.test_target = ""
def run(self):
target = self.test_target.replace("tests/", "", 1)
self._run(
"Running unit tests ...",
[
sys.executable,
"-m",
"pytest",
f"tests/{target}",
],
)
class IntegrationTestsCommand(BaseCommand):
"""Support setup.py run_integration_tests"""
description = "Run integration tests (pytest)."
user_options = [
("test-target=", "i", "integration_tests/{test-target}"),
]
def initialize_options(self):
self.test_target = ""
self.legacy = ""
def run(self):
target = self.test_target.replace("integration_tests/", "", 1)
path = f"integration_tests/{target}"
self._run(
"Running integration tests ...",
[
sys.executable,
"-m",
"pytest",
path,
],
)
setup(
name="slack_sdk",
version=__version__,
description="The Slack API Platform SDK for Python",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/slackapi/python-slack-sdk",
author="Slack Technologies, LLC",
author_email="opensource@slack.com",
python_requires=">=3.6.0",
include_package_data=True,
license="MIT",
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Topic :: Communications :: Chat",
"Topic :: System :: Networking",
"Topic :: Office/Business",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
],
keywords="slack slack-api web-api slack-rtm websocket chat chatbot chatops",
packages=find_packages(
exclude=[
"docs",
"docs-src",
"docs-v2",
"docs-src-v2",
"docs-v3",
"docs-src-v3",
"integration_tests",
"integration_tests_legacy",
"tests",
"tests.*",
"tutorial",
]
),
install_requires=[],
extras_require={
# pip install -e ".[testing]"
"testing": validate_dependencies,
# pip install -e ".[optional]"
"optional": [
# async modules depend on aiohttp
"aiodns>1.0",
# We recommend using 3.7.1+ for RTMClient
# https://github.com/slackapi/python-slack-sdk/issues/912
"aiohttp>=3.7.3,<4",
# used only under slack_sdk/*_store
"boto3<=2",
# InstallationStore/OAuthStateStore
# Since v3.20, we no longer support SQLAlchemy 1.3 or older.
# If you need to use a legacy version, please add our v3.19.5 code to your project.
"SQLAlchemy>=1.4,<3",
# Socket Mode
# websockets 9 is not compatible with Python 3.10
"websockets>=10,<11" if sys.version_info.minor > 6 else "websockets>=9.1,<10",
"websocket-client>=1,<2",
],
},
setup_requires=pytest_runner,
test_suite="tests",
tests_require=validate_dependencies,
cmdclass={
"upload": UploadCommand,
"codegen": CodegenCommand,
"validate": ValidateCommand,
"unit_tests": UnitTestsCommand,
"integration_tests": IntegrationTestsCommand,
},
)