slackapi · seratch · Mar 24, 2021 · Mar 24, 2021
@@ -8,6 +8,8 @@ The Audit Logs API can be used by security information and event management (SIE
 
 Follow the instructions in `the API document <https://api.slack.com/admins/audit-logs>`_ to get a valid token for using Audit Logs API. The Slack app using the Audit Logs API needs to be installed in the Enterprise Grid Organization, not an individual workspace within the organization.
 
+The Python document for this module is available at https://slack.dev/python-slack-sdk/api-docs/
+
 AuditLogsClient
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

@@ -2,6 +2,11 @@
 FAQ
 ==============================================
 
+Python Module Documents
+*********************************
+
+The Python module documents are available at https://slack.dev/python-slack-sdk/api-docs/
+
 Installation Issues
 *********************************
 

@@ -44,6 +44,8 @@ The Slack platform offers several APIs to build apps. Each Slack API delivers pa
 | UI Builders                    | Construct UI components using easy-to-use builders.                                           | ``slack_sdk.models``               |
 +--------------------------------+-----------------------------------------------------------------------------------------------+------------------------------------+
 
+The Python module documents are available at https://slack.dev/python-slack-sdk/api-docs/
+
 Installation
 ************
 

@@ -6,6 +6,8 @@ This section explains the details about how to handle Slack's OAuth flow.
 
 If you're looking for a much easier way to do the same, check `Bolt for Python <https://github.com/slackapi/bolt-python>`_, which is a full-stack Slack App framework. With Bolt, you don't need to implement most of the following code on your own.
 
+The Python document for this module is available at https://slack.dev/python-slack-sdk/api-docs/
+
 App Installation Flow
 *************************************************
 

@@ -8,6 +8,8 @@ SCIM API Client
 
 Refer to `the API document <https://api.slack.com/scim>`_ for more details.
 
+The Python document for this module is available at https://slack.dev/python-slack-sdk/api-docs/
+
 SCIMClient
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

@@ -4,6 +4,8 @@ Socket Mode Client
 
 Socket Mode is a method of connecting your app to Slack’s APIs using WebSockets instead of HTTP. You can use  ``slack_sdk.socket_mode.SocketModeClient`` for managing `Socket Mode <https://api.slack.com/apis/connections/socket>`_ connections and performing interactions with Slack.
 
+The Python document for this module is available at https://slack.dev/python-slack-sdk/api-docs/
+
 SocketModeClient
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

@@ -8,6 +8,7 @@ Access Slack's API methods requires an OAuth token -- see the `Tokens & Authenti
 
 `Each of these API methods <https://api.slack.com/methods>`_ is fully documented on our developer site at https://api.slack.com/
 
+The Python document for this module is available at https://slack.dev/python-slack-sdk/api-docs/
 
 Messaging
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

@@ -4,6 +4,8 @@ Webhook Client
 
 You can use ``slack_sdk.webhook.WebhookClient`` for `Incoming Webhooks <https://api.slack.com/messaging/webhooks>`_ and message responses using `response_url in payloads <https://api.slack.com/interactivity/handling#message_responses>`_.
 
+The Python document for this module is available at https://slack.dev/python-slack-sdk/api-docs/
+
 Incoming Webhooks
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

@@ -0,0 +1,11 @@
+#!/bin/bash
+# Generate API documents from the latest source code
+
+script_dir=`dirname $0`
+cd ${script_dir}/..
+
+pip install pdoc3
+rm -rf docs/api-docs
+pdoc slack_sdk --html -o docs/api-docs
+open docs/api-docs/slack_sdk/index.html
+
@@ -1,3 +1,42 @@
+"""
+* The SDK website: https://slack.dev/python-slack-sdk/
+* PyPI package: https://pypi.org/project/slack-sdk/
+
+Here is the list of key modules in this SDK:
+
+#### Web API Client
+
+* Web API client: `slack_sdk.web.client`
+* asyncio-based Web API client: `slack_sdk.web.async_client`
+
+#### Webhook / response_url Client
+
+* Webhook client: `slack_sdk.webhook.client`
+* asyncio-based Webhook client: `slack_sdk.webhook.async_client`
+
+#### Socket Mode Client
+
+* The built-in Socket Mode client: `slack_sdk.socket_mode.builtin.client`
+* [aiohttp](https://pypi.org/project/aiohttp/) based client: `slack_sdk.socket_mode.aiohttp`
+* [websocket_client](https://pypi.org/project/websocket-client/) based client: `slack_sdk.socket_mode.websocket_client`
+* [websockets](https://pypi.org/project/websockets/) based client: `slack_sdk.socket_mode.websockets`
+
+#### OAuth
+
+* `slack_sdk.oauth.installation_store.installation_store`
+* `slack_sdk.oauth.state_store`
+
+#### Audit Logs API Client
+
+* `slack_sdk.audit_logs.v1.client`
+* `slack_sdk.audit_logs.v1.async_client`
+
+#### SCIM API Client
+
+* `slack_sdk.scim.v1.client`
+* `slack_sdk.scim.v1.async_client`
+
+"""
 import logging
 from logging import NullHandler
 

@@ -1,3 +1,4 @@
+"""Internal module for checking aiohttp compatibility of async modules"""
 import logging
 from typing import Callable
 

@@ -1,2 +1,6 @@
+"""Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
+
+Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+"""
 from .v1.client import AuditLogsClient  # noqa
 from .v1.response import AuditLogsResponse  # noqa
@@ -0,0 +1,4 @@
+"""Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
+
+Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+"""
@@ -1,3 +1,7 @@
+"""Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
+
+Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+"""
 import json
 import logging
 from ssl import SSLContext

@@ -1,3 +1,7 @@
+"""Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
+
+Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+"""
 import json
 import logging
 import urllib

@@ -1,3 +1,6 @@
+"""Errors that can be raised by this SDK"""
+
+
 class SlackClientError(Exception):
     """Base class for Client errors"""
 

@@ -1,3 +1,5 @@
+"""Classes for constructing Slack-specific data strtucture"""
+
 import logging
 from typing import Union, Dict, Any, Sequence, List
 

@@ -1,3 +1,7 @@
+"""Modules for implementing the Slack OAuth flow
+
+https://slack.dev/python-slack-sdk/oauth/
+"""
 from .authorize_url_generator import AuthorizeUrlGenerator  # noqa
 from .installation_store import InstallationStore  # noqa
 from .redirect_uri_page_renderer import RedirectUriPageRenderer  # noqa

@@ -1,3 +1,7 @@
+"""Slack installation data store
+
+Refer to https://slack.dev/python-slack-sdk/oauth/ for details.
+"""
 from logging import Logger
 from typing import Optional
 

@@ -1,3 +1,7 @@
+"""OAuth state parameter data store
+
+Refer to https://slack.dev/python-slack-sdk/oauth/ for details.
+"""
 # from .amazon_s3_state_store import AmazonS3OAuthStateStore
 from .file import FileOAuthStateStore  # noqa
 from .state_store import OAuthStateStore  # noqa
@@ -1,3 +1,4 @@
+"""Internal module for loading proxy-related env variables"""
 import logging
 import os
 from typing import Optional

@@ -1,3 +1,9 @@
+"""SCIM API is a set of APIs for provisioning and managing user accounts and groups.
+SCIM is used by Single Sign-On (SSO) services and identity providers to manage people across a variety of tools,
+including Slack.
+
+Refer to https://slack.dev/python-slack-sdk/scim/ for details.
+"""
 from .v1.client import SCIMClient  # noqa
 from .v1.response import SCIMResponse  # noqa
 from .v1.response import SearchUsersResponse, ReadUserResponse  # noqa

@@ -0,0 +1,6 @@
+"""SCIM API is a set of APIs for provisioning and managing user accounts and groups.
+SCIM is used by Single Sign-On (SSO) services and identity providers to manage people across a variety of tools,
+including Slack.
+
+Refer to https://slack.dev/python-slack-sdk/scim/ for details.
+"""
@@ -1,3 +1,9 @@
+"""SCIM API is a set of APIs for provisioning and managing user accounts and groups.
+SCIM is used by Single Sign-On (SSO) services and identity providers to manage people across a variety of tools,
+including Slack.
+
+Refer to https://slack.dev/python-slack-sdk/scim/ for details.
+"""
 import json
 import logging
 import urllib

@@ -1,3 +1,4 @@
+"""Slack request signature verifier"""
 import hashlib
 import hmac
 from time import time

@@ -1 +1,7 @@
+"""Socket Mode is a method of connecting your app to Slack’s APIs using WebSockets instead of HTTP.
+You can use slack_sdk.socket_mode.SocketModeClient for managing Socket Mode connections
+and performing interactions with Slack.
+
+https://api.slack.com/apis/connections/socket
+"""
 from .builtin import SocketModeClient  # noqa
@@ -1,3 +1,10 @@
+"""aiohttp bassd Socket Mode client
+
+* https://api.slack.com/apis/connections/socket
+* https://slack.dev/python-slack-sdk/socket-mode/
+* https://pypi.org/project/aiohttp/
+
+"""
 import asyncio
 import logging
 from asyncio import Future
@@ -68,6 +75,19 @@ def __init__(
         on_error_listeners: Optional[List[Callable[[WSMessage], None]]] = None,
         on_close_listeners: Optional[List[Callable[[WSMessage], None]]] = None,
     ):
+        """Socket Mode client
+
+        Args:
+            app_token: App-level token
+            logger: Custom logger
+            web_client: Web API client
+            auto_reconnect_enabled: True if automatic reconnection is enabled (default: True)
+            ping_interval: interval for ping-pong with Slack servers (seconds)
+            proxy: the HTTP proxy URL
+            on_message_listeners: listener functions for on_message
+            on_error_listeners: listener functions for on_error
+            on_close_listeners: listener functions for on_close
+        """
         self.app_token = app_token
         self.logger = logger or logging.getLogger(__name__)
         self.web_client = web_client or AsyncWebClient()

@@ -1,3 +1,9 @@
+"""The built-in Socket Mode client
+
+* https://api.slack.com/apis/connections/socket
+* https://slack.dev/python-slack-sdk/socket-mode/
+
+"""
 import logging
 from concurrent.futures.thread import ThreadPoolExecutor
 from logging import Logger
@@ -76,6 +82,25 @@ def __init__(
         on_error_listeners: Optional[List[Callable[[Exception], None]]] = None,
         on_close_listeners: Optional[List[Callable[[int, Optional[str]], None]]] = None,
     ):
+        """Socket Mode client
+
+        Args:
+            app_token: App-level token
+            logger: Custom logger
+            web_client: Web API client
+            auto_reconnect_enabled: True if automatic reconnection is enabled (default: True)
+            trace_enabled: True if more detailed debug-logging is enabled (default: False)
+            all_message_trace_enabled: True if all message dump in debug logs is enabled (default: False)
+            ping_pong_trace_enabled: True if trace logging for all ping-pong communications is enabled (default: False)
+            ping_interval: interval for ping-pong with Slack servers (seconds)
+            receive_buffer_size: the chunk size of a single socket recv operation (default: 1024)
+            concurrency: the size of thread pool (default: 10)
+            proxy: the HTTP proxy URL
+            proxy_headers: additional HTTP header for proxy connection
+            on_message_listeners: listener functions for on_message
+            on_error_listeners: listener functions for on_error
+            on_close_listeners: listener functions for on_close
+        """
         self.app_token = app_token
         self.logger = logger or logging.getLogger(__name__)
         self.web_client = web_client or WebClient()

@@ -1,3 +1,10 @@
+"""websocket-client bassd Socket Mode client
+
+* https://api.slack.com/apis/connections/socket
+* https://slack.dev/python-slack-sdk/socket-mode/
+* https://pypi.org/project/websocket-client/
+
+"""
 import logging
 from concurrent.futures.thread import ThreadPoolExecutor
 from logging import Logger
@@ -78,6 +85,24 @@ def __init__(
         ] = None,
         on_close_listeners: Optional[List[Callable[[WebSocketApp], None]]] = None,
     ):
+        """
+
+        Args:
+            app_token: App-level token
+            logger: Custom logger
+            web_client: Web API client
+            auto_reconnect_enabled: True if automatic reconnection is enabled (default: True)
+            ping_interval: interval for ping-pong with Slack servers (seconds)
+            concurrency: the size of thread pool (default: 10)
+            http_proxy_host: the HTTP proxy host
+            http_proxy_port: the HTTP proxy port
+            http_proxy_auth: the HTTP proxy username & password
+            proxy_type: the HTTP proxy type
+            on_open_listeners: listener functions for on_open
+            on_message_listeners: listener functions for on_message
+            on_error_listeners: listener functions for on_error
+            on_close_listeners: listener functions for on_close
+        """
         self.app_token = app_token
         self.logger = logger or logging.getLogger(__name__)
         self.web_client = web_client or WebClient()

@@ -1,3 +1,10 @@
+"""websockets bassd Socket Mode client
+
+* https://api.slack.com/apis/connections/socket
+* https://slack.dev/python-slack-sdk/socket-mode/
+* https://pypi.org/project/websockets/
+
+"""
 import asyncio
 import logging
 from asyncio import Future
@@ -58,6 +65,15 @@ def __init__(
         auto_reconnect_enabled: bool = True,
         ping_interval: float = 10,
     ):
+        """Socket Mode client
+
+        Args:
+            app_token: App-level token
+            logger: Custom logger
+            web_client: Web API client
+            auto_reconnect_enabled: True if automatic reconnection is enabled (default: True)
+            ping_interval: interval for ping-pong with Slack servers (seconds)
+        """
         self.app_token = app_token
         self.logger = logger or logging.getLogger(__name__)
         self.web_client = web_client or AsyncWebClient()

@@ -1 +1,2 @@
+"""Check the latest version at https://pypi.org/project/slack-sdk/"""
 __version__ = "3.4.2"
@@ -1,2 +1,4 @@
+"""The Slack Web API allows you to build applications that interact with Slack
+in more complex ways than the integrations we provide out of the box."""
 from .client import WebClient  # noqa
 from .slack_response import SlackResponse  # noqa
@@ -25,6 +25,8 @@
 class AsyncWebClient(AsyncBaseClient):
     """A WebClient allows apps to communicate with the Slack Platform's Web API.
 
+    https://api.slack.com/methods
+
     The Slack Web API is an interface for querying information from
     and enacting change in a Slack workspace.
 

@@ -16,6 +16,8 @@
 class WebClient(BaseClient):
     """A WebClient allows apps to communicate with the Slack Platform's Web API.
 
+    https://api.slack.com/methods
+
     The Slack Web API is an interface for querying information from
     and enacting change in a Slack workspace.
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		"""Check the latest version at https://pypi.org/project/slack-sdk/"""
		__version__ = "3.4.2"