mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 21:04:40 +01:00
client/#75 - added missed vendored slackclient for Python2
This commit is contained in:
Petr Kalis
parent
ac047fbc4f
commit
5c34f996ce
100 changed files with 23011 additions and 0 deletions
|
|
@ -0,0 +1,32 @@
|
|||
# credit: https://packaging.python.org/guides/supporting-windows-using-appveyor/
|
||||
|
||||
environment:
|
||||
matrix:
|
||||
- PYTHON: "C:\\Python27"
|
||||
PYTHON_VERSION: "py27-x86"
|
||||
- PYTHON: "C:\\Python34"
|
||||
PYTHON_VERSION: "py34-x86"
|
||||
- PYTHON: "C:\\Python35"
|
||||
PYTHON_VERSION: "py35-x86"
|
||||
- PYTHON: "C:\\Python27-x64"
|
||||
PYTHON_VERSION: "py27-x64"
|
||||
- PYTHON: "C:\\Python34-x64"
|
||||
PYTHON_VERSION: "py34-x64"
|
||||
- PYTHON: "C:\\Python35-x64"
|
||||
PYTHON_VERSION: "py35-x64"
|
||||
|
||||
install:
|
||||
- "%PYTHON%\\python.exe -m pip install wheel"
|
||||
- "%PYTHON%\\python.exe -m pip install -r requirements.txt"
|
||||
- "%PYTHON%\\python.exe -m pip install flake8"
|
||||
- "%PYTHON%\\python.exe -m pip install -r test_requirements.txt"
|
||||
|
||||
build: off
|
||||
|
||||
test_script:
|
||||
- "%PYTHON%\\python.exe -m flake8 slackclient"
|
||||
- "%PYTHON%\\python.exe -m pytest --cov-report= --cov=slackclient tests"
|
||||
|
||||
# maybe `after_test:`?
|
||||
on_success:
|
||||
- "%PYTHON%\\python.exe -m codecov -e win-%PYTHON_VERSION%"
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
[run]
|
||||
branch = True
|
||||
source = slackclient
|
||||
|
||||
[report]
|
||||
exclude_lines =
|
||||
if self.debug:
|
||||
pragma: no cover
|
||||
raise NotImplementedError
|
||||
if __name__ == .__main__.:
|
||||
ignore_errors = True
|
||||
omit =
|
||||
tests/*
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
[flake8]
|
||||
max-line-length = 100
|
||||
60
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/contributing.md
vendored
Normal file
60
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/contributing.md
vendored
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# Contributors Guide
|
||||
|
||||
Interested in contributing? Awesome! Before you do though, please read our
|
||||
[Code of Conduct](https://slackhq.github.io/code-of-conduct). We take it very seriously, and expect that you will as
|
||||
well.
|
||||
|
||||
There are many ways you can contribute! :heart:
|
||||
|
||||
### Bug Reports and Fixes :bug:
|
||||
- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slackclient/issues), and if it isn't already tracked,
|
||||
[create a new issue](https://github.com/slackapi/python-slackclient/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
|
||||
be reviewed.
|
||||
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
|
||||
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
|
||||
- Include tests that isolate the bug and verifies that it was fixed.
|
||||
|
||||
### New Features :bulb:
|
||||
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/slackapi/python-slackclient/issues/new).
|
||||
- Issues that have been identified as a feature request will be labelled `enhancement`.
|
||||
- If you'd like to implement the new feature, please wait for feedback from the project
|
||||
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
|
||||
not align well with the project objectives at the time.
|
||||
|
||||
### Tests :mag:, Documentation :books:, Miscellaneous :sparkles:
|
||||
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
|
||||
alternative implementation of something that may have advantages over the way its currently
|
||||
done, or you have any other change, we would be happy to hear about it!
|
||||
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
|
||||
- If not, [open an Issue](https://github.com/slackapi/python-slackclient/issues/new) to discuss the idea first.
|
||||
|
||||
If you're new to our project and looking for some way to make your first contribution, look for
|
||||
Issues labelled `good first contribution`.
|
||||
|
||||
## Requirements
|
||||
|
||||
For your contribution to be accepted:
|
||||
|
||||
- [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/python-slackclient).
|
||||
- [x] The test suite must be complete and pass.
|
||||
- [x] The changes must be approved by code review.
|
||||
- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
|
||||
|
||||
If the contribution doesn't meet the above criteria, you may fail our automated checks or a maintainer will discuss it with you. You can continue to improve a Pull Request by adding commits to the branch from which the PR was created.
|
||||
|
||||
[Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)
|
||||
|
||||
## Creating a Pull Request
|
||||
|
||||
1. :fork_and_knife: Fork the repository on GitHub.
|
||||
2. :runner: Clone/fetch your fork to your local development machine. It's a good idea to run the tests just
|
||||
to make sure everything is in order.
|
||||
3. :herb: Create a new branch and check it out.
|
||||
4. :crystal_ball: Make your changes and commit them locally. Magic happens here!
|
||||
5. :arrow_heading_up: Push your new branch to your fork. (e.g. `git push username fix-issue-16`).
|
||||
6. :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `master` in this
|
||||
repository.
|
||||
|
||||
## Maintainers
|
||||
|
||||
There are more details about processes and workflow in the [Maintainer's Guide](./maintainers_guide.md).
|
||||
48
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/issue_template.md
vendored
Normal file
48
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/issue_template.md
vendored
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
### Description
|
||||
|
||||
Describe your issue here.
|
||||
|
||||
### What type of issue is this? (place an `x` in one of the `[ ]`)
|
||||
- [ ] bug
|
||||
- [ ] enhancement (feature request)
|
||||
- [ ] question
|
||||
- [ ] documentation related
|
||||
- [ ] testing related
|
||||
- [ ] discussion
|
||||
|
||||
### Requirements (place an `x` in each of the `[ ]`)
|
||||
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md) and have done my best effort to follow them.
|
||||
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
|
||||
* [ ] I've searched for any related issues and avoided creating a duplicate issue.
|
||||
|
||||
---
|
||||
|
||||
### Bug Report
|
||||
|
||||
Filling out the following details about bugs will help us solve your issue sooner.
|
||||
|
||||
#### Reproducible in:
|
||||
|
||||
slackclient version:
|
||||
|
||||
python version:
|
||||
|
||||
OS version(s):
|
||||
|
||||
#### Steps to reproduce:
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
#### Expected result:
|
||||
|
||||
What you expected to happen
|
||||
|
||||
#### Actual result:
|
||||
|
||||
What actually happened
|
||||
|
||||
#### Attachments:
|
||||
|
||||
Logs, screenshots, screencast, sample project, funny gif, etc.
|
||||
100
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/maintainers_guide.md
vendored
Normal file
100
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/maintainers_guide.md
vendored
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
# Maintainers Guide
|
||||
|
||||
This document describes tools, tasks and workflow that one needs to be familiar with in order to effectively maintain
|
||||
this project. If you use this package within your own software as is but don't plan on modifying it, this guide is
|
||||
**not** for you.
|
||||
|
||||
## Tools
|
||||
|
||||
### Python (and friends)
|
||||
|
||||
Not surprisingly, you will need to have Python installed on your system to work on this package. We support non-EOL,
|
||||
stable versions of CPython. The current supported versions are listed in the CI configurations (e.g. `.travis.yml`).
|
||||
At a minimum, you should have the latest version of Python 2 and the latest version of Python 3 to develop against.
|
||||
It's tricky to set up a system that has more than that, so you can lean on the CI servers to test changes on the
|
||||
in-between versions for you.
|
||||
|
||||
You should also make sure you have the latest versions of `pip`, `setuptools`, `virtualenv`, `wheel`, `twine` and
|
||||
[`tox`](https://tox.readthedocs.io/en/latest/) installed with your version of Python.
|
||||
|
||||
On macOS, the easiest way to install these tools is by using [Homebrew](https://brew.sh/) and installing the `python`
|
||||
and `python3` packages. Some of the above packages are preinstalled and you can install the remaining on your own:
|
||||
`pip install virtualenv wheel twine tox && pip3 install virtualenv twine tox`.
|
||||
|
||||
## Tasks
|
||||
|
||||
### Testing
|
||||
|
||||
Tox is used to run the test suite across multiple isolated versions of Python. It is configured in `tox.ini` to
|
||||
run all the supported versions of Python, but when you invoke it, you should only select the versions you have on your
|
||||
system. For example, on a system with Python 2.7.13 and Python 3.6.1, you would run the tests using the following
|
||||
command: `tox -e flake8,py27,py36` (flake8 is a quality analysis tool).
|
||||
|
||||
### Generating Documentation
|
||||
|
||||
The documentation is generated from the source and templates in the `docs-src` directory. The generated documentation
|
||||
gets committed to the repo in `docs` and also published to a GitHub Pages website.
|
||||
|
||||
You can generate the documentation by running `tox -e docs`.
|
||||
|
||||
### Releasing
|
||||
|
||||
1. Create the commit for the release:
|
||||
* Bump the version number in adherence to [Semantic Versioning](http://semver.org/) in `slackclient/version.py`.
|
||||
* Commit with a message including the new version number. For example `1.0.6`.
|
||||
|
||||
2. Distribute the release
|
||||
* Build the distribtuions: `python setup.py sdist bdist_wheel`. This will create artifacts in the `dist` directory.
|
||||
* Publish to PyPI: `twine upload dist/*`. You must have access to the credentials to publish.
|
||||
* Create a GitHub Release. You will select the commit with updated version number (e.g. `1.0.6`) to assiociate with
|
||||
the tag, and name the tag after this version (e.g. `1.0.6`). This will also serve as a Changelog for the project.
|
||||
Add a description of changes to the Release. Mention Issue and PR #'s and @-mention contributors.
|
||||
|
||||
3. (Slack Internal) Communicate the release internally. Include a link to the GitHub Release.
|
||||
|
||||
4. Announce on Slack Team dev4slack in #slack-api
|
||||
|
||||
5. (Slack Internal) Tweet? Not necessary for patch updates, might be needed for minor updates, definitely needed for
|
||||
major updates. Include a link to the GitHub Release.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Versioning and Tags
|
||||
|
||||
This project uses semantic versioning, expressed through the numbering scheme of
|
||||
[PEP-0440](https://www.python.org/dev/peps/pep-0440/).
|
||||
|
||||
### Branches
|
||||
|
||||
`master` is where active development occurs. Long running named feature branches are occasionally created for
|
||||
collaboration on a feature that has a large scope (because everyone cannot push commits to another person's open Pull
|
||||
Request). At some point in the future after a major version increment, there may be maintenance branches for older major
|
||||
versions.
|
||||
|
||||
### Issue Management
|
||||
|
||||
Labels are used to run issues through an organized workflow. Here are the basic definitions:
|
||||
|
||||
* `bug`: A confirmed bug report. A bug is considered confirmed when reproduction steps have been
|
||||
documented and the issue has been reproduced.
|
||||
* `enhancement`: A feature request for something this package might not already do.
|
||||
* `docs`: An issue that is purely about documentation work.
|
||||
* `tests`: An issue that is purely about testing work.
|
||||
* `needs feedback`: An issue that may have claimed to be a bug but was not reproducible, or was otherwise missing some information.
|
||||
* `discussion`: An issue that is purely meant to hold a discussion. Typically the maintainers are looking for feedback in this issues.
|
||||
* `question`: An issue that is like a support request because the user's usage was not correct.
|
||||
* `semver:major|minor|patch`: Metadata about how resolving this issue would affect the version number.
|
||||
* `security`: An issue that has special consideration for security reasons.
|
||||
* `good first contribution`: An issue that has a well-defined relatively-small scope, with clear expectations. It helps when the testing approach is also known.
|
||||
* `duplicate`: An issue that is functionally the same as another issue. Apply this only if you've linked the other issue by number.
|
||||
|
||||
**Triage** is the process of taking new issues that aren't yet "seen" and marking them with a basic level of information
|
||||
with labels. An issue should have **one** of the following labels applied: `bug`, `enhancement`, `question`,
|
||||
`needs feedback`, `docs`, `tests`, or `discussion`.
|
||||
|
||||
Issues are closed when a resolution has been reached. If for any reason a closed issue seems relevant once again,
|
||||
reopening is great and better than creating a duplicate issue.
|
||||
|
||||
## Everything else
|
||||
|
||||
When in doubt, find the other maintainers and ask.
|
||||
8
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/pull_request_template.md
vendored
Normal file
8
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.github/pull_request_template.md
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
### Summary
|
||||
|
||||
Describe the goal of this PR. Mention any related Issue numbers.
|
||||
|
||||
### Requirements (place an `x` in each `[ ]`)
|
||||
|
||||
* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md) and have done my best effort to follow them.
|
||||
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
|
||||
26
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.gitignore
vendored
Normal file
26
openpype/modules/slack/python2_vendor/python-slack-sdk-1/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# general things to ignore
|
||||
build/
|
||||
dist/
|
||||
docs/_sources/
|
||||
docs/.doctrees
|
||||
*.egg-info/
|
||||
*.egg
|
||||
*.py[cod]
|
||||
__pycache__/
|
||||
*.so
|
||||
*~
|
||||
|
||||
# virtualenv
|
||||
env/
|
||||
venv/
|
||||
|
||||
# codecov / coverage
|
||||
.coverage
|
||||
cov_*
|
||||
|
||||
# due to using tox and pytest
|
||||
.tox
|
||||
.cache
|
||||
.pytest_cache/
|
||||
.python-version
|
||||
pip
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
sudo: false
|
||||
dist: trusty
|
||||
language: python
|
||||
python:
|
||||
- "2.7"
|
||||
- "3.4"
|
||||
- "3.5"
|
||||
- "3.6"
|
||||
install:
|
||||
- travis_retry pip install -r requirements.txt
|
||||
- travis_retry pip install flake8
|
||||
- travis_retry pip install -r test_requirements.txt
|
||||
script:
|
||||
- flake8 slackclient
|
||||
- py.test --cov-report= --cov=slackclient tests
|
||||
after_success:
|
||||
- codecov -e $TRAVIS_PYTHON_VERSION
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015-2016 Slack Technologies, Inc
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -0,0 +1 @@
|
|||
include LICENSE
|
||||
|
|
@ -0,0 +1,355 @@
|
|||
python-slackclient
|
||||
===================
|
||||
|
||||
A client for Slack, which supports the Slack Web API and Real Time Messaging (RTM) API.
|
||||
|
||||
|build-status| |windows-build-status| |codecov| |doc-status| |pypi-version| |python-version|
|
||||
|
||||
.. |build-status| image:: https://travis-ci.org/slackapi/python-slackclient.svg?branch=master
|
||||
:target: https://travis-ci.org/slackapi/python-slackclient
|
||||
.. |windows-build-status| image:: https://ci.appveyor.com/api/projects/status/rif04t60ptslj32x/branch/master?svg=true
|
||||
:target: https://ci.appveyor.com/project/slackapi/python-slackclient
|
||||
.. |codecov| image:: https://codecov.io/gh/slackapi/python-slackclient/branch/master/graph/badge.svg
|
||||
:target: https://codecov.io/gh/slackapi/python-slackclient
|
||||
.. |doc-status| image:: https://readthedocs.org/projects/python-slackclient/badge/?version=latest
|
||||
:target: http://python-slackclient.readthedocs.io/en/latest/?badge=latest
|
||||
.. |pypi-version| image:: https://badge.fury.io/py/slackclient.svg
|
||||
:target: https://pypi.python.org/pypi/slackclient
|
||||
.. |python-version| image:: https://img.shields.io/pypi/pyversions/slackclient.svg
|
||||
:target: https://pypi.python.org/pypi/slackclient
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
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.
|
||||
|
||||
Documentation
|
||||
***************
|
||||
|
||||
For comprehensive method information and usage examples, see the `full documentation <http://slackapi.github.io/python-slackclient>`_.
|
||||
|
||||
If you're building a project to receive content and events from Slack, check out the `Python Slack Events API Adapter <https://github.com/slackapi/python-slack-events-api/>`_ library.
|
||||
|
||||
You may also review our `Development Roadmap <https://github.com/slackapi/python-slackclient/wiki/Slack-Python-SDK-Roadmap>`_ in the project wiki.
|
||||
|
||||
|
||||
Requirements and Installation
|
||||
******************************
|
||||
|
||||
We recommend using `PyPI <https://pypi.python.org/pypi>`_ to install Slack Developer Kit for Python
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install slackclient
|
||||
|
||||
Of course, if you prefer doing things the hard way, you can always implement Slack Developer Kit for Python
|
||||
by pulling down the source code directly into your project:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/slackapi/python-slackclient.git
|
||||
pip install -r requirements.txt
|
||||
|
||||
Getting Help
|
||||
*************
|
||||
|
||||
If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:
|
||||
|
||||
- Use our `Github Issue Tracker <https://github.com/slackapi/python-slackclient/issues>`_ for reporting bugs or requesting features.
|
||||
- Visit the `Bot Developer Hangout <http://community.botkit.ai>`_ for getting help using Slack Developer Kit for Python or just generally bond with your fellow Slack developers.
|
||||
|
||||
Basic Usage
|
||||
------------
|
||||
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.
|
||||
|
||||
This package is a modular wrapper designed to make Slack `Web API <https://api.slack.com/web>`_ calls simpler and easier for your
|
||||
app. Provided below are examples of how to interact with commonly used API endpoints, but this is by no means
|
||||
a complete list. Review the full list of available methods `here <https://api.slack.com/methods>`_.
|
||||
|
||||
|
||||
Sending a message
|
||||
********************
|
||||
The primary use of Slack is sending messages. Whether you're sending a message
|
||||
to a user or to a channel, this method handles both.
|
||||
|
||||
To send a message to a channel, use the channel's ID. For IMs, use the user's ID.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:"
|
||||
)
|
||||
|
||||
There are some unique options specific to sending IMs, so be sure to read the **channels**
|
||||
section of the `chat.postMessage <https://api.slack.com/methods/chat.postMessage#channels>`_
|
||||
page for a full list of formatting and authorship options.
|
||||
|
||||
Sending an ephemeral message, which is only visible to an assigned user in a specified channel, is nearly the same
|
||||
as sending a regular message, but with an additional ``user`` parameter.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postEphemeral",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:",
|
||||
user="U0XXXXXXX"
|
||||
)
|
||||
|
||||
See `chat.postEphemeral <https://api.slack.com/methods/chat.postEphemeral>`_ for more info.
|
||||
|
||||
|
||||
Replying to messages and creating threads
|
||||
*****************************************
|
||||
Threaded messages are just like regular messages, except thread replies are grouped together to provide greater context
|
||||
to the user. You can reply to a thread or start a new threaded conversation by simply passing the original message's ``ts``
|
||||
ID in the ``thread_ts`` attribute when posting a message. If you're replying to a threaded message, you'll pass the `thread_ts`
|
||||
ID of the message you're replying to.
|
||||
|
||||
A channel or DM conversation is a nearly linear timeline of messages exchanged between people, bots, and apps.
|
||||
When one of these messages is replied to, it becomes the parent of a thread. By default, threaded replies do not
|
||||
appear directly in the channel, instead relegated to a kind of forked timeline descending from the parent message.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:",
|
||||
thread_ts="1476746830.000003"
|
||||
)
|
||||
|
||||
|
||||
By default, ``reply_broadcast`` is set to ``False``. To indicate your reply is germane to all members of a channel,
|
||||
set the ``reply_broadcast`` boolean parameter to ``True``.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:",
|
||||
thread_ts="1476746830.000003",
|
||||
reply_broadcast=True
|
||||
)
|
||||
|
||||
|
||||
**Note:** While threaded messages may contain attachments and message buttons, when your reply is broadcast to the
|
||||
channel, it'll actually be a reference to your reply, not the reply itself.
|
||||
So, when appearing in the channel, it won't contain any attachments or message buttons. Also note that updates and
|
||||
deletion of threaded replies works the same as regular messages.
|
||||
|
||||
See the `Threading messages together <https://api.slack.com/docs/message-threading#forking_conversations>`_
|
||||
article for more information.
|
||||
|
||||
|
||||
Deleting a message
|
||||
********************
|
||||
Sometimes you need to delete things.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.delete",
|
||||
channel="C0XXXXXX",
|
||||
ts="1476745373.000002"
|
||||
)
|
||||
|
||||
See `chat.delete <https://api.slack.com/methods/chat.delete>`_ for more info.
|
||||
|
||||
Adding or removing an emoji reaction
|
||||
****************************************
|
||||
You can quickly respond to any message on Slack with an emoji reaction. Reactions
|
||||
can be used for any purpose: voting, checking off to-do items, showing excitement — and just for fun.
|
||||
|
||||
This method adds a reaction (emoji) to an item (``file``, ``file comment``, ``channel message``, ``group message``, or ``direct message``). One of file, file_comment, or the combination of channel and timestamp must be specified.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"reactions.add",
|
||||
channel="C0XXXXXXX",
|
||||
name="thumbsup",
|
||||
timestamp="1234567890.123456"
|
||||
)
|
||||
|
||||
Removing an emoji reaction is basically the same format, but you'll use ``reactions.remove`` instead of ``reactions.add``
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"reactions.remove",
|
||||
channel="C0XXXXXXX",
|
||||
name="thumbsup",
|
||||
timestamp="1234567890.123456"
|
||||
)
|
||||
|
||||
|
||||
See `reactions.add <https://api.slack.com/methods/reactions.add>`_ and `reactions.remove <https://api.slack.com/methods/reactions.remove>`_ for more info.
|
||||
|
||||
Getting a list of channels
|
||||
******************************
|
||||
At some point, you'll want to find out what channels are available to your app. This is how you get that list.
|
||||
|
||||
**Note:** This call requires the ``channels:read`` scope.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call("channels.list")
|
||||
|
||||
Archived channels are included by default. You can exclude them by passing ``exclude_archived=1`` to your request.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"channels.list",
|
||||
exclude_archived=1
|
||||
)
|
||||
|
||||
See `channels.list <https://api.slack.com/methods/channels.list>`_ for more info.
|
||||
|
||||
Getting a channel's info
|
||||
*************************
|
||||
Once you have the ID for a specific channel, you can fetch information about that channel.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"channels.info",
|
||||
channel="C0XXXXXXX"
|
||||
)
|
||||
|
||||
See `channels.info <https://api.slack.com/methods/channels.info>`_ for more info.
|
||||
|
||||
Joining a channel
|
||||
********************
|
||||
Channels are the social hub of most Slack teams. Here's how you hop into one:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"channels.join",
|
||||
channel="C0XXXXXXY"
|
||||
)
|
||||
|
||||
If you are already in the channel, the response is slightly different.
|
||||
``already_in_channel`` will be true, and a limited ``channel`` object will be returned. Bot users cannot join a channel on their own, they need to be invited by another user.
|
||||
|
||||
See `channels.join <https://api.slack.com/methods/channels.join>`_ for more info.
|
||||
|
||||
Leaving a channel
|
||||
********************
|
||||
Maybe you've finished up all the business you had in a channel, or maybe you
|
||||
joined one by accident. This is how you leave a channel.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"channels.leave",
|
||||
channel="C0XXXXXXX"
|
||||
)
|
||||
|
||||
See `channels.leave <https://api.slack.com/methods/channels.leave>`_ for more info.
|
||||
|
||||
|
||||
Tokens and Authentication
|
||||
**************************
|
||||
|
||||
The simplest way to create an instance of the client, as shown in the samples above, is to use a bot (xoxb) access token:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# Get the access token from environmental variable
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
|
||||
The SlackClient library allows you to use a variety of Slack authentication tokens.
|
||||
|
||||
To take advantage of automatic token refresh, you'll need to instantiate the client a little differently than when using
|
||||
a bot access token. With a bot token, you have the access (xoxb) token when you create the client, when using refresh tokens,
|
||||
you won't know the access token when the client is created.
|
||||
|
||||
Upon the first request, the SlackClient will request a new access (xoxa) token on behalf of your application, using your app's
|
||||
refresh token, client ID, and client secret.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# Get the access token from environmental variable
|
||||
slack_refresh_token = os.environ["SLACK_REFRESH_TOKEN"]
|
||||
slack_client_id = os.environ["SLACK_CLIENT_ID"]
|
||||
slack_client_secret = os.environ["SLACK_CLIENT_SECRET"]
|
||||
|
||||
|
||||
Since your app's access tokens will be expiring and refreshed, the client requires a callback method to be passed in on creation of the client.
|
||||
Once Slack returns an access token for your app, the SlackClient will call your provided callback to update the access token in your datastore.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# This is where you'll add your data store update logic
|
||||
def token_update_callback(update_data):
|
||||
print("Enterprise ID: {}".format(update_data["enterprise_id"]))
|
||||
print("Workspace ID: {}".format(update_data["team_id"]))
|
||||
print("Access Token: {}".format(update_data["access_token"]))
|
||||
print("Access Token expires in (ms): {}".format(update_data["expires_in"]))
|
||||
|
||||
# When creating an instance of the client, pass the client details and token update callback
|
||||
sc = SlackClient(
|
||||
refresh_token=slack_refresh_token,
|
||||
client_id=slack_client_id,
|
||||
client_secret=slack_client_secret,
|
||||
token_update_callback=token_update_callback
|
||||
)
|
||||
|
||||
|
||||
Slack will send your callback function the **app's access token**, **token expiration TTL**, **team ID**, and **enterprise ID** (for enterprise workspaces)
|
||||
|
||||
|
||||
See `Tokens & Authentication <http://slackapi.github.io/python-slackclient/auth.html#handling-tokens>`_ for API token handling best practices.
|
||||
|
||||
|
||||
|
||||
Additional Information
|
||||
********************************************************************************************
|
||||
For comprehensive method information and usage examples, see the `full documentation`_.
|
||||
1
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs-src/.gitignore
vendored
Normal file
1
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs-src/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
_build
|
||||
|
|
@ -0,0 +1,225 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = ../docs/
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " epub3 to make an epub3"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
@echo " dummy to check syntax errors of document sources"
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
.PHONY: html
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
.PHONY: dirhtml
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
.PHONY: singlehtml
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
.PHONY: pickle
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
.PHONY: json
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
.PHONY: htmlhelp
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
.PHONY: qthelp
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-slackclient.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-slackclient.qhc"
|
||||
|
||||
.PHONY: applehelp
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
.PHONY: devhelp
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/python-slackclient"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-slackclient"
|
||||
@echo "# devhelp"
|
||||
|
||||
.PHONY: epub
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
.PHONY: epub3
|
||||
epub3:
|
||||
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
|
||||
@echo
|
||||
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
|
||||
|
||||
.PHONY: latex
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
.PHONY: latexpdf
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: latexpdfja
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: text
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
.PHONY: man
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
.PHONY: texinfo
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
.PHONY: info
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
.PHONY: gettext
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
.PHONY: changes
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
.PHONY: linkcheck
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
.PHONY: doctest
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
.PHONY: coverage
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
.PHONY: xml
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
.PHONY: pseudoxml
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
.PHONY: dummy
|
||||
dummy:
|
||||
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
|
||||
@echo
|
||||
@echo "Build finished. Dummy builder generates no files."
|
||||
|
|
@ -0,0 +1,342 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# python-slackclient documentation build configuration file, created by
|
||||
# sphinx-quickstart on Mon Jun 27 17:36:09 2016.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.coverage',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['../../_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Slack Developer Kit for Python'
|
||||
copyright = u'2015–2016 Slack Technologies, Inc. and contributors'
|
||||
author = u'Slack Technologies, Inc. and contributors'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'1.0.1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#
|
||||
# today = ''
|
||||
#
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'emacs'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "slack"
|
||||
html_theme_path = ["../../_themes", ]
|
||||
|
||||
highlight_language = "python"
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
# html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
# html_title = u'python-slackclient v1.0.1'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of
|
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['static']
|
||||
|
||||
html_context = {
|
||||
'css_files': ['static/pygments.css'],
|
||||
}
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#
|
||||
# html_extra_path = []
|
||||
|
||||
# If not None, a 'Last updated on:' timestamp is inserted at every page
|
||||
# bottom, using the given strftime format.
|
||||
# The empty string is equivalent to '%b %d, %Y'.
|
||||
#
|
||||
# html_last_updated_fmt = None
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#
|
||||
# html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#
|
||||
# html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Language to be used for generating the HTML full-text search index.
|
||||
# Sphinx supports the following languages:
|
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
|
||||
#
|
||||
# html_search_language = 'en'
|
||||
|
||||
# A dictionary with options for the search language support, empty by default.
|
||||
# 'ja' uses this config value.
|
||||
# 'zh' user can custom change `jieba` dictionary path.
|
||||
#
|
||||
# html_search_options = {'type': 'default'}
|
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that
|
||||
# implements a search results scorer. If empty, the default will be used.
|
||||
#
|
||||
# html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'python-slackclientdoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'python-slackclient.tex', u'python-slackclient Documentation',
|
||||
u'Ryan Huber, Jeff Ammons', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
|
||||
author, 'python-slackclient', 'A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#
|
||||
# texinfo_no_detailmenu = False
|
||||
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
|
||||
{{ metatags }}
|
||||
|
||||
{%- block htmltitle %}
|
||||
<title>{{ title|striptags|e + " — "|safe + project|e }}</title>
|
||||
{%- endblock %}
|
||||
|
||||
{%- macro css() %}
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="{{ pathto('./_static/' + 'default.css', 1) }}" type="text/css" />
|
||||
<link rel="stylesheet" href="{{ pathto('./_static/' + 'pygments.css', 1) }}" type="text/css" />
|
||||
<link rel="stylesheet" href="{{ pathto('./_static/' + 'docs.css', 1) }}" type="text/css" />
|
||||
{%- endmacro %}
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
{{ css() }}
|
||||
{%- block linktags %}
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto(master_doc) }}" />
|
||||
{%- endblock %}
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
|
||||
{%- block header %}
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">{{ project }}</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
{% endblock %}
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
{% block sidebar %}
|
||||
{% include 'sidebar.html' %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">{{ title }}</div>
|
||||
<div class="card">
|
||||
{%- block body %}
|
||||
{{ body }}
|
||||
{% endblock %}
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<h5>Table of Contents?</h5>
|
||||
<ul class="localtoc">
|
||||
{{ toc }}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
{#
|
||||
basic/relations.html
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Sphinx sidebar template: relation links.
|
||||
|
||||
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
:license: BSD, see LICENSE for details.
|
||||
#}
|
||||
{%- if prev %}
|
||||
<h4>{{ _('Previous topic') }}</h4>
|
||||
<p class="topless"><a href="{{ prev.link|e }}"
|
||||
title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<h4>{{ _('Next topic') }}</h4>
|
||||
<p class="topless"><a href="{{ next.link|e }}"
|
||||
title="{{ _('next chapter') }}">{{ next.title }}</a></p>
|
||||
{%- endif %}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
{{ toctree(maxdepth=-1, collapse=False,includehidden=True) }}
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
a.headerlink {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.section-title {
|
||||
font-size: 2rem;
|
||||
line-height: 2.5rem;
|
||||
letter-spacing: -1px;
|
||||
font-weight: 700;
|
||||
margin: 0 0 1rem;
|
||||
}
|
||||
|
||||
nav#api_nav .toctree-l1 {
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul {
|
||||
list-style: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l1>a {
|
||||
color: #1264a3;
|
||||
letter-spacing: 0;
|
||||
font-size: .8rem;
|
||||
font-weight: 800;
|
||||
text-transform: uppercase;
|
||||
border: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l2 {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l2 a {
|
||||
color: #1d1c1d;
|
||||
text-transform: none;
|
||||
font-weight: inherit;
|
||||
padding: 0;
|
||||
display: block;
|
||||
text-overflow: ellipsis;
|
||||
overflow: hidden;
|
||||
white-space: nowrap;
|
||||
font-size: 15px!important;
|
||||
line-height:15px;
|
||||
padding: 4px 8px;
|
||||
border: 1px solid transparent;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l2 a:hover {
|
||||
cursor: pointer;
|
||||
text-decoration: none;
|
||||
background-color:#e8f5fa;
|
||||
border-color:#dcf0fb;
|
||||
}
|
||||
|
||||
nav#api_nav #footer #footer_nav {
|
||||
font-size: .9375rem;
|
||||
}
|
||||
|
||||
nav#api_nav #footer #footer_nav a {
|
||||
border: none;
|
||||
padding: 0;
|
||||
color: #616061;
|
||||
}
|
||||
|
||||
nav#api_nav #footer #footer_nav a:hover {
|
||||
text-decoration: none;
|
||||
color: #1c1c1c;
|
||||
}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
/* Updates body font */
|
||||
body {
|
||||
font-family: Slack-Lato,appleLogo,sans-serif;
|
||||
}
|
||||
|
||||
/* Replaces old sidebar styled links */
|
||||
.sidebar_menu h5 {
|
||||
font-size: 0.8rem;
|
||||
font-weight: 800;
|
||||
margin-bottom: 3px;
|
||||
}
|
||||
|
||||
/* Aligns footer navigation to the left of the sidebar */
|
||||
.footer_nav {
|
||||
margin: 0 !important;
|
||||
}
|
||||
|
||||
/* Styles the signature all nice and pretty <3 */
|
||||
#footer_signature {
|
||||
color:#e01e5a;
|
||||
font-size:.9rem;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* Fixes link hover state */
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* Makes footer consistent */
|
||||
footer {
|
||||
background-color: transparent;
|
||||
border: 0;
|
||||
}
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #ffffff; }
|
||||
.highlight .c { color: #999988; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
|
||||
.highlight .k { font-weight: bold } /* Keyword */
|
||||
.highlight .o { font-weight: bold } /* Operator */
|
||||
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
|
||||
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
|
||||
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
||||
.highlight .gh { color: #999999 } /* Generic.Heading */
|
||||
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
|
||||
.highlight .go { color: #888888 } /* Generic.Output */
|
||||
.highlight .gp { color: #555555 } /* Generic.Prompt */
|
||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
|
||||
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
|
||||
.highlight .kc { font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
|
||||
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .m { color: #009999 } /* Literal.Number */
|
||||
.highlight .s { color: #bb8844 } /* Literal.String */
|
||||
.highlight .na { color: #008080 } /* Name.Attribute */
|
||||
.highlight .nb { color: #999999 } /* Name.Builtin */
|
||||
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #008080 } /* Name.Constant */
|
||||
.highlight .ni { color: #800080 } /* Name.Entity */
|
||||
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
||||
.highlight .nn { color: #555555 } /* Name.Namespace */
|
||||
.highlight .nt { color: #000080 } /* Name.Tag */
|
||||
.highlight .nv { color: #008080 } /* Name.Variable */
|
||||
.highlight .ow { font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
||||
.highlight .sb { color: #bb8844 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #bb8844 } /* Literal.String.Char */
|
||||
.highlight .sd { color: #bb8844 } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #bb8844 } /* Literal.String.Double */
|
||||
.highlight .se { color: #bb8844 } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #bb8844 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #bb8844 } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #bb8844 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #808000 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #bb8844 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #bb8844 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
||||
.highlight .vc { color: #008080 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #008080 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
|
||||
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
[theme]
|
||||
inherit = default
|
||||
stylesheet = default.css
|
||||
show_sphinx = False
|
||||
|
||||
[options]
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
==============================================
|
||||
About
|
||||
==============================================
|
||||
|
||||
|product_name|
|
||||
**************
|
||||
|
||||
|
||||
Access the Slack Platform from your Python app. |product_name| lets you build on the Slack Web APIs pythonically.
|
||||
|
||||
|product_name| is proudly maintained with 💖 by the Slack Developer Tools team
|
||||
|
||||
- `License`_
|
||||
- `Code of Conduct`_
|
||||
- `Contributing`_
|
||||
- `Contributor License Agreement`_
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,150 @@
|
|||
==============================================
|
||||
Tokens & Authentication
|
||||
==============================================
|
||||
.. _handling-tokens:
|
||||
|
||||
Handling tokens and other sensitive data
|
||||
----------------------------------------
|
||||
⚠️ **Slack tokens are the keys to your—or your customers’—data.Keep them secret. Keep them safe.**
|
||||
|
||||
One way to do that is to never explicitly hardcode them.
|
||||
|
||||
Try to avoid this when possible:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
token = 'xoxb-abc-1232'
|
||||
|
||||
⚠️ **Never share test tokens with other users or applications. Do not publish test tokens in public code repositories.**
|
||||
|
||||
We recommend you pass tokens in as environment variables, or persist them in a database that is accessed at runtime. You can add a token to the environment by starting your app as:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
SLACK_BOT_TOKEN="xoxb-abc-1232" python myapp.py
|
||||
|
||||
Then retrieve the key with:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
SLACK_BOT_TOKEN = os.environ["SLACK_BOT_TOKEN"]
|
||||
|
||||
You can use the same technique for other kinds of sensitive data that ne’er-do-wells could use in nefarious ways, including
|
||||
|
||||
- Incoming webhook URLs
|
||||
- Slash command verification tokens
|
||||
- App client ids and client secrets
|
||||
|
||||
For additional information, please see our `Safely Storing Credentials <https://api.slack.com/docs/oauth-safety>`_ page.
|
||||
|
||||
Single-Workspace Apps
|
||||
-----------------------
|
||||
If you're building an application for a single Slack workspace, there's no need to build out the entire OAuth flow.
|
||||
|
||||
Once you've setup your features, click on the **Install App to Team** button found on the **Install App** page.
|
||||
If you add new permission scopes or Slack app features after an app has been installed, you must reinstall the app to
|
||||
your workspace for changes to take effect.
|
||||
|
||||
For additional information, see the `Installing Apps <https://api.slack.com/slack-apps#installing_apps>`_ of our `Building Slack apps <https://api.slack.com/slack-apps#installing_apps>`_ page.
|
||||
|
||||
The OAuth flow
|
||||
-------------------------
|
||||
Authentication for Slack's APIs is done using OAuth, so you'll want to read up on `OAuth <https://api.slack.com/docs/oauth>`_.
|
||||
|
||||
In order to implement OAuth in your app, you will need to include a web server. In this example, we'll use `Flask <http://flask.pocoo.org/>`_.
|
||||
|
||||
As mentioned above, we're setting the app tokens and other configs in environment variables and pulling them into global variables.
|
||||
|
||||
Depending on what actions your app will need to perform, you'll need different OAuth permission scopes. Review the available scopes `here <https://api.slack.com/docs/oauth-scopes>`_.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import os
|
||||
from flask import Flask, request
|
||||
from slackclient import SlackClient
|
||||
|
||||
client_id = os.environ["SLACK_CLIENT_ID"]
|
||||
client_secret = os.environ["SLACK_CLIENT_SECRET"]
|
||||
oauth_scope = os.environ["SLACK_BOT_SCOPE"]
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
**The OAuth initiation link:**
|
||||
|
||||
To begin the OAuth flow, you'll need to provide the user with a link to Slack's OAuth page.
|
||||
This directs the user to Slack's OAuth acceptance page, where the user will review and accept
|
||||
or refuse the permissions your app is requesting as defined by the requested scope(s).
|
||||
|
||||
For the best user experience, use the `Add to Slack button <https://api.slack.com/docs/slack-button>`_ to direct users to approve your application for access or `Sign in with Slack <https://api.slack.com/docs/sign-in-with-slack>`_ to log users in.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@app.route("/begin_auth", methods=["GET"])
|
||||
def pre_install():
|
||||
return '''
|
||||
<a href="https://slack.com/oauth/authorize?scope={0}&client_id={1}">
|
||||
Add to Slack
|
||||
</a>
|
||||
'''.format(oauth_scope, client_id)
|
||||
|
||||
**The OAuth completion page**
|
||||
|
||||
Once the user has agreed to the permissions you've requested on Slack's OAuth
|
||||
page, Slack will redirect the user to your auth completion page. Included in this
|
||||
redirect is a ``code`` query string param which you’ll use to request access
|
||||
tokens from the ``oauth.access`` endpoint.
|
||||
|
||||
Generally, Web API requests require a valid OAuth token, but there are a few endpoints
|
||||
which do not require a token. ``oauth.access`` is one example of this. Since this
|
||||
is the endpoint you'll use to retrieve the tokens for later API requests,
|
||||
an empty string ``""`` is acceptable for this request.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@app.route("/finish_auth", methods=["GET", "POST"])
|
||||
def post_install():
|
||||
|
||||
# Retrieve the auth code from the request params
|
||||
auth_code = request.args['code']
|
||||
|
||||
# An empty string is a valid token for this request
|
||||
sc = SlackClient("")
|
||||
|
||||
# Request the auth tokens from Slack
|
||||
auth_response = sc.api_call(
|
||||
"oauth.access",
|
||||
client_id=client_id,
|
||||
client_secret=client_secret,
|
||||
code=auth_code
|
||||
)
|
||||
|
||||
A successful request to ``oauth.access`` will yield two tokens: A ``user``
|
||||
token and a ``bot`` token. The ``user`` token ``auth_response['access_token']``
|
||||
is used to make requests on behalf of the authorizing user and the ``bot``
|
||||
token ``auth_response['bot']['bot_access_token']`` is for making requests
|
||||
on behalf of your app's bot user.
|
||||
|
||||
If your Slack app includes a bot user, upon approval the JSON response will contain
|
||||
an additional node containing an access token to be specifically used for your bot
|
||||
user, within the context of the approving team.
|
||||
|
||||
When you use Web API methods on behalf of your bot user, you should use this bot
|
||||
user access token instead of the top-level access token granted to your application.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# Save the bot token to an environmental variable or to your data store
|
||||
# for later use
|
||||
os.environ["SLACK_USER_TOKEN"] = auth_response['access_token']
|
||||
os.environ["SLACK_BOT_TOKEN"] = auth_response['bot']['bot_access_token']
|
||||
|
||||
# Don't forget to let the user know that auth has succeeded!
|
||||
return "Auth complete!"
|
||||
|
||||
Once your user has completed the OAuth flow, you'll be able to use the provided
|
||||
tokens to make a variety of Web API calls on behalf of the user and your app's bot user.
|
||||
|
||||
See the :ref:`Web API usage <web-api-examples>` section of this documentation for usage examples.
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,435 @@
|
|||
.. _web-api-examples:
|
||||
|
||||
==============================================
|
||||
Basic Usage
|
||||
==============================================
|
||||
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.
|
||||
|
||||
This package is a modular wrapper designed to make Slack `Web API`_ calls simpler and easier for your
|
||||
app. Provided below are examples of how to interact with commonly used API endpoints, but this is by no means
|
||||
a complete list. Review the full list of available methods `here <https://api.slack.com/methods>`_.
|
||||
|
||||
See :ref:`Tokens & Authentication <handling-tokens>` for API token handling best practices.
|
||||
|
||||
--------
|
||||
|
||||
Sending a message
|
||||
-----------------------
|
||||
The primary use of Slack is sending messages. Whether you're sending a message
|
||||
to a user or to a channel, this method handles both.
|
||||
|
||||
To send a message to a channel, use the channel's ID. For IMs, use the user's ID.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:"
|
||||
)
|
||||
|
||||
There are some unique options specific to sending IMs, so be sure to read the **channels**
|
||||
section of the `chat.postMessage <https://api.slack.com/methods/chat.postMessage#channels>`_
|
||||
page for a full list of formatting and authorship options.
|
||||
|
||||
Sending an ephemeral message, which is only visible to an assigned user in a specified channel, is nearly the same
|
||||
as sending a regular message, but with an additional ``user`` parameter.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postEphemeral",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:",
|
||||
user="U0XXXXXXX"
|
||||
)
|
||||
|
||||
See `chat.postEphemeral <https://api.slack.com/methods/chat.postEphemeral>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Customizing a message's layout
|
||||
-----------------------
|
||||
The chat.postMessage method takes an optional blocks argument that allows you to customize the layout of a message.
|
||||
Blocks for Web API methods are all specified in a single object literal, so just add additional keys for any optional argument.
|
||||
|
||||
To send a message to a channel, use the channel's ID. For IMs, use the user's ID.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
blocks=[
|
||||
{
|
||||
"type": "section",
|
||||
"text": {
|
||||
"type": "mrkdwn",
|
||||
"text": "Danny Torrence left the following review for your property:"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "section",
|
||||
"text": {
|
||||
"type": "mrkdwn",
|
||||
"text": "<https://example.com|Overlook Hotel> \n :star: \n Doors had too many axe holes, guest in room " +
|
||||
"237 was far too rowdy, whole place felt stuck in the 1920s."
|
||||
},
|
||||
"accessory": {
|
||||
"type": "image",
|
||||
"image_url": "https://images.pexels.com/photos/750319/pexels-photo-750319.jpeg",
|
||||
"alt_text": "Haunted hotel image"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "section",
|
||||
"fields": [
|
||||
{
|
||||
"type": "mrkdwn",
|
||||
"text": "*Average Rating*\n1.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
)
|
||||
|
||||
**Note:** You can use the `Block Kit Builder <https://api.slack.com/tools/block-kit-builder>`for a playground where you can prototype your message's look and feel.
|
||||
|
||||
--------
|
||||
|
||||
Replying to messages and creating threads
|
||||
------------------------------------------
|
||||
Threaded messages are just like regular messages, except thread replies are grouped together to provide greater context
|
||||
to the user. You can reply to a thread or start a new threaded conversation by simply passing the original message's ``ts``
|
||||
ID in the ``thread_ts`` attribute when posting a message. If you're replying to a threaded message, you'll pass the `thread_ts`
|
||||
ID of the message you're replying to.
|
||||
|
||||
A channel or DM conversation is a nearly linear timeline of messages exchanged between people, bots, and apps.
|
||||
When one of these messages is replied to, it becomes the parent of a thread. By default, threaded replies do not
|
||||
appear directly in the channel, instead relegated to a kind of forked timeline descending from the parent message.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:",
|
||||
thread_ts="1476746830.000003"
|
||||
)
|
||||
|
||||
|
||||
By default, ``reply_broadcast`` is set to ``False``. To indicate your reply is germane to all members of a channel,
|
||||
set the ``reply_broadcast`` boolean parameter to ``True``.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:",
|
||||
thread_ts="1476746830.000003",
|
||||
reply_broadcast=True
|
||||
)
|
||||
|
||||
|
||||
**Note:** While threaded messages may contain attachments and message buttons, when your reply is broadcast to the
|
||||
channel, it'll actually be a reference to your reply, not the reply itself.
|
||||
So, when appearing in the channel, it won't contain any attachments or message buttons. Also note that updates and
|
||||
deletion of threaded replies works the same as regular messages.
|
||||
|
||||
See the `Threading messages together <https://api.slack.com/docs/message-threading#forking_conversations>`_
|
||||
article for more information.
|
||||
|
||||
|
||||
--------
|
||||
|
||||
Updating the content of a message
|
||||
----------------------------------
|
||||
Let's say you have a bot which posts the status of a request. When that request
|
||||
is updated, you'll want to update the message to reflect it's state. Or your user
|
||||
might want to fix a typo or change some wording. This is how you'll make those changes.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.update",
|
||||
ts="1476746830.000003",
|
||||
channel="C0XXXXXX",
|
||||
text="Hello from Python! :tada:"
|
||||
)
|
||||
|
||||
See `chat.update <https://api.slack.com/methods/chat.update>`_ for formatting options
|
||||
and some special considerations when calling this with a bot user.
|
||||
|
||||
--------
|
||||
|
||||
Deleting a message
|
||||
-------------------
|
||||
Sometimes you need to delete things.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"chat.delete",
|
||||
channel="C0XXXXXX",
|
||||
ts="1476745373.000002"
|
||||
)
|
||||
|
||||
See `chat.delete <https://api.slack.com/methods/chat.delete>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Adding or removing an emoji reaction
|
||||
---------------------------------------
|
||||
You can quickly respond to any message on Slack with an emoji reaction. Reactions
|
||||
can be used for any purpose: voting, checking off to-do items, showing excitement — and just for fun.
|
||||
|
||||
This method adds a reaction (emoji) to an item (``file``, ``file comment``, ``channel message``, ``group message``, or ``direct message``). One of file, file_comment, or the combination of channel and timestamp must be specified.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"reactions.add",
|
||||
channel="C0XXXXXXX",
|
||||
name="thumbsup",
|
||||
timestamp="1234567890.123456"
|
||||
)
|
||||
|
||||
Removing an emoji reaction is basically the same format, but you'll use ``reactions.remove`` instead of ``reactions.add``
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
sc.api_call(
|
||||
"reactions.remove",
|
||||
channel="C0XXXXXXX",
|
||||
name="thumbsup",
|
||||
timestamp="1234567890.123456"
|
||||
)
|
||||
|
||||
|
||||
See `reactions.add <https://api.slack.com/methods/reactions.add>`_ and `reactions.remove <https://api.slack.com/methods/reactions.remove>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Getting a list of channels
|
||||
---------------------------
|
||||
At some point, you'll want to find out what channels are available to your app. This is how you get that list.
|
||||
|
||||
**Note:** This call requires the ``channels:read`` scope.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call("channels.list")
|
||||
|
||||
Archived channels are included by default. You can exclude them by passing ``exclude_archived=1`` to your request.
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"channels.list",
|
||||
exclude_archived=1
|
||||
)
|
||||
|
||||
See `channels.list <https://api.slack.com/methods/channels.list>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Getting a channel's info
|
||||
-------------------------
|
||||
Once you have the ID for a specific channel, you can fetch information about that channel.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"channels.info",
|
||||
channel="C0XXXXXXX"
|
||||
)
|
||||
|
||||
See `channels.info <https://api.slack.com/methods/channels.info>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Joining a channel
|
||||
------------------
|
||||
Channels are the social hub of most Slack teams. Here's how you hop into one:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"channels.join",
|
||||
channel="C0XXXXXXY"
|
||||
)
|
||||
|
||||
If you are already in the channel, the response is slightly different.
|
||||
``already_in_channel`` will be true, and a limited ``channel`` object will be returned. Bot users cannot join a channel on their own, they need to be invited by another user.
|
||||
|
||||
See `channels.join <https://api.slack.com/methods/channels.join>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Leaving a channel
|
||||
------------------
|
||||
Maybe you've finished up all the business you had in a channel, or maybe you
|
||||
joined one by accident. This is how you leave a channel.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"channels.leave",
|
||||
channel="C0XXXXXXX"
|
||||
)
|
||||
|
||||
See `channels.leave <https://api.slack.com/methods/channels.leave>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Get a list of team members
|
||||
------------------------------
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call("users.list")
|
||||
|
||||
See `users.list <https://api.slack.com/methods/users.list>`_ for more info.
|
||||
|
||||
|
||||
--------
|
||||
|
||||
Uploading files
|
||||
------------------------------
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
with open('thinking_very_much.png') as file_content:
|
||||
sc.api_call(
|
||||
"files.upload",
|
||||
channels="C3UKJTQAC",
|
||||
file=file_content,
|
||||
title="Test upload"
|
||||
)
|
||||
|
||||
See `files.upload <https://api.slack.com/methods/files.upload>`_ for more info.
|
||||
|
||||
|
||||
--------
|
||||
|
||||
Web API Rate Limits
|
||||
--------------------
|
||||
Slack allows applications to send no more than one message per second. We allow bursts over that
|
||||
limit for short periods. However, if your app continues to exceed the limit over a longer period
|
||||
of time it will be rate limited.
|
||||
|
||||
Here's a very basic example of how one might deal with rate limited requests.
|
||||
|
||||
If you go over these limits, Slack will start returning a HTTP 429 Too Many Requests error,
|
||||
a JSON object containing the number of calls you have been making, and a Retry-After header
|
||||
containing the number of seconds until you can retry.
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
import time
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
# Simple wrapper for sending a Slack message
|
||||
def send_slack_message(channel, message):
|
||||
return sc.api_call(
|
||||
"chat.postMessage",
|
||||
channel=channel,
|
||||
text=message
|
||||
)
|
||||
|
||||
# Make the API call and save results to `response`
|
||||
response = send_slack_message("C0XXXXXX", "Hello, from Python!")
|
||||
|
||||
# Check to see if the message sent successfully.
|
||||
# If the message succeeded, `response["ok"]`` will be `True`
|
||||
if response["ok"]:
|
||||
print("Message posted successfully: " + response["message"]["ts"])
|
||||
# If the message failed, check for rate limit headers in the response
|
||||
elif response["ok"] is False and response["headers"]["Retry-After"]:
|
||||
# The `Retry-After` header will tell you how long to wait before retrying
|
||||
delay = int(response["headers"]["Retry-After"])
|
||||
print("Rate limited. Retrying in " + str(delay) + " seconds")
|
||||
time.sleep(delay)
|
||||
send_slack_message(message, channel)
|
||||
|
||||
See the documentation on `Rate Limiting <https://api.slack.com/docs/rate-limits>`_ for more info.
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
||||
|
|
@ -0,0 +1,156 @@
|
|||
==============================================
|
||||
Changelog
|
||||
==============================================
|
||||
|
||||
v1.3.2 (2019-05-30)
|
||||
-------------------
|
||||
- Fixing an issue where reconnects used rtm.start istead of rtm.connect. #422
|
||||
|
||||
|
||||
v1.3.1 (2019-02-28)
|
||||
-------------------
|
||||
|
||||
- Lock websocket-client version to < 0.55.0: temp fix for #385
|
||||
|
||||
|
||||
v1.3.0 (2018-09-11)
|
||||
-------------------
|
||||
|
||||
## New Features
|
||||
- Adds support for short lived tokens and automatic token refresh #347 (Thanks @roach!)
|
||||
|
||||
## Other
|
||||
- update RTM rate limiting comment and error message #308 (Thanks @benoitlavigne!)
|
||||
- Use logging instead of traceback #309 (Thanks @harlowja!)
|
||||
- Remove Python 3.3 from test environments #346 (Thanks @roach!)
|
||||
- Enforced linting when using VSCode. #347 (Thanks @roach!)
|
||||
|
||||
|
||||
v1.2.1 (2018-03-26)
|
||||
-------------------
|
||||
|
||||
- Added rate limit handling for rtm connections (thanks @jayalane!)
|
||||
|
||||
|
||||
v1.2.0 (2018-03-20)
|
||||
-------------------
|
||||
|
||||
- You can now tell the RTM client to automatically reconnect by passing `auto_reconnect=True`
|
||||
|
||||
v1.1.3 (2018-03-01)
|
||||
-------------------
|
||||
|
||||
- Fixed another API param encoding bug. It encodes things properly now.
|
||||
|
||||
v1.1.2 (2018-01-31)
|
||||
-------------------
|
||||
|
||||
- Fixed an encoding issue which was encoding some Web API params incorrectly (sorry)
|
||||
|
||||
v1.1.1 (2018-01-30)
|
||||
-------------------
|
||||
|
||||
- Adds HTTP response headers to `api_call` responses to expose things like rate limit info
|
||||
- Moves `token` into auth header rather than request params
|
||||
|
||||
v1.1.0 (2017-11-21)
|
||||
-------------------
|
||||
|
||||
- Aadds new SlackClientError and ResponseParseError types to describe errors - thanks @aoberoi!
|
||||
- Fix Build Error (#245) - thanks @stasfilin!
|
||||
- include email as user property (#173) - thanks @acaire!
|
||||
- Add http reply into slack login and slack connection error (#216) - thanks @harlowja!
|
||||
- Removed unused exception class (#233)
|
||||
- Fix rtm_send_message bug (#225) - thanks @kt5356!
|
||||
- Allow use of custom parameters on rtm_connect() (#210) - thanks @kamushadenes!
|
||||
- Fix link to rtm.connect docs (#223) - @sampart!
|
||||
|
||||
v1.0.9 (2017-08-31)
|
||||
-------------------
|
||||
|
||||
- Fixed rtm_send_message ID bug introduced in 1.0.8
|
||||
|
||||
v1.0.8 (2017-08-31)
|
||||
-------------------
|
||||
|
||||
- Added rtm.connect support
|
||||
|
||||
v1.0.7 (2017-08-02)
|
||||
-------------------
|
||||
|
||||
- Fixes an issue where connecting over RTM to large teams may result in “Websocket URL expired” errors
|
||||
- A load of packaging improvements
|
||||
|
||||
v1.0.6 (2017-06-12)
|
||||
-------------------
|
||||
|
||||
- Added proxy support (thanks @timfeirg!)
|
||||
- Tidied up docs (thanks @schlueter!)
|
||||
- Added tox settings for Python 3 testing (thanks @cclauss!)
|
||||
|
||||
v1.0.5 (2017-01-23)
|
||||
-------------------
|
||||
|
||||
- Allow RTM Channel.send_message to reply to a thread
|
||||
- Index users by ID instead of Name (non-breaking change)
|
||||
- Added timeout to api calls.
|
||||
- Fixed a typo about token access in auth.rst, thanks @kelvintaywl!
|
||||
- Added Message Threads to the docs
|
||||
|
||||
v1.0.4 (2016-12-15)
|
||||
-------------------
|
||||
|
||||
- fixed the ability to search for a user by ID
|
||||
|
||||
v1.0.3 (2016-12-13)
|
||||
-------------------
|
||||
|
||||
- fixed an issue causing RTM connections to fail for large teams
|
||||
|
||||
v1.0.2 (2016-09-22)
|
||||
-------------------
|
||||
|
||||
- removed unused ping counter
|
||||
- fixed contributor guidelines links
|
||||
- updated documentation
|
||||
- Fix bug preventing API calls requiring a file ID
|
||||
- Removes files from api_calls before JSON encoding, so the request is properly formatted
|
||||
|
||||
v1.0.1 (2016-03-25)
|
||||
-------------------
|
||||
|
||||
- fix for __eq__ comparison in channels using '#' in channel name
|
||||
- added copyright info to the LICENSE file
|
||||
|
||||
v1.0.0 (2016-02-28)
|
||||
-------------------
|
||||
|
||||
- the ``api_call`` function now returns a decoded JSON object, rather than a JSON encoded string
|
||||
- some ``api_call`` calls now call actions on the parent server object:
|
||||
- ``im.open``
|
||||
- ``mpim.open``, ``groups.create``, ``groups.createChild``
|
||||
- ``channels.create``, `channels.join``
|
||||
|
||||
v0.18.0 (2016-02-21)
|
||||
--------------------
|
||||
|
||||
- Moves to use semver for versioning
|
||||
- Adds support for private groups and MPDMs
|
||||
- Switches to use requests instead of urllib
|
||||
- Gets Travis CI integration working
|
||||
- Fixes some formatting issues so the code will work for python 2.6
|
||||
- Cleans up some unused imports, some PEP-8 fixes and a couple bad default args fixes
|
||||
|
||||
v0.17.0 (2016-02-15)
|
||||
--------------------
|
||||
|
||||
- Fixes the server so that it doesn't add duplicate users or channels to its internal lists, https://github.com/slackapi/python-slackclient/commit/0cb4bcd6e887b428e27e8059b6278b86ee661aaa
|
||||
- README updates:
|
||||
- Updates the URLs pointing to Slack docs for configuring authentication, https://github.com/slackapi/python-slackclient/commit/7d01515cebc80918a29100b0e4793790eb83e7b9
|
||||
- s/channnels/channels, https://github.com/slackapi/python-slackclient/commit/d45285d2f1025899dcd65e259624ee73771f94bb
|
||||
- Adds users to the local cache when they join the team, https://github.com/slackapi/python-slackclient/commit/f7bb8889580cc34471ba1ddc05afc34d1a5efa23
|
||||
- Fixes urllib py 2/3 compatibility, https://github.com/slackapi/python-slackclient/commit/1046cc2375a85a22e94573e2aad954ba7287c886
|
||||
|
||||
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,338 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# python-slackclient documentation build configuration file, created by
|
||||
# sphinx-quickstart on Mon Jun 27 17:36:09 2016.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.coverage',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'python-slackclient'
|
||||
copyright = u'2016, Ryan Huber, Jeff Ammons'
|
||||
author = u'Ryan Huber, Jeff Ammons'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'1.0.1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#
|
||||
# today = ''
|
||||
#
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
import sphinx_rtd_theme # noqa
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
# html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
# html_title = u'python-slackclient v1.0.1'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of
|
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#
|
||||
# html_extra_path = []
|
||||
|
||||
# If not None, a 'Last updated on:' timestamp is inserted at every page
|
||||
# bottom, using the given strftime format.
|
||||
# The empty string is equivalent to '%b %d, %Y'.
|
||||
#
|
||||
# html_last_updated_fmt = None
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#
|
||||
# html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#
|
||||
# html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Language to be used for generating the HTML full-text search index.
|
||||
# Sphinx supports the following languages:
|
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
|
||||
#
|
||||
# html_search_language = 'en'
|
||||
|
||||
# A dictionary with options for the search language support, empty by default.
|
||||
# 'ja' uses this config value.
|
||||
# 'zh' user can custom change `jieba` dictionary path.
|
||||
#
|
||||
# html_search_options = {'type': 'default'}
|
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that
|
||||
# implements a search results scorer. If empty, the default will be used.
|
||||
#
|
||||
# html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'python-slackclientdoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'python-slackclient.tex', u'python-slackclient Documentation',
|
||||
u'Ryan Huber, Jeff Ammons', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
|
||||
author, 'python-slackclient', 'A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#
|
||||
# texinfo_no_detailmenu = False
|
||||
|
|
@ -0,0 +1,166 @@
|
|||
.. _conversations_api:
|
||||
|
||||
==============================================
|
||||
Conversations API
|
||||
==============================================
|
||||
The Slack Conversations API provides your app with a unified interface to work with all the
|
||||
channel-like things encountered in Slack; public channels, private channels, direct messages, group
|
||||
direct messages, and our newest channel type, Shared Channels.
|
||||
|
||||
|
||||
See `Conversations API <https://api.slack.com/docs/conversations-api>`_ docs for more info.
|
||||
|
||||
--------
|
||||
|
||||
Creating a direct message or multi-person direct message
|
||||
---------------------------------------------------------
|
||||
This Conversations API method opens a multi-person direct message or just a 1:1 direct message.
|
||||
|
||||
*Use conversations.create for public or private channels.*
|
||||
|
||||
Provide 1 to 8 user IDs in the ``user`` parameter to open or resume a conversation. Providing only
|
||||
1 ID will create a direct message. Providing more will create an ``mpim``.
|
||||
|
||||
If there are no conversations already in progress including that exact set of members, a new
|
||||
multi-person direct message conversation begins.
|
||||
|
||||
Subsequent calls to ``conversations.open`` with the same set of users will return the already
|
||||
existing conversation.
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"conversations.open",
|
||||
users=["W1234567890","U2345678901","U3456789012"]
|
||||
)
|
||||
|
||||
See `conversations.open <https://api.slack.com/methods/conversations.open>`_ additional info.
|
||||
|
||||
--------
|
||||
|
||||
Creating a public or private channel
|
||||
-------------------------------------
|
||||
Initiates a public or private channel-based conversation
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"conversations.create",
|
||||
name="myprivatechannel",
|
||||
is_private=True
|
||||
)
|
||||
|
||||
See `conversations.create <https://api.slack.com/methods/conversations.create>`_ additional info.
|
||||
|
||||
--------
|
||||
|
||||
Getting information about a conversation
|
||||
-----------------------------------------
|
||||
This Conversations API method returns information about a workspace conversation.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"conversations.info",
|
||||
channel="C0XXXXXX",
|
||||
)
|
||||
|
||||
See `conversations.info <https://api.slack.com/methods/conversations.info>`_ for more info.
|
||||
|
||||
|
||||
--------
|
||||
|
||||
Getting a list of conversations
|
||||
--------------------------------
|
||||
This Conversations API method returns a list of all channel-like conversations in a workspace.
|
||||
The "channels" returned depend on what the calling token has access to and the directives placed
|
||||
in the ``types`` parameter.
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call("conversations.list")
|
||||
|
||||
Only public conversations are included by default. You may include additional conversations types
|
||||
by passing ``types`` (as a string) into your list request. Additional conversation types include
|
||||
``public_channel`` and ``private_channel``.
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
# Note that `types` is a string
|
||||
sc.api_call(
|
||||
"conversations.list",
|
||||
types="public_channel, private_channel"
|
||||
)
|
||||
|
||||
See `conversations.list <https://api.slack.com/methods/conversations.list>`_ for more info.
|
||||
|
||||
|
||||
--------
|
||||
|
||||
Leaving a conversation
|
||||
-----------------------
|
||||
Maybe you've finished up all the business you had in a conversation, or maybe you
|
||||
joined one by accident. This is how you leave a conversation.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call(
|
||||
"conversations.leave",
|
||||
channel="C0XXXXXXX"
|
||||
)
|
||||
|
||||
See `conversations.leave <https://api.slack.com/methods/conversations.leave>`_ for more info.
|
||||
|
||||
--------
|
||||
|
||||
Get conversation members
|
||||
------------------------------
|
||||
Get a list fo the members of a conversation
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.api_call("conversations.members",
|
||||
channel="C0XXXXXXX"
|
||||
)
|
||||
|
||||
See `users.list <https://api.slack.com/methods/conversations.members>`_ for more info.
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
==============================================
|
||||
Frequently Asked Questions
|
||||
==============================================
|
||||
|
||||
What even is |product_name| and why should I care?
|
||||
**************************************************
|
||||
|
||||
|product_name| is a wrapper around commonly accessed parts of the Slack Platform. It provides basic mechanisms for
|
||||
using the Slack Web API from within your Python app.
|
||||
|
||||
On the other hand, |product_name| does not provide access to the Events bot-building API, but
|
||||
[this adapter](https://github.com/slackapi/python-slack-events-api) does.
|
||||
|
||||
OMG I found a bug!
|
||||
******************
|
||||
|
||||
Well, poop. Take a deep breath, and then let us know on the `Issue Tracker`_. If you're feeling particularly ambitious,
|
||||
why not submit a `pull request`_ with a bug fix?
|
||||
|
||||
Hey, there's a feature missing!
|
||||
*******************************
|
||||
|
||||
There's always something more that could be added! You can let us know in the `Issue Tracker`_ to start a discussion
|
||||
around the proposed feature, that's a good start. If you're feeling particularly ambitious, why not write the feature
|
||||
yourself, and submit a `pull request`_! We love feedback and we love help and we don't bite. Much.
|
||||
|
||||
I'd like to contribute...but how?
|
||||
*********************************
|
||||
|
||||
What an excellent question. First of all, please have a look at our general `contributing guidelines`_. We'll wait for
|
||||
you here.
|
||||
|
||||
All done? Great! While we're super excited to incorporate your new feature into |product_name|, there are a
|
||||
couple of things we want to make sure you've given thought to.
|
||||
|
||||
- Please write unit tests for your new code. But don't **just** aim to increase the test coverage, rather, we expect you
|
||||
to have written **thoughtful** tests that ensure your new feature will continue to work as expected, and to help future
|
||||
contributors to ensure they don't break it!
|
||||
|
||||
- Please document your new feature. Think about **concrete use cases** for your feature, and add a section to the
|
||||
appropriate document, including a **complete** sample program that demonstrates your feature. Don't forget to update
|
||||
the changelog in ``changelog.rst``!
|
||||
|
||||
Including these two items with your pull request will totally make our day—and, more importantly, your future users' days!
|
||||
|
||||
On that note...
|
||||
|
||||
How do I compile the documentation?
|
||||
***********************************
|
||||
|
||||
This project's documentation is generated with `Sphinx <http://www.sphinx-doc.org>`_. If you are editing one of the many
|
||||
reStructuredText files in the ``docs-src`` folder, you'll need to rebuild the documentation. It is recommended to run
|
||||
the following steps inside a ``virtualenv`` environment.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
tox -e docs
|
||||
|
||||
|
||||
Do be sure to add the ``docs`` folder and its contents to your pull request!
|
||||
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
self
|
||||
auth
|
||||
basic_usage
|
||||
conversations
|
||||
real_time_messaging
|
||||
faq
|
||||
changelog
|
||||
about
|
||||
|
||||
==============================================
|
||||
|product_name|
|
||||
==============================================
|
||||
|
||||
Whether you're building a custom app for your team, or integrating a third party
|
||||
service into your Slack workflows, |product_name| allows you to leverage the flexibility
|
||||
of Python to get your project up and running as quickly as possible.
|
||||
|
||||
Requirements and Installation
|
||||
******************************
|
||||
|
||||
We recommend using `PyPI <https://pypi.python.org/pypi>`_ to install |product_name|
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install slackclient
|
||||
|
||||
Of course, if you prefer doing things the hard way, you can always implement |product_name|
|
||||
by pulling down the source code directly into your project:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/slackapi/python-slackclient.git
|
||||
pip install -r requirements.txt
|
||||
|
||||
Getting Help
|
||||
************
|
||||
|
||||
If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:
|
||||
|
||||
- Use our `Github Issue Tracker <https://github.com/slackapi/python-slackclient/issues>`_ for reporting bugs or requesting features.
|
||||
- Visit the `Bot Developer Hangout <http://community.botkit.ai>`_ for getting help using |product_name| or just generally bond with your fellow Slack developers.
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,281 @@
|
|||
@ECHO OFF
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set BUILDDIR=_build
|
||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
|
||||
set I18NSPHINXOPTS=%SPHINXOPTS% .
|
||||
if NOT "%PAPER%" == "" (
|
||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
||||
)
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
if "%1" == "help" (
|
||||
:help
|
||||
echo.Please use `make ^<target^>` where ^<target^> is one of
|
||||
echo. html to make standalone HTML files
|
||||
echo. dirhtml to make HTML files named index.html in directories
|
||||
echo. singlehtml to make a single large HTML file
|
||||
echo. pickle to make pickle files
|
||||
echo. json to make JSON files
|
||||
echo. htmlhelp to make HTML files and a HTML help project
|
||||
echo. qthelp to make HTML files and a qthelp project
|
||||
echo. devhelp to make HTML files and a Devhelp project
|
||||
echo. epub to make an epub
|
||||
echo. epub3 to make an epub3
|
||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||
echo. text to make text files
|
||||
echo. man to make manual pages
|
||||
echo. texinfo to make Texinfo files
|
||||
echo. gettext to make PO message catalogs
|
||||
echo. changes to make an overview over all changed/added/deprecated items
|
||||
echo. xml to make Docutils-native XML files
|
||||
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
||||
echo. linkcheck to check all external links for integrity
|
||||
echo. doctest to run all doctests embedded in the documentation if enabled
|
||||
echo. coverage to run coverage check of the documentation if enabled
|
||||
echo. dummy to check syntax errors of document sources
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "clean" (
|
||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
||||
del /q /s %BUILDDIR%\*
|
||||
goto end
|
||||
)
|
||||
|
||||
|
||||
REM Check if sphinx-build is available and fallback to Python version if any
|
||||
%SPHINXBUILD% 1>NUL 2>NUL
|
||||
if errorlevel 9009 goto sphinx_python
|
||||
goto sphinx_ok
|
||||
|
||||
:sphinx_python
|
||||
|
||||
set SPHINXBUILD=python -m sphinx.__init__
|
||||
%SPHINXBUILD% 2> nul
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:sphinx_ok
|
||||
|
||||
|
||||
if "%1" == "html" (
|
||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dirhtml" (
|
||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "singlehtml" (
|
||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pickle" (
|
||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the pickle files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "json" (
|
||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the JSON files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "htmlhelp" (
|
||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run HTML Help Workshop with the ^
|
||||
.hhp project file in %BUILDDIR%/htmlhelp.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "qthelp" (
|
||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-slackclient.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-slackclient.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "devhelp" (
|
||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub" (
|
||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub3" (
|
||||
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latex" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdf" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdfja" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf-ja
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "text" (
|
||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The text files are in %BUILDDIR%/text.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "man" (
|
||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "texinfo" (
|
||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "gettext" (
|
||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "changes" (
|
||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.The overview file is in %BUILDDIR%/changes.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "linkcheck" (
|
||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Link check complete; look for any errors in the above output ^
|
||||
or in %BUILDDIR%/linkcheck/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "doctest" (
|
||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of doctests in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/doctest/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "coverage" (
|
||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of coverage in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/coverage/python.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "xml" (
|
||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pseudoxml" (
|
||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dummy" (
|
||||
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. Dummy builder generates no files.
|
||||
goto end
|
||||
)
|
||||
|
||||
:end
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
.. Site settings
|
||||
.. |product_name| replace:: Slack Developer Kit for Python
|
||||
.. |email| replace:: opensource@slack.com
|
||||
.. |repo_name| replace:: python-slackclient
|
||||
.. |github_username| replace:: SlackAPI
|
||||
.. |twitter_username| replace:: SlackAPI
|
||||
|
||||
.. _Bot Developer Hangout: https://dev4slack.slack.com/archives/sdk-python-slackclient
|
||||
.. _Issue Tracker: http://github.com/SlackAPI/python-slackclient/issues
|
||||
.. _pull request: http://github.com/SlackAPI/python-slackclient/pulls
|
||||
.. _Python RTMBot: https://slackapi.github.io/python-rtmbot
|
||||
.. _License: https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE
|
||||
.. _Code of Conduct: https://slackhq.github.io/code-of-conduct
|
||||
.. _Contributing: https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md
|
||||
.. _contributing guidelines: https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md
|
||||
.. _Contributor License Agreement: https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform
|
||||
.. _Real Time Messaging (RTM) API: https://api.slack.com/rtm
|
||||
.. _Web API: https://api.slack.com/web
|
||||
|
||||
|
|
@ -0,0 +1,130 @@
|
|||
.. _real-time-messaging:
|
||||
|
||||
==============================================
|
||||
Real Time Messaging (RTM)
|
||||
==============================================
|
||||
The `Real Time Messaging (RTM) API`_ is a WebSocket-based API that allows you to
|
||||
receive events from Slack in real time and send messages as users.
|
||||
|
||||
If you prefer events to be pushed to you instead, we recommend using the
|
||||
HTTP-based `Events API <https://api.slack.com/events-api>`_ instead.
|
||||
Most event types supported by the RTM API are also available
|
||||
in `the Events API <https://api.slack.com/events/api>`_.
|
||||
|
||||
See :ref:`Tokens & Authentication <handling-tokens>` for API token handling best practices.
|
||||
|
||||
Connecting to the RTM API
|
||||
------------------------------------------
|
||||
::
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
if sc.rtm_connect():
|
||||
while sc.server.connected is True:
|
||||
print sc.rtm_read()
|
||||
time.sleep(1)
|
||||
else:
|
||||
print "Connection Failed"
|
||||
|
||||
If you connect successfully the first event received will be a hello:
|
||||
::
|
||||
|
||||
{
|
||||
u'type': u'hello'
|
||||
}
|
||||
|
||||
If there was a problem connecting an error will be returned, including a descriptive error message:
|
||||
::
|
||||
|
||||
{
|
||||
u'type': u'error',
|
||||
u'error': {
|
||||
u'code': 1,
|
||||
u'msg': u'Socket URL has expired'
|
||||
}
|
||||
}
|
||||
|
||||
rtm.start vs rtm.connect
|
||||
---------------------------
|
||||
|
||||
If you expect your app to be used on large teams, we recommend starting the RTM client with `rtm.connect` rather than the default connection method for this client, `rtm.start`.
|
||||
`rtm.connect` provides a lighter initial connection payload, without the team's channel and user information included. You'll need to request channel and user info via
|
||||
the Web API separately.
|
||||
|
||||
To do this, simply pass `with_team_state=False` into the `rtm_connect` call, like so:
|
||||
::
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
if sc.rtm_connect(with_team_state=False):
|
||||
while True:
|
||||
print sc.rtm_read()
|
||||
time.sleep(1)
|
||||
else:
|
||||
print "Connection Failed"
|
||||
|
||||
|
||||
Passing `auto_reconnect=True` will tell the websocket client to automatically reconnect if the connection gets dropped.
|
||||
|
||||
|
||||
See the `rtm.start docs <https://api.slack.com/methods/rtm.start>`_ and the `rtm.connect docs <https://api.slack.com/methods/rtm.connect>`_
|
||||
for more details.
|
||||
|
||||
|
||||
RTM Events
|
||||
-------------
|
||||
::
|
||||
|
||||
{
|
||||
u'type': u'message',
|
||||
u'ts': u'1358878749.000002',
|
||||
u'user': u'U023BECGF',
|
||||
u'text': u'Hello'
|
||||
}
|
||||
|
||||
See `RTM Events <https://api.slack.com/rtm#events>`_ for a complete list of events.
|
||||
|
||||
Sending messages via the RTM API
|
||||
---------------------------------
|
||||
You can send a message to Slack by sending JSON over the websocket connection.
|
||||
|
||||
::
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.rtm_send_message("welcome-test", "test")
|
||||
|
||||
You can send a message to a private group or direct message channel in the same
|
||||
way, but using a Group ID (``C024BE91L``) or DM channel ID (``D024BE91L``).
|
||||
|
||||
You can send a message in reply to a thread using the ``thread`` argument, and
|
||||
optionally broadcast that message back to the channel by setting
|
||||
``reply_broadcast`` to ``True``.
|
||||
|
||||
::
|
||||
|
||||
from slackclient import SlackClient
|
||||
|
||||
slack_token = os.environ["SLACK_API_TOKEN"]
|
||||
sc = SlackClient(slack_token)
|
||||
|
||||
sc.rtm_send_message("welcome-test", "test", "1482960137.003543", True)
|
||||
|
||||
See `Threading messages <https://api.slack.com/docs/message-threading#threads_party>`_
|
||||
for more details on using threads.
|
||||
|
||||
The RTM API only supports posting messages with `basic formatting <https://api.slack.com/docs/message-formatting>`_.
|
||||
It does not support attachments or other message formatting modes.
|
||||
|
||||
To post a more complex message as a user, see :ref:`Web API usage <web-api-examples>`.
|
||||
|
||||
.. include:: metadata.rst
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
sphinx-build -c ./docs-src/_themes/slack/ -b html docs-src docs && touch ./docs/.nojekyll
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 6abbc33d255b00e789666fcb765fbf2d
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/ajax-loader.gif
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/ajax-loader.gif
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 673 B |
676
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/basic.css
vendored
Normal file
676
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/basic.css
vendored
Normal file
|
|
@ -0,0 +1,676 @@
|
|||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox form.search {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
float: left;
|
||||
width: 80%;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
float: left;
|
||||
width: 20%;
|
||||
border-left: none;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
table.indextable > tbody > tr > td > ul {
|
||||
padding-left: 0em;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- domain module index --------------------------------------------------- */
|
||||
|
||||
table.modindextable td {
|
||||
padding: 2px;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body {
|
||||
min-width: 450px;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px 7px 0 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px 7px 0 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition dl {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- hlist styles ---------------------------------------------------------- */
|
||||
|
||||
table.hlist td {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
div.code-block-caption + div > div.highlight > pre {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: relative;
|
||||
left: 0px;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
div.math:hover a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
261
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/classic.css
vendored
Normal file
261
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/classic.css
vendored
Normal file
|
|
@ -0,0 +1,261 @@
|
|||
/*
|
||||
* classic.css_t
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- classic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: sans-serif;
|
||||
font-size: 100%;
|
||||
background-color: #11303d;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
background-color: #1c4e63;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 230px;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #000000;
|
||||
padding: 0 20px 30px 20px;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
color: #ffffff;
|
||||
width: 100%;
|
||||
padding: 9px 0 9px 0;
|
||||
text-align: center;
|
||||
font-size: 75%;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #ffffff;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.related {
|
||||
background-color: #133f52;
|
||||
line-height: 30px;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.related a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.4em;
|
||||
font-weight: normal;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.3em;
|
||||
font-weight: normal;
|
||||
margin: 5px 0 0 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.topless {
|
||||
margin: 5px 10px 10px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px;
|
||||
padding: 0;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #98dbcc;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* -- hyperlink styles ------------------------------------------------------ */
|
||||
|
||||
a {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:visited {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
background-color: #f2f2f2;
|
||||
font-weight: normal;
|
||||
color: #20435c;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin: 20px -20px 10px -20px;
|
||||
padding: 3px 0 3px 10px;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; font-size: 200%; }
|
||||
div.body h2 { font-size: 160%; }
|
||||
div.body h3 { font-size: 140%; }
|
||||
div.body h4 { font-size: 120%; }
|
||||
div.body h5 { font-size: 110%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #c60f0f;
|
||||
font-size: 0.8em;
|
||||
padding: 0 4px 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
background-color: #c60f0f;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
text-align: justify;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title + p {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.admonition p {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.admonition pre {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.admonition ul, div.admonition ol {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
background-color: #ffe4e4;
|
||||
border: 1px solid #f66;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 5px;
|
||||
background-color: #eeffcc;
|
||||
color: #333333;
|
||||
line-height: 120%;
|
||||
border: 1px solid #ac9;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: #ecf0f3;
|
||||
padding: 0 1px 0 1px;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
th {
|
||||
background-color: #ede;
|
||||
}
|
||||
|
||||
.warning code {
|
||||
background: #efc2c2;
|
||||
}
|
||||
|
||||
.note code {
|
||||
background: #d6d6d6;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
background-color: #f4debf;
|
||||
border-top: 1px solid #ac9;
|
||||
border-bottom: 1px solid #ac9;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
color: #efefef;
|
||||
background-color: #1c4e63;
|
||||
}
|
||||
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/comment-bright.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/comment-bright.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 756 B |
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/comment-close.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/comment-close.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 829 B |
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/comment.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/comment.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 641 B |
74
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/default.css
vendored
Normal file
74
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/default.css
vendored
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
a.headerlink {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.section-title {
|
||||
font-size: 2rem;
|
||||
line-height: 2.5rem;
|
||||
letter-spacing: -1px;
|
||||
font-weight: 700;
|
||||
margin: 0 0 1rem;
|
||||
}
|
||||
|
||||
nav#api_nav .toctree-l1 {
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul {
|
||||
list-style: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l1>a {
|
||||
color: #1264a3;
|
||||
letter-spacing: 0;
|
||||
font-size: .8rem;
|
||||
font-weight: 800;
|
||||
text-transform: uppercase;
|
||||
border: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l2 {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l2 a {
|
||||
color: #1d1c1d;
|
||||
text-transform: none;
|
||||
font-weight: inherit;
|
||||
padding: 0;
|
||||
display: block;
|
||||
text-overflow: ellipsis;
|
||||
overflow: hidden;
|
||||
white-space: nowrap;
|
||||
font-size: 15px!important;
|
||||
line-height:15px;
|
||||
padding: 4px 8px;
|
||||
border: 1px solid transparent;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
nav#api_nav #api_sections ul li.toctree-l2 a:hover {
|
||||
cursor: pointer;
|
||||
text-decoration: none;
|
||||
background-color:#e8f5fa;
|
||||
border-color:#dcf0fb;
|
||||
}
|
||||
|
||||
nav#api_nav #footer #footer_nav {
|
||||
font-size: .9375rem;
|
||||
}
|
||||
|
||||
nav#api_nav #footer #footer_nav a {
|
||||
border: none;
|
||||
padding: 0;
|
||||
color: #616061;
|
||||
}
|
||||
|
||||
nav#api_nav #footer #footer_nav a:hover {
|
||||
text-decoration: none;
|
||||
color: #1c1c1c;
|
||||
}
|
||||
34
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/docs.css
vendored
Normal file
34
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/docs.css
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
/* Updates body font */
|
||||
body {
|
||||
font-family: Slack-Lato,appleLogo,sans-serif;
|
||||
}
|
||||
|
||||
/* Replaces old sidebar styled links */
|
||||
.sidebar_menu h5 {
|
||||
font-size: 0.8rem;
|
||||
font-weight: 800;
|
||||
margin-bottom: 3px;
|
||||
}
|
||||
|
||||
/* Aligns footer navigation to the left of the sidebar */
|
||||
.footer_nav {
|
||||
margin: 0 !important;
|
||||
}
|
||||
|
||||
/* Styles the signature all nice and pretty <3 */
|
||||
#footer_signature {
|
||||
color:#e01e5a;
|
||||
font-size:.9rem;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* Fixes link hover state */
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* Makes footer consistent */
|
||||
footer {
|
||||
background-color: transparent;
|
||||
border: 0;
|
||||
}
|
||||
315
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/doctools.js
vendored
Normal file
315
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/doctools.js
vendored
Normal file
|
|
@ -0,0 +1,315 @@
|
|||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||
"profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {};
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 &&
|
||||
!jQuery(node.parentNode).hasClass(className) &&
|
||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var bbox = span.getBBox();
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
var parentOfText = node.parentNode.parentNode;
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
||||
this.initOnKeyListeners();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated === 'undefined')
|
||||
return string;
|
||||
return (typeof translated === 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated === 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
if (!body.length) {
|
||||
body = $('body');
|
||||
}
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
}, 10);
|
||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||
.appendTo($('#searchbox'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the domain index toggle buttons
|
||||
*/
|
||||
initIndexTable : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) === 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('#searchbox .highlight-link').fadeOut(300);
|
||||
$('span.highlighted').removeClass('highlighted');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this === '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keyup(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box or textarea
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
if (prevHref) {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
10
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/documentation_options.js
vendored
Normal file
10
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/documentation_options.js
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '1.0.1',
|
||||
LANGUAGE: 'None',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
};
|
||||
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/down-pressed.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/down-pressed.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 222 B |
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/down.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/down.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 B |
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/file.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/file.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 286 B |
10253
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/jquery-3.2.1.js
vendored
Normal file
10253
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/jquery-3.2.1.js
vendored
Normal file
File diff suppressed because it is too large
Load diff
4
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/jquery.js
vendored
Normal file
4
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/jquery.js
vendored
Normal file
File diff suppressed because one or more lines are too long
297
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/language_data.js
vendored
Normal file
297
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/language_data.js
vendored
Normal file
|
|
@ -0,0 +1,297 @@
|
|||
/*
|
||||
* language_data.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||
var i, j, start, end;
|
||||
for (i = 0; i < singles.length; i++) {
|
||||
result[singles[i]] = true;
|
||||
}
|
||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||
for (i = 0; i < ranges.length; i++) {
|
||||
start = ranges[i][0];
|
||||
end = ranges[i][1];
|
||||
for (j = start; j <= end; j++) {
|
||||
result[j] = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
})();
|
||||
|
||||
function splitQuery(query) {
|
||||
var result = [];
|
||||
var start = -1;
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
if (splitChars[query.charCodeAt(i)]) {
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start, i));
|
||||
start = -1;
|
||||
}
|
||||
} else if (start === -1) {
|
||||
start = i;
|
||||
}
|
||||
}
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/minus.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/minus.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/plus.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/plus.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
60
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/pygments.css
vendored
Normal file
60
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/pygments.css
vendored
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #ffffff; }
|
||||
.highlight .c { color: #999988; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
|
||||
.highlight .k { font-weight: bold } /* Keyword */
|
||||
.highlight .o { font-weight: bold } /* Operator */
|
||||
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
|
||||
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
|
||||
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
||||
.highlight .gh { color: #999999 } /* Generic.Heading */
|
||||
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
|
||||
.highlight .go { color: #888888 } /* Generic.Output */
|
||||
.highlight .gp { color: #555555 } /* Generic.Prompt */
|
||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
|
||||
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
|
||||
.highlight .kc { font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
|
||||
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .m { color: #009999 } /* Literal.Number */
|
||||
.highlight .s { color: #bb8844 } /* Literal.String */
|
||||
.highlight .na { color: #008080 } /* Name.Attribute */
|
||||
.highlight .nb { color: #999999 } /* Name.Builtin */
|
||||
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #008080 } /* Name.Constant */
|
||||
.highlight .ni { color: #800080 } /* Name.Entity */
|
||||
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
||||
.highlight .nn { color: #555555 } /* Name.Namespace */
|
||||
.highlight .nt { color: #000080 } /* Name.Tag */
|
||||
.highlight .nv { color: #008080 } /* Name.Variable */
|
||||
.highlight .ow { font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
||||
.highlight .sb { color: #bb8844 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #bb8844 } /* Literal.String.Char */
|
||||
.highlight .sd { color: #bb8844 } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #bb8844 } /* Literal.String.Double */
|
||||
.highlight .se { color: #bb8844 } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #bb8844 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #bb8844 } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #bb8844 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #808000 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #bb8844 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #bb8844 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
||||
.highlight .vc { color: #008080 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #008080 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
|
||||
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
||||
481
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/searchtools.js
vendored
Normal file
481
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/searchtools.js
vendored
Normal file
|
|
@ -0,0 +1,481 @@
|
|||
/*
|
||||
* searchtools.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
if (!Scorer) {
|
||||
/**
|
||||
* Simple result scoring code.
|
||||
*/
|
||||
var Scorer = {
|
||||
// Implement the following function to further tweak the score for each result
|
||||
// The function takes a result array [filename, title, anchor, descr, score]
|
||||
// and returns the new score.
|
||||
/*
|
||||
score: function(result) {
|
||||
return result[4];
|
||||
},
|
||||
*/
|
||||
|
||||
// query matches the full name of an object
|
||||
objNameMatch: 11,
|
||||
// or matches in the last dotted part of the object name
|
||||
objPartialMatch: 6,
|
||||
// Additive scores depending on the priority of the object
|
||||
objPrio: {0: 15, // used to be importantResults
|
||||
1: 5, // used to be objectResults
|
||||
2: -5}, // used to be unimportantResults
|
||||
// Used when the priority is not in the mapping.
|
||||
objPrioDefault: 0,
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
// query found in terms
|
||||
term: 5
|
||||
};
|
||||
}
|
||||
|
||||
if (!splitQuery) {
|
||||
function splitQuery(query) {
|
||||
return query.split(/\s+/);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
var Search = {
|
||||
|
||||
_index : null,
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
var query = params.q[0];
|
||||
$('input[name="q"]')[0].value = query;
|
||||
this.performSearch(query);
|
||||
}
|
||||
},
|
||||
|
||||
loadIndex : function(url) {
|
||||
$.ajax({type: "GET", url: url, data: null,
|
||||
dataType: "script", cache: true,
|
||||
complete: function(jqxhr, textstatus) {
|
||||
if (textstatus != "success") {
|
||||
document.getElementById("searchindexloader").src = url;
|
||||
}
|
||||
}});
|
||||
},
|
||||
|
||||
setIndex : function(index) {
|
||||
var q;
|
||||
this._index = index;
|
||||
if ((q = this._queued_query) !== null) {
|
||||
this._queued_query = null;
|
||||
Search.query(q);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex : function() {
|
||||
return this._index !== null;
|
||||
},
|
||||
|
||||
deferQuery : function(query) {
|
||||
this._queued_query = query;
|
||||
},
|
||||
|
||||
stopPulse : function() {
|
||||
this._pulse_status = 0;
|
||||
},
|
||||
|
||||
startPulse : function() {
|
||||
if (this._pulse_status >= 0)
|
||||
return;
|
||||
function pulse() {
|
||||
var i;
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
var dotString = '';
|
||||
for (i = 0; i < Search._pulse_status; i++)
|
||||
dotString += '.';
|
||||
Search.dots.text(dotString);
|
||||
if (Search._pulse_status > -1)
|
||||
window.setTimeout(pulse, 500);
|
||||
}
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something (or wait until index is loaded)
|
||||
*/
|
||||
performSearch : function(query) {
|
||||
// create the required interface elements
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
this.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (this.hasIndex())
|
||||
this.query(query);
|
||||
else
|
||||
this.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query : function(query) {
|
||||
var i;
|
||||
|
||||
// stem the searchterms and add them to the correct list
|
||||
var stemmer = new Stemmer();
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = splitQuery(query);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
|
||||
tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
// stem the word
|
||||
var word = stemmer.stemWord(tmp[i].toLowerCase());
|
||||
// prevent stemmer from cutting word smaller than two chars
|
||||
if(word.length < 3 && tmp[i].length >= 3) {
|
||||
word = tmp[i];
|
||||
}
|
||||
var toAppend;
|
||||
// select the correct list
|
||||
if (word[0] == '-') {
|
||||
toAppend = excluded;
|
||||
word = word.substr(1);
|
||||
}
|
||||
else {
|
||||
toAppend = searchterms;
|
||||
hlterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
// only add if not already in the list
|
||||
if (!$u.contains(toAppend, word))
|
||||
toAppend.push(word);
|
||||
}
|
||||
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||
|
||||
// console.debug('SEARCH: searching for:');
|
||||
// console.info('required: ', searchterms);
|
||||
// console.info('excluded: ', excluded);
|
||||
|
||||
// prepare search
|
||||
var terms = this._index.terms;
|
||||
var titleterms = this._index.titleterms;
|
||||
|
||||
// array of [filename, title, anchor, descr, score]
|
||||
var results = [];
|
||||
$('#search-progress').empty();
|
||||
|
||||
// lookup as object
|
||||
for (i = 0; i < objectterms.length; i++) {
|
||||
var others = [].concat(objectterms.slice(0, i),
|
||||
objectterms.slice(i+1, objectterms.length));
|
||||
results = results.concat(this.performObjectSearch(objectterms[i], others));
|
||||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
for (i = 0; i < results.length; i++)
|
||||
results[i][4] = Scorer.score(results[i]);
|
||||
}
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort(function(a, b) {
|
||||
var left = a[4];
|
||||
var right = b[4];
|
||||
if (left > right) {
|
||||
return 1;
|
||||
} else if (left < right) {
|
||||
return -1;
|
||||
} else {
|
||||
// same score: sort alphabetically
|
||||
left = a[1].toLowerCase();
|
||||
right = b[1].toLowerCase();
|
||||
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||
}
|
||||
});
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
//console.info('search results:', Search.lastresults);
|
||||
|
||||
// print the results
|
||||
var resultCount = results.length;
|
||||
function displayNextItem() {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
dirname = dirname.substring(0, dirname.length-6);
|
||||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
} else {
|
||||
// normal html builders
|
||||
listItem.append($('<a/>').attr('href',
|
||||
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
}
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
||||
if (suffix === undefined) {
|
||||
suffix = '.txt';
|
||||
}
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else {
|
||||
Search.stopPulse();
|
||||
Search.title.text(_('Search Results'));
|
||||
if (!resultCount)
|
||||
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||
else
|
||||
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||
Search.status.fadeIn(500);
|
||||
}
|
||||
}
|
||||
displayNextItem();
|
||||
},
|
||||
|
||||
/**
|
||||
* search for object names
|
||||
*/
|
||||
performObjectSearch : function(object, otherterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var docnames = this._index.docnames;
|
||||
var objects = this._index.objects;
|
||||
var objnames = this._index.objnames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i;
|
||||
var results = [];
|
||||
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullname.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullname == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
score += Scorer.objPartialMatch;
|
||||
}
|
||||
var match = objects[prefix][name];
|
||||
var objname = objnames[match[1]][2];
|
||||
var title = titles[match[0]];
|
||||
// If more than one term searched for, we require other words to be
|
||||
// found in the name/title/description
|
||||
if (otherterms.length > 0) {
|
||||
var haystack = (prefix + ' ' + name + ' ' +
|
||||
objname + ' ' + title).toLowerCase();
|
||||
var allfound = true;
|
||||
for (i = 0; i < otherterms.length; i++) {
|
||||
if (haystack.indexOf(otherterms[i]) == -1) {
|
||||
allfound = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!allfound) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
var descr = objname + _(', in ') + title;
|
||||
|
||||
var anchor = match[3];
|
||||
if (anchor === '')
|
||||
anchor = fullname;
|
||||
else if (anchor == '-')
|
||||
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||
// add custom score for some objects according to scorer
|
||||
if (Scorer.objPrio.hasOwnProperty(match[2])) {
|
||||
score += Scorer.objPrio[match[2]];
|
||||
} else {
|
||||
score += Scorer.objPrioDefault;
|
||||
}
|
||||
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||
var docnames = this._index.docnames;
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file;
|
||||
var fileMap = {};
|
||||
var scoreMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
var files = [];
|
||||
var _o = [
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
break;
|
||||
}
|
||||
// found search word in contents
|
||||
$u.each(_o, function(o) {
|
||||
var _files = o.files;
|
||||
if (_files === undefined)
|
||||
return
|
||||
|
||||
if (_files.length === undefined)
|
||||
_files = [_files];
|
||||
files = files.concat(_files);
|
||||
|
||||
// set score for the word in each file to Scorer.term
|
||||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {}
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
}
|
||||
}
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
for (file in fileMap) {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
titleterms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file) ||
|
||||
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
// select one (max) score for the file.
|
||||
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
var i = textLower.indexOf(this.toLowerCase());
|
||||
if (i > -1)
|
||||
start = i;
|
||||
});
|
||||
start = Math.max(start - 120, 0);
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
return rv;
|
||||
}
|
||||
};
|
||||
|
||||
$(document).ready(function() {
|
||||
Search.init();
|
||||
});
|
||||
159
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/sidebar.js
vendored
Normal file
159
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/sidebar.js
vendored
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
/*
|
||||
* sidebar.js
|
||||
* ~~~~~~~~~~
|
||||
*
|
||||
* This script makes the Sphinx sidebar collapsible.
|
||||
*
|
||||
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
|
||||
* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
|
||||
* used to collapse and expand the sidebar.
|
||||
*
|
||||
* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
|
||||
* and the width of the sidebar and the margin-left of the document
|
||||
* are decreased. When the sidebar is expanded the opposite happens.
|
||||
* This script saves a per-browser/per-session cookie used to
|
||||
* remember the position of the sidebar among the pages.
|
||||
* Once the browser is closed the cookie is deleted and the position
|
||||
* reset to the default (expanded).
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
$(function() {
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
// global elements used by the functions.
|
||||
// the 'sidebarbutton' element is defined as global after its
|
||||
// creation, in the add_sidebar_button function
|
||||
var bodywrapper = $('.bodywrapper');
|
||||
var sidebar = $('.sphinxsidebar');
|
||||
var sidebarwrapper = $('.sphinxsidebarwrapper');
|
||||
|
||||
// for some reason, the document has no sidebar; do not run into errors
|
||||
if (!sidebar.length) return;
|
||||
|
||||
// original margin-left of the bodywrapper and width of the sidebar
|
||||
// with the sidebar expanded
|
||||
var bw_margin_expanded = bodywrapper.css('margin-left');
|
||||
var ssb_width_expanded = sidebar.width();
|
||||
|
||||
// margin-left of the bodywrapper and width of the sidebar
|
||||
// with the sidebar collapsed
|
||||
var bw_margin_collapsed = '.8em';
|
||||
var ssb_width_collapsed = '.8em';
|
||||
|
||||
// colors used by the current theme
|
||||
var dark_color = $('.related').css('background-color');
|
||||
var light_color = $('.document').css('background-color');
|
||||
|
||||
function sidebar_is_collapsed() {
|
||||
return sidebarwrapper.is(':not(:visible)');
|
||||
}
|
||||
|
||||
function toggle_sidebar() {
|
||||
if (sidebar_is_collapsed())
|
||||
expand_sidebar();
|
||||
else
|
||||
collapse_sidebar();
|
||||
}
|
||||
|
||||
function collapse_sidebar() {
|
||||
sidebarwrapper.hide();
|
||||
sidebar.css('width', ssb_width_collapsed);
|
||||
bodywrapper.css('margin-left', bw_margin_collapsed);
|
||||
sidebarbutton.css({
|
||||
'margin-left': '0',
|
||||
'height': bodywrapper.height()
|
||||
});
|
||||
sidebarbutton.find('span').text('»');
|
||||
sidebarbutton.attr('title', _('Expand sidebar'));
|
||||
document.cookie = 'sidebar=collapsed';
|
||||
}
|
||||
|
||||
function expand_sidebar() {
|
||||
bodywrapper.css('margin-left', bw_margin_expanded);
|
||||
sidebar.css('width', ssb_width_expanded);
|
||||
sidebarwrapper.show();
|
||||
sidebarbutton.css({
|
||||
'margin-left': ssb_width_expanded-12,
|
||||
'height': bodywrapper.height()
|
||||
});
|
||||
sidebarbutton.find('span').text('«');
|
||||
sidebarbutton.attr('title', _('Collapse sidebar'));
|
||||
document.cookie = 'sidebar=expanded';
|
||||
}
|
||||
|
||||
function add_sidebar_button() {
|
||||
sidebarwrapper.css({
|
||||
'float': 'left',
|
||||
'margin-right': '0',
|
||||
'width': ssb_width_expanded - 28
|
||||
});
|
||||
// create the button
|
||||
sidebar.append(
|
||||
'<div id="sidebarbutton"><span>«</span></div>'
|
||||
);
|
||||
var sidebarbutton = $('#sidebarbutton');
|
||||
light_color = sidebarbutton.css('background-color');
|
||||
// find the height of the viewport to center the '<<' in the page
|
||||
var viewport_height;
|
||||
if (window.innerHeight)
|
||||
viewport_height = window.innerHeight;
|
||||
else
|
||||
viewport_height = $(window).height();
|
||||
sidebarbutton.find('span').css({
|
||||
'display': 'block',
|
||||
'margin-top': (viewport_height - sidebar.position().top - 20) / 2
|
||||
});
|
||||
|
||||
sidebarbutton.click(toggle_sidebar);
|
||||
sidebarbutton.attr('title', _('Collapse sidebar'));
|
||||
sidebarbutton.css({
|
||||
'color': '#FFFFFF',
|
||||
'border-left': '1px solid ' + dark_color,
|
||||
'font-size': '1.2em',
|
||||
'cursor': 'pointer',
|
||||
'height': bodywrapper.height(),
|
||||
'padding-top': '1px',
|
||||
'margin-left': ssb_width_expanded - 12
|
||||
});
|
||||
|
||||
sidebarbutton.hover(
|
||||
function () {
|
||||
$(this).css('background-color', dark_color);
|
||||
},
|
||||
function () {
|
||||
$(this).css('background-color', light_color);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
function set_position_from_cookie() {
|
||||
if (!document.cookie)
|
||||
return;
|
||||
var items = document.cookie.split(';');
|
||||
for(var k=0; k<items.length; k++) {
|
||||
var key_val = items[k].split('=');
|
||||
var key = key_val[0].replace(/ /, ""); // strip leading spaces
|
||||
if (key == 'sidebar') {
|
||||
var value = key_val[1];
|
||||
if ((value == 'collapsed') && (!sidebar_is_collapsed()))
|
||||
collapse_sidebar();
|
||||
else if ((value == 'expanded') && (sidebar_is_collapsed()))
|
||||
expand_sidebar();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
add_sidebar_button();
|
||||
var sidebarbutton = $('#sidebarbutton');
|
||||
set_position_from_cookie();
|
||||
});
|
||||
999
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/underscore-1.3.1.js
vendored
Normal file
999
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/underscore-1.3.1.js
vendored
Normal file
|
|
@ -0,0 +1,999 @@
|
|||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
|
||||
(function() {
|
||||
|
||||
// Baseline setup
|
||||
// --------------
|
||||
|
||||
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||
var root = this;
|
||||
|
||||
// Save the previous value of the `_` variable.
|
||||
var previousUnderscore = root._;
|
||||
|
||||
// Establish the object that gets returned to break out of a loop iteration.
|
||||
var breaker = {};
|
||||
|
||||
// Save bytes in the minified (but not gzipped) version:
|
||||
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||
|
||||
// Create quick reference variables for speed access to core prototypes.
|
||||
var slice = ArrayProto.slice,
|
||||
unshift = ArrayProto.unshift,
|
||||
toString = ObjProto.toString,
|
||||
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||
|
||||
// All **ECMAScript 5** native function implementations that we hope to use
|
||||
// are declared here.
|
||||
var
|
||||
nativeForEach = ArrayProto.forEach,
|
||||
nativeMap = ArrayProto.map,
|
||||
nativeReduce = ArrayProto.reduce,
|
||||
nativeReduceRight = ArrayProto.reduceRight,
|
||||
nativeFilter = ArrayProto.filter,
|
||||
nativeEvery = ArrayProto.every,
|
||||
nativeSome = ArrayProto.some,
|
||||
nativeIndexOf = ArrayProto.indexOf,
|
||||
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||
nativeIsArray = Array.isArray,
|
||||
nativeKeys = Object.keys,
|
||||
nativeBind = FuncProto.bind;
|
||||
|
||||
// Create a safe reference to the Underscore object for use below.
|
||||
var _ = function(obj) { return new wrapper(obj); };
|
||||
|
||||
// Export the Underscore object for **Node.js**, with
|
||||
// backwards-compatibility for the old `require()` API. If we're in
|
||||
// the browser, add `_` as a global object via a string identifier,
|
||||
// for Closure Compiler "advanced" mode.
|
||||
if (typeof exports !== 'undefined') {
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
exports = module.exports = _;
|
||||
}
|
||||
exports._ = _;
|
||||
} else {
|
||||
root['_'] = _;
|
||||
}
|
||||
|
||||
// Current version.
|
||||
_.VERSION = '1.3.1';
|
||||
|
||||
// Collection Functions
|
||||
// --------------------
|
||||
|
||||
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||
if (obj == null) return;
|
||||
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||
obj.forEach(iterator, context);
|
||||
} else if (obj.length === +obj.length) {
|
||||
for (var i = 0, l = obj.length; i < l; i++) {
|
||||
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||
}
|
||||
} else {
|
||||
for (var key in obj) {
|
||||
if (_.has(obj, key)) {
|
||||
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Return the results of applying the iterator to each element.
|
||||
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||
_.map = _.collect = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
results[results.length] = iterator.call(context, value, index, list);
|
||||
});
|
||||
if (obj.length === +obj.length) results.length = obj.length;
|
||||
return results;
|
||||
};
|
||||
|
||||
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||
}
|
||||
each(obj, function(value, index, list) {
|
||||
if (!initial) {
|
||||
memo = value;
|
||||
initial = true;
|
||||
} else {
|
||||
memo = iterator.call(context, memo, value, index, list);
|
||||
}
|
||||
});
|
||||
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||
return memo;
|
||||
};
|
||||
|
||||
// The right-associative version of reduce, also known as `foldr`.
|
||||
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||
}
|
||||
var reversed = _.toArray(obj).reverse();
|
||||
if (context && !initial) iterator = _.bind(iterator, context);
|
||||
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||
};
|
||||
|
||||
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||
_.find = _.detect = function(obj, iterator, context) {
|
||||
var result;
|
||||
any(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) {
|
||||
result = value;
|
||||
return true;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Return all the elements that pass a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||
// Aliased as `select`.
|
||||
_.filter = _.select = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Return all the elements for which a truth test fails.
|
||||
_.reject = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
each(obj, function(value, index, list) {
|
||||
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Determine whether all of the elements match a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||
// Aliased as `all`.
|
||||
_.every = _.all = function(obj, iterator, context) {
|
||||
var result = true;
|
||||
if (obj == null) return result;
|
||||
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Determine if at least one element in the object matches a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||
// Aliased as `any`.
|
||||
var any = _.some = _.any = function(obj, iterator, context) {
|
||||
iterator || (iterator = _.identity);
|
||||
var result = false;
|
||||
if (obj == null) return result;
|
||||
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return !!result;
|
||||
};
|
||||
|
||||
// Determine if a given value is included in the array or object using `===`.
|
||||
// Aliased as `contains`.
|
||||
_.include = _.contains = function(obj, target) {
|
||||
var found = false;
|
||||
if (obj == null) return found;
|
||||
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||
found = any(obj, function(value) {
|
||||
return value === target;
|
||||
});
|
||||
return found;
|
||||
};
|
||||
|
||||
// Invoke a method (with arguments) on every item in a collection.
|
||||
_.invoke = function(obj, method) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return _.map(obj, function(value) {
|
||||
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||
});
|
||||
};
|
||||
|
||||
// Convenience version of a common use case of `map`: fetching a property.
|
||||
_.pluck = function(obj, key) {
|
||||
return _.map(obj, function(value){ return value[key]; });
|
||||
};
|
||||
|
||||
// Return the maximum element or (element-based computation).
|
||||
_.max = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||
var result = {computed : -Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed >= result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Return the minimum element (or element-based computation).
|
||||
_.min = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||
var result = {computed : Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed < result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Shuffle an array.
|
||||
_.shuffle = function(obj) {
|
||||
var shuffled = [], rand;
|
||||
each(obj, function(value, index, list) {
|
||||
if (index == 0) {
|
||||
shuffled[0] = value;
|
||||
} else {
|
||||
rand = Math.floor(Math.random() * (index + 1));
|
||||
shuffled[index] = shuffled[rand];
|
||||
shuffled[rand] = value;
|
||||
}
|
||||
});
|
||||
return shuffled;
|
||||
};
|
||||
|
||||
// Sort the object's values by a criterion produced by an iterator.
|
||||
_.sortBy = function(obj, iterator, context) {
|
||||
return _.pluck(_.map(obj, function(value, index, list) {
|
||||
return {
|
||||
value : value,
|
||||
criteria : iterator.call(context, value, index, list)
|
||||
};
|
||||
}).sort(function(left, right) {
|
||||
var a = left.criteria, b = right.criteria;
|
||||
return a < b ? -1 : a > b ? 1 : 0;
|
||||
}), 'value');
|
||||
};
|
||||
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
_.groupBy = function(obj, val) {
|
||||
var result = {};
|
||||
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||
each(obj, function(value, index) {
|
||||
var key = iterator(value, index);
|
||||
(result[key] || (result[key] = [])).push(value);
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Use a comparator function to figure out at what index an object should
|
||||
// be inserted so as to maintain order. Uses binary search.
|
||||
_.sortedIndex = function(array, obj, iterator) {
|
||||
iterator || (iterator = _.identity);
|
||||
var low = 0, high = array.length;
|
||||
while (low < high) {
|
||||
var mid = (low + high) >> 1;
|
||||
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||
}
|
||||
return low;
|
||||
};
|
||||
|
||||
// Safely convert anything iterable into a real, live array.
|
||||
_.toArray = function(iterable) {
|
||||
if (!iterable) return [];
|
||||
if (iterable.toArray) return iterable.toArray();
|
||||
if (_.isArray(iterable)) return slice.call(iterable);
|
||||
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||
return _.values(iterable);
|
||||
};
|
||||
|
||||
// Return the number of elements in an object.
|
||||
_.size = function(obj) {
|
||||
return _.toArray(obj).length;
|
||||
};
|
||||
|
||||
// Array Functions
|
||||
// ---------------
|
||||
|
||||
// Get the first element of an array. Passing **n** will return the first N
|
||||
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||
// with `_.map`.
|
||||
_.first = _.head = function(array, n, guard) {
|
||||
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||
};
|
||||
|
||||
// Returns everything but the last entry of the array. Especcialy useful on
|
||||
// the arguments object. Passing **n** will return all the values in
|
||||
// the array, excluding the last N. The **guard** check allows it to work with
|
||||
// `_.map`.
|
||||
_.initial = function(array, n, guard) {
|
||||
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||
};
|
||||
|
||||
// Get the last element of an array. Passing **n** will return the last N
|
||||
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||
_.last = function(array, n, guard) {
|
||||
if ((n != null) && !guard) {
|
||||
return slice.call(array, Math.max(array.length - n, 0));
|
||||
} else {
|
||||
return array[array.length - 1];
|
||||
}
|
||||
};
|
||||
|
||||
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||
// Especially useful on the arguments object. Passing an **index** will return
|
||||
// the rest of the values in the array from that index onward. The **guard**
|
||||
// check allows it to work with `_.map`.
|
||||
_.rest = _.tail = function(array, index, guard) {
|
||||
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||
};
|
||||
|
||||
// Trim out all falsy values from an array.
|
||||
_.compact = function(array) {
|
||||
return _.filter(array, function(value){ return !!value; });
|
||||
};
|
||||
|
||||
// Return a completely flattened version of an array.
|
||||
_.flatten = function(array, shallow) {
|
||||
return _.reduce(array, function(memo, value) {
|
||||
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||
memo[memo.length] = value;
|
||||
return memo;
|
||||
}, []);
|
||||
};
|
||||
|
||||
// Return a version of the array that does not contain the specified value(s).
|
||||
_.without = function(array) {
|
||||
return _.difference(array, slice.call(arguments, 1));
|
||||
};
|
||||
|
||||
// Produce a duplicate-free version of the array. If the array has already
|
||||
// been sorted, you have the option of using a faster algorithm.
|
||||
// Aliased as `unique`.
|
||||
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||
var initial = iterator ? _.map(array, iterator) : array;
|
||||
var result = [];
|
||||
_.reduce(initial, function(memo, el, i) {
|
||||
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||
memo[memo.length] = el;
|
||||
result[result.length] = array[i];
|
||||
}
|
||||
return memo;
|
||||
}, []);
|
||||
return result;
|
||||
};
|
||||
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
_.union = function() {
|
||||
return _.uniq(_.flatten(arguments, true));
|
||||
};
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||
_.intersection = _.intersect = function(array) {
|
||||
var rest = slice.call(arguments, 1);
|
||||
return _.filter(_.uniq(array), function(item) {
|
||||
return _.every(rest, function(other) {
|
||||
return _.indexOf(other, item) >= 0;
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
_.difference = function(array) {
|
||||
var rest = _.flatten(slice.call(arguments, 1));
|
||||
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||
};
|
||||
|
||||
// Zip together multiple lists into a single array -- elements that share
|
||||
// an index go together.
|
||||
_.zip = function() {
|
||||
var args = slice.call(arguments);
|
||||
var length = _.max(_.pluck(args, 'length'));
|
||||
var results = new Array(length);
|
||||
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||
return results;
|
||||
};
|
||||
|
||||
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||
// we need this function. Return the position of the first occurrence of an
|
||||
// item in an array, or -1 if the item is not included in the array.
|
||||
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||
// If the array is large and already in sort order, pass `true`
|
||||
// for **isSorted** to use binary search.
|
||||
_.indexOf = function(array, item, isSorted) {
|
||||
if (array == null) return -1;
|
||||
var i, l;
|
||||
if (isSorted) {
|
||||
i = _.sortedIndex(array, item);
|
||||
return array[i] === item ? i : -1;
|
||||
}
|
||||
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||
_.lastIndexOf = function(array, item) {
|
||||
if (array == null) return -1;
|
||||
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||
var i = array.length;
|
||||
while (i--) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Generate an integer Array containing an arithmetic progression. A port of
|
||||
// the native Python `range()` function. See
|
||||
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||
_.range = function(start, stop, step) {
|
||||
if (arguments.length <= 1) {
|
||||
stop = start || 0;
|
||||
start = 0;
|
||||
}
|
||||
step = arguments[2] || 1;
|
||||
|
||||
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||
var idx = 0;
|
||||
var range = new Array(len);
|
||||
|
||||
while(idx < len) {
|
||||
range[idx++] = start;
|
||||
start += step;
|
||||
}
|
||||
|
||||
return range;
|
||||
};
|
||||
|
||||
// Function (ahem) Functions
|
||||
// ------------------
|
||||
|
||||
// Reusable constructor function for prototype setting.
|
||||
var ctor = function(){};
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally). Binding with arguments is also known as `curry`.
|
||||
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||
_.bind = function bind(func, context) {
|
||||
var bound, args;
|
||||
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||
if (!_.isFunction(func)) throw new TypeError;
|
||||
args = slice.call(arguments, 2);
|
||||
return bound = function() {
|
||||
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||
ctor.prototype = func.prototype;
|
||||
var self = new ctor;
|
||||
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||
if (Object(result) === result) return result;
|
||||
return self;
|
||||
};
|
||||
};
|
||||
|
||||
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||
// all callbacks defined on an object belong to it.
|
||||
_.bindAll = function(obj) {
|
||||
var funcs = slice.call(arguments, 1);
|
||||
if (funcs.length == 0) funcs = _.functions(obj);
|
||||
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Memoize an expensive function by storing its results.
|
||||
_.memoize = function(func, hasher) {
|
||||
var memo = {};
|
||||
hasher || (hasher = _.identity);
|
||||
return function() {
|
||||
var key = hasher.apply(this, arguments);
|
||||
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||
};
|
||||
};
|
||||
|
||||
// Delays a function for the given number of milliseconds, and then calls
|
||||
// it with the arguments supplied.
|
||||
_.delay = function(func, wait) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||
};
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
_.defer = function(func) {
|
||||
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||
};
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time.
|
||||
_.throttle = function(func, wait) {
|
||||
var context, args, timeout, throttling, more;
|
||||
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||
return function() {
|
||||
context = this; args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
if (more) func.apply(context, args);
|
||||
whenDone();
|
||||
};
|
||||
if (!timeout) timeout = setTimeout(later, wait);
|
||||
if (throttling) {
|
||||
more = true;
|
||||
} else {
|
||||
func.apply(context, args);
|
||||
}
|
||||
whenDone();
|
||||
throttling = true;
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function, that, as long as it continues to be invoked, will not
|
||||
// be triggered. The function will be called after it stops being called for
|
||||
// N milliseconds.
|
||||
_.debounce = function(func, wait) {
|
||||
var timeout;
|
||||
return function() {
|
||||
var context = this, args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
func.apply(context, args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will be executed at most one time, no matter how
|
||||
// often you call it. Useful for lazy initialization.
|
||||
_.once = function(func) {
|
||||
var ran = false, memo;
|
||||
return function() {
|
||||
if (ran) return memo;
|
||||
ran = true;
|
||||
return memo = func.apply(this, arguments);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns the first function passed as an argument to the second,
|
||||
// allowing you to adjust arguments, run code before and after, and
|
||||
// conditionally execute the original function.
|
||||
_.wrap = function(func, wrapper) {
|
||||
return function() {
|
||||
var args = [func].concat(slice.call(arguments, 0));
|
||||
return wrapper.apply(this, args);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that is the composition of a list of functions, each
|
||||
// consuming the return value of the function that follows.
|
||||
_.compose = function() {
|
||||
var funcs = arguments;
|
||||
return function() {
|
||||
var args = arguments;
|
||||
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||
args = [funcs[i].apply(this, args)];
|
||||
}
|
||||
return args[0];
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will only be executed after being called N times.
|
||||
_.after = function(times, func) {
|
||||
if (times <= 0) return func();
|
||||
return function() {
|
||||
if (--times < 1) { return func.apply(this, arguments); }
|
||||
};
|
||||
};
|
||||
|
||||
// Object Functions
|
||||
// ----------------
|
||||
|
||||
// Retrieve the names of an object's properties.
|
||||
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||
_.keys = nativeKeys || function(obj) {
|
||||
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||
var keys = [];
|
||||
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||
return keys;
|
||||
};
|
||||
|
||||
// Retrieve the values of an object's properties.
|
||||
_.values = function(obj) {
|
||||
return _.map(obj, _.identity);
|
||||
};
|
||||
|
||||
// Return a sorted list of the function names available on the object.
|
||||
// Aliased as `methods`
|
||||
_.functions = _.methods = function(obj) {
|
||||
var names = [];
|
||||
for (var key in obj) {
|
||||
if (_.isFunction(obj[key])) names.push(key);
|
||||
}
|
||||
return names.sort();
|
||||
};
|
||||
|
||||
// Extend a given object with all the properties in passed-in object(s).
|
||||
_.extend = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Fill in a given object with default properties.
|
||||
_.defaults = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
if (obj[prop] == null) obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Create a (shallow-cloned) duplicate of an object.
|
||||
_.clone = function(obj) {
|
||||
if (!_.isObject(obj)) return obj;
|
||||
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||
};
|
||||
|
||||
// Invokes interceptor with the obj, and then returns obj.
|
||||
// The primary purpose of this method is to "tap into" a method chain, in
|
||||
// order to perform operations on intermediate results within the chain.
|
||||
_.tap = function(obj, interceptor) {
|
||||
interceptor(obj);
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Internal recursive comparison function.
|
||||
function eq(a, b, stack) {
|
||||
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||
// A strict comparison is necessary because `null == undefined`.
|
||||
if (a == null || b == null) return a === b;
|
||||
// Unwrap any wrapped objects.
|
||||
if (a._chain) a = a._wrapped;
|
||||
if (b._chain) b = b._wrapped;
|
||||
// Invoke a custom `isEqual` method if one is provided.
|
||||
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className != toString.call(b)) return false;
|
||||
switch (className) {
|
||||
// Strings, numbers, dates, and booleans are compared by value.
|
||||
case '[object String]':
|
||||
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||
// equivalent to `new String("5")`.
|
||||
return a == String(b);
|
||||
case '[object Number]':
|
||||
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||
// other numeric values.
|
||||
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||
case '[object Date]':
|
||||
case '[object Boolean]':
|
||||
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||
// millisecond representations. Note that invalid dates with millisecond representations
|
||||
// of `NaN` are not equivalent.
|
||||
return +a == +b;
|
||||
// RegExps are compared by their source patterns and flags.
|
||||
case '[object RegExp]':
|
||||
return a.source == b.source &&
|
||||
a.global == b.global &&
|
||||
a.multiline == b.multiline &&
|
||||
a.ignoreCase == b.ignoreCase;
|
||||
}
|
||||
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||
var length = stack.length;
|
||||
while (length--) {
|
||||
// Linear search. Performance is inversely proportional to the number of
|
||||
// unique nested structures.
|
||||
if (stack[length] == a) return true;
|
||||
}
|
||||
// Add the first object to the stack of traversed objects.
|
||||
stack.push(a);
|
||||
var size = 0, result = true;
|
||||
// Recursively compare objects and arrays.
|
||||
if (className == '[object Array]') {
|
||||
// Compare array lengths to determine if a deep comparison is necessary.
|
||||
size = a.length;
|
||||
result = size == b.length;
|
||||
if (result) {
|
||||
// Deep compare the contents, ignoring non-numeric properties.
|
||||
while (size--) {
|
||||
// Ensure commutative equality for sparse arrays.
|
||||
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Objects with different constructors are not equivalent.
|
||||
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||
// Deep compare objects.
|
||||
for (var key in a) {
|
||||
if (_.has(a, key)) {
|
||||
// Count the expected number of properties.
|
||||
size++;
|
||||
// Deep compare each member.
|
||||
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||
}
|
||||
}
|
||||
// Ensure that both objects contain the same number of properties.
|
||||
if (result) {
|
||||
for (key in b) {
|
||||
if (_.has(b, key) && !(size--)) break;
|
||||
}
|
||||
result = !size;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
stack.pop();
|
||||
return result;
|
||||
}
|
||||
|
||||
// Perform a deep comparison to check if two objects are equal.
|
||||
_.isEqual = function(a, b) {
|
||||
return eq(a, b, []);
|
||||
};
|
||||
|
||||
// Is a given array, string, or object empty?
|
||||
// An "empty" object has no enumerable own-properties.
|
||||
_.isEmpty = function(obj) {
|
||||
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||
for (var key in obj) if (_.has(obj, key)) return false;
|
||||
return true;
|
||||
};
|
||||
|
||||
// Is a given value a DOM element?
|
||||
_.isElement = function(obj) {
|
||||
return !!(obj && obj.nodeType == 1);
|
||||
};
|
||||
|
||||
// Is a given value an array?
|
||||
// Delegates to ECMA5's native Array.isArray
|
||||
_.isArray = nativeIsArray || function(obj) {
|
||||
return toString.call(obj) == '[object Array]';
|
||||
};
|
||||
|
||||
// Is a given variable an object?
|
||||
_.isObject = function(obj) {
|
||||
return obj === Object(obj);
|
||||
};
|
||||
|
||||
// Is a given variable an arguments object?
|
||||
_.isArguments = function(obj) {
|
||||
return toString.call(obj) == '[object Arguments]';
|
||||
};
|
||||
if (!_.isArguments(arguments)) {
|
||||
_.isArguments = function(obj) {
|
||||
return !!(obj && _.has(obj, 'callee'));
|
||||
};
|
||||
}
|
||||
|
||||
// Is a given value a function?
|
||||
_.isFunction = function(obj) {
|
||||
return toString.call(obj) == '[object Function]';
|
||||
};
|
||||
|
||||
// Is a given value a string?
|
||||
_.isString = function(obj) {
|
||||
return toString.call(obj) == '[object String]';
|
||||
};
|
||||
|
||||
// Is a given value a number?
|
||||
_.isNumber = function(obj) {
|
||||
return toString.call(obj) == '[object Number]';
|
||||
};
|
||||
|
||||
// Is the given value `NaN`?
|
||||
_.isNaN = function(obj) {
|
||||
// `NaN` is the only value for which `===` is not reflexive.
|
||||
return obj !== obj;
|
||||
};
|
||||
|
||||
// Is a given value a boolean?
|
||||
_.isBoolean = function(obj) {
|
||||
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||
};
|
||||
|
||||
// Is a given value a date?
|
||||
_.isDate = function(obj) {
|
||||
return toString.call(obj) == '[object Date]';
|
||||
};
|
||||
|
||||
// Is the given value a regular expression?
|
||||
_.isRegExp = function(obj) {
|
||||
return toString.call(obj) == '[object RegExp]';
|
||||
};
|
||||
|
||||
// Is a given value equal to null?
|
||||
_.isNull = function(obj) {
|
||||
return obj === null;
|
||||
};
|
||||
|
||||
// Is a given variable undefined?
|
||||
_.isUndefined = function(obj) {
|
||||
return obj === void 0;
|
||||
};
|
||||
|
||||
// Has own property?
|
||||
_.has = function(obj, key) {
|
||||
return hasOwnProperty.call(obj, key);
|
||||
};
|
||||
|
||||
// Utility Functions
|
||||
// -----------------
|
||||
|
||||
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||
// previous owner. Returns a reference to the Underscore object.
|
||||
_.noConflict = function() {
|
||||
root._ = previousUnderscore;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Keep the identity function around for default iterators.
|
||||
_.identity = function(value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
// Run a function **n** times.
|
||||
_.times = function (n, iterator, context) {
|
||||
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||
};
|
||||
|
||||
// Escape a string for HTML interpolation.
|
||||
_.escape = function(string) {
|
||||
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||
};
|
||||
|
||||
// Add your own custom functions to the Underscore object, ensuring that
|
||||
// they're correctly added to the OOP wrapper as well.
|
||||
_.mixin = function(obj) {
|
||||
each(_.functions(obj), function(name){
|
||||
addToWrapper(name, _[name] = obj[name]);
|
||||
});
|
||||
};
|
||||
|
||||
// Generate a unique integer id (unique within the entire client session).
|
||||
// Useful for temporary DOM ids.
|
||||
var idCounter = 0;
|
||||
_.uniqueId = function(prefix) {
|
||||
var id = idCounter++;
|
||||
return prefix ? prefix + id : id;
|
||||
};
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters, change the
|
||||
// following template settings to use alternative delimiters.
|
||||
_.templateSettings = {
|
||||
evaluate : /<%([\s\S]+?)%>/g,
|
||||
interpolate : /<%=([\s\S]+?)%>/g,
|
||||
escape : /<%-([\s\S]+?)%>/g
|
||||
};
|
||||
|
||||
// When customizing `templateSettings`, if you don't want to define an
|
||||
// interpolation, evaluation or escaping regex, we need one that is
|
||||
// guaranteed not to match.
|
||||
var noMatch = /.^/;
|
||||
|
||||
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||
// that had been previously added.
|
||||
var unescape = function(code) {
|
||||
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||
};
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
_.template = function(str, data) {
|
||||
var c = _.templateSettings;
|
||||
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||
'with(obj||{}){__p.push(\'' +
|
||||
str.replace(/\\/g, '\\\\')
|
||||
.replace(/'/g, "\\'")
|
||||
.replace(c.escape || noMatch, function(match, code) {
|
||||
return "',_.escape(" + unescape(code) + "),'";
|
||||
})
|
||||
.replace(c.interpolate || noMatch, function(match, code) {
|
||||
return "'," + unescape(code) + ",'";
|
||||
})
|
||||
.replace(c.evaluate || noMatch, function(match, code) {
|
||||
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||
})
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\t/g, '\\t')
|
||||
+ "');}return __p.join('');";
|
||||
var func = new Function('obj', '_', tmpl);
|
||||
if (data) return func(data, _);
|
||||
return function(data) {
|
||||
return func.call(this, data, _);
|
||||
};
|
||||
};
|
||||
|
||||
// Add a "chain" function, which will delegate to the wrapper.
|
||||
_.chain = function(obj) {
|
||||
return _(obj).chain();
|
||||
};
|
||||
|
||||
// The OOP Wrapper
|
||||
// ---------------
|
||||
|
||||
// If Underscore is called as a function, it returns a wrapped object that
|
||||
// can be used OO-style. This wrapper holds altered versions of all the
|
||||
// underscore functions. Wrapped objects may be chained.
|
||||
var wrapper = function(obj) { this._wrapped = obj; };
|
||||
|
||||
// Expose `wrapper.prototype` as `_.prototype`
|
||||
_.prototype = wrapper.prototype;
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
var result = function(obj, chain) {
|
||||
return chain ? _(obj).chain() : obj;
|
||||
};
|
||||
|
||||
// A method to easily add functions to the OOP wrapper.
|
||||
var addToWrapper = function(name, func) {
|
||||
wrapper.prototype[name] = function() {
|
||||
var args = slice.call(arguments);
|
||||
unshift.call(args, this._wrapped);
|
||||
return result(func.apply(_, args), this._chain);
|
||||
};
|
||||
};
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
_.mixin(_);
|
||||
|
||||
// Add all mutator Array functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
var wrapped = this._wrapped;
|
||||
method.apply(wrapped, arguments);
|
||||
var length = wrapped.length;
|
||||
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||
return result(wrapped, this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Add all accessor Array functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
wrapper.prototype.chain = function() {
|
||||
this._chain = true;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
wrapper.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
}).call(this);
|
||||
31
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/underscore.js
vendored
Normal file
31
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/underscore.js
vendored
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
|
||||
c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
|
||||
h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
|
||||
b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
|
||||
null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
|
||||
function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
|
||||
e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
|
||||
function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
|
||||
return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
|
||||
c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
|
||||
b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
|
||||
return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
|
||||
d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
|
||||
var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
|
||||
c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
|
||||
a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
|
||||
b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
|
||||
1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
|
||||
b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
|
||||
b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a),
|
||||
function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
|
||||
u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
|
||||
function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
|
||||
true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);
|
||||
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/up-pressed.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/up-pressed.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 214 B |
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/up.png
vendored
Normal file
BIN
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/up.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 203 B |
808
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/websupport.js
vendored
Normal file
808
openpype/modules/slack/python2_vendor/python-slack-sdk-1/docs/_static/websupport.js
vendored
Normal file
|
|
@ -0,0 +1,808 @@
|
|||
/*
|
||||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
$.fn.autogrow = function() {
|
||||
return this.each(function() {
|
||||
var textarea = this;
|
||||
|
||||
$.fn.autogrow.resize(textarea);
|
||||
|
||||
$(textarea)
|
||||
.focus(function() {
|
||||
textarea.interval = setInterval(function() {
|
||||
$.fn.autogrow.resize(textarea);
|
||||
}, 500);
|
||||
})
|
||||
.blur(function() {
|
||||
clearInterval(textarea.interval);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
$.fn.autogrow.resize = function(textarea) {
|
||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
||||
var lines = textarea.value.split('\n');
|
||||
var columns = textarea.cols;
|
||||
var lineCount = 0;
|
||||
$.each(lines, function() {
|
||||
lineCount += Math.ceil(this.length / columns) || 1;
|
||||
});
|
||||
var height = lineHeight * (lineCount + 1);
|
||||
$(textarea).css('height', height);
|
||||
};
|
||||
})(jQuery);
|
||||
|
||||
(function($) {
|
||||
var comp, by;
|
||||
|
||||
function init() {
|
||||
initEvents();
|
||||
initComparator();
|
||||
}
|
||||
|
||||
function initEvents() {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set comp, which is a comparator function used for sorting and
|
||||
* inserting comments into the list.
|
||||
*/
|
||||
function setComparator() {
|
||||
// If the first three letters are "asc", sort in ascending order
|
||||
// and remove the prefix.
|
||||
if (by.substring(0,3) == 'asc') {
|
||||
var i = by.substring(3);
|
||||
comp = function(a, b) { return a[i] - b[i]; };
|
||||
} else {
|
||||
// Otherwise sort in descending order.
|
||||
comp = function(a, b) { return b[by] - a[by]; };
|
||||
}
|
||||
|
||||
// Reset link styles and format the selected sort option.
|
||||
$('a.sel').attr('href', '#').removeClass('sel');
|
||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a comp function. If the user has preferences stored in
|
||||
* the sortBy cookie, use those, otherwise use the default.
|
||||
*/
|
||||
function initComparator() {
|
||||
by = 'rating'; // Default to sort by rating.
|
||||
// If the sortBy cookie is set, use that instead.
|
||||
if (document.cookie.length > 0) {
|
||||
var start = document.cookie.indexOf('sortBy=');
|
||||
if (start != -1) {
|
||||
start = start + 7;
|
||||
var end = document.cookie.indexOf(";", start);
|
||||
if (end == -1) {
|
||||
end = document.cookie.length;
|
||||
by = unescape(document.cookie.substring(start, end));
|
||||
}
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a comment div.
|
||||
*/
|
||||
function show(id) {
|
||||
$('#ao' + id).hide();
|
||||
$('#ah' + id).show();
|
||||
var context = $.extend({id: id}, opts);
|
||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
||||
popup.find('textarea[name="proposal"]').hide();
|
||||
popup.find('a.by' + by).addClass('sel');
|
||||
var form = popup.find('#cf' + id);
|
||||
form.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment(form);
|
||||
});
|
||||
$('#s' + id).after(popup);
|
||||
popup.slideDown('fast', function() {
|
||||
getComments(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide a comment div.
|
||||
*/
|
||||
function hide(id) {
|
||||
$('#ah' + id).hide();
|
||||
$('#ao' + id).show();
|
||||
var div = $('#sc' + id);
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform an ajax request to get comments for a node
|
||||
* and insert the comments into the comments tree.
|
||||
*/
|
||||
function getComments(id) {
|
||||
$.ajax({
|
||||
type: 'GET',
|
||||
url: opts.getCommentsURL,
|
||||
data: {node: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var ul = $('#cl' + id);
|
||||
var speed = 100;
|
||||
$('#cf' + id)
|
||||
.find('textarea[name="proposal"]')
|
||||
.data('source', data.source);
|
||||
|
||||
if (data.comments.length === 0) {
|
||||
ul.html('<li>No comments yet.</li>');
|
||||
ul.data('empty', true);
|
||||
} else {
|
||||
// If there are comments, sort them and put them in the list.
|
||||
var comments = sortComments(data.comments);
|
||||
speed = data.comments.length * 100;
|
||||
appendComments(comments, ul);
|
||||
ul.data('empty', false);
|
||||
}
|
||||
$('#cn' + id).slideUp(speed + 200);
|
||||
ul.slideDown(speed);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem retrieving the comments.');
|
||||
},
|
||||
dataType: 'json'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment via ajax and insert the comment into the comment tree.
|
||||
*/
|
||||
function addComment(form) {
|
||||
var node_id = form.find('input[name="node"]').val();
|
||||
var parent_id = form.find('input[name="parent"]').val();
|
||||
var text = form.find('textarea[name="comment"]').val();
|
||||
var proposal = form.find('textarea[name="proposal"]').val();
|
||||
|
||||
if (text == '') {
|
||||
showError('Please enter a comment.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Disable the form that is being submitted.
|
||||
form.find('textarea,input').attr('disabled', 'disabled');
|
||||
|
||||
// Send the comment to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.addCommentURL,
|
||||
dataType: 'json',
|
||||
data: {
|
||||
node: node_id,
|
||||
parent: parent_id,
|
||||
text: text,
|
||||
proposal: proposal
|
||||
},
|
||||
success: function(data, textStatus, error) {
|
||||
// Reset the form.
|
||||
if (node_id) {
|
||||
hideProposeChange(node_id);
|
||||
}
|
||||
form.find('textarea')
|
||||
.val('')
|
||||
.add(form.find('input'))
|
||||
.removeAttr('disabled');
|
||||
var ul = $('#cl' + (node_id || parent_id));
|
||||
if (ul.data('empty')) {
|
||||
$(ul).empty();
|
||||
ul.data('empty', false);
|
||||
}
|
||||
insertComment(data.comment);
|
||||
var ao = $('#ao' + node_id);
|
||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
||||
if (node_id) {
|
||||
// if this was a "root" comment, remove the commenting box
|
||||
// (the user can get it back by reopening the comment popup)
|
||||
$('#ca' + node_id).slideUp();
|
||||
}
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
form.find('textarea,input').removeAttr('disabled');
|
||||
showError('Oops, there was a problem adding the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively append comments to the main comment list and children
|
||||
* lists, creating the comment tree.
|
||||
*/
|
||||
function appendComments(comments, ul) {
|
||||
$.each(comments, function() {
|
||||
var div = createCommentDiv(this);
|
||||
ul.append($(document.createElement('li')).html(div));
|
||||
appendComments(this.children, div.find('ul.comment-children'));
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
this.children = null;
|
||||
div.data('comment', this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* After adding a new comment, it must be inserted in the correct
|
||||
* location in the comment tree.
|
||||
*/
|
||||
function insertComment(comment) {
|
||||
var div = createCommentDiv(comment);
|
||||
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
comment.children = null;
|
||||
div.data('comment', comment);
|
||||
|
||||
var ul = $('#cl' + (comment.node || comment.parent));
|
||||
var siblings = getChildren(ul);
|
||||
|
||||
var li = $(document.createElement('li'));
|
||||
li.hide();
|
||||
|
||||
// Determine where in the parents children list to insert this comment.
|
||||
for(var i=0; i < siblings.length; i++) {
|
||||
if (comp(comment, siblings[i]) <= 0) {
|
||||
$('#cd' + siblings[i].id)
|
||||
.parent()
|
||||
.before(li.html(div));
|
||||
li.slideDown('fast');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If we get here, this comment rates lower than all the others,
|
||||
// or it is the only comment in the list.
|
||||
ul.append(li.html(div));
|
||||
li.slideDown('fast');
|
||||
}
|
||||
|
||||
function acceptComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.acceptCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
$('#cm' + id).fadeOut('fast');
|
||||
$('#cd' + id).removeClass('moderate');
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem accepting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function deleteComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.deleteCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var div = $('#cd' + id);
|
||||
if (data == 'delete') {
|
||||
// Moderator mode: remove the comment and all children immediately
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
// User mode: only mark the comment as deleted
|
||||
div
|
||||
.find('span.user-id:first')
|
||||
.text('[deleted]').end()
|
||||
.find('div.comment-text:first')
|
||||
.text('[deleted]').end()
|
||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
||||
.remove();
|
||||
var comment = div.data('comment');
|
||||
comment.username = '[deleted]';
|
||||
comment.text = '[deleted]';
|
||||
div.data('comment', comment);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem deleting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function showProposal(id) {
|
||||
$('#sp' + id).hide();
|
||||
$('#hp' + id).show();
|
||||
$('#pr' + id).slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposal(id) {
|
||||
$('#hp' + id).hide();
|
||||
$('#sp' + id).show();
|
||||
$('#pr' + id).slideUp('fast');
|
||||
}
|
||||
|
||||
function showProposeChange(id) {
|
||||
$('#pc' + id).hide();
|
||||
$('#hc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val(textarea.data('source'));
|
||||
$.fn.autogrow.resize(textarea[0]);
|
||||
textarea.slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposeChange(id) {
|
||||
$('#hc' + id).hide();
|
||||
$('#pc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val('').removeAttr('disabled');
|
||||
textarea.slideUp('fast');
|
||||
}
|
||||
|
||||
function toggleCommentMarkupBox(id) {
|
||||
$('#mb' + id).toggle();
|
||||
}
|
||||
|
||||
/** Handle when the user clicks on a sort by link. */
|
||||
function handleReSort(link) {
|
||||
var classes = link.attr('class').split(/\s+/);
|
||||
for (var i=0; i<classes.length; i++) {
|
||||
if (classes[i] != 'sort-option') {
|
||||
by = classes[i].substring(2);
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
// Save/update the sortBy cookie.
|
||||
var expiration = new Date();
|
||||
expiration.setDate(expiration.getDate() + 365);
|
||||
document.cookie= 'sortBy=' + escape(by) +
|
||||
';expires=' + expiration.toUTCString();
|
||||
$('ul.comment-ul').each(function(index, ul) {
|
||||
var comments = getChildren($(ul), true);
|
||||
comments = sortComments(comments);
|
||||
appendComments(comments, $(ul).empty());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to process a vote when a user clicks an arrow.
|
||||
*/
|
||||
function handleVote(link) {
|
||||
if (!opts.voting) {
|
||||
showError("You'll need to login to vote.");
|
||||
return;
|
||||
}
|
||||
|
||||
var id = link.attr('id');
|
||||
if (!id) {
|
||||
// Didn't click on one of the voting arrows.
|
||||
return;
|
||||
}
|
||||
// If it is an unvote, the new vote value is 0,
|
||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
||||
var value = 0;
|
||||
if (id.charAt(1) != 'u') {
|
||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
||||
}
|
||||
// The data to be sent to the server.
|
||||
var d = {
|
||||
comment_id: id.substring(2),
|
||||
value: value
|
||||
};
|
||||
|
||||
// Swap the vote and unvote links.
|
||||
link.hide();
|
||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
||||
.show();
|
||||
|
||||
// The div the comment is displayed in.
|
||||
var div = $('div#cd' + d.comment_id);
|
||||
var data = div.data('comment');
|
||||
|
||||
// If this is not an unvote, and the other vote arrow has
|
||||
// already been pressed, unpress it.
|
||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
||||
}
|
||||
|
||||
// Update the comments rating in the local data.
|
||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
||||
data.vote = d.value;
|
||||
div.data('comment', data);
|
||||
|
||||
// Change the rating text.
|
||||
div.find('.rating:first')
|
||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
||||
|
||||
// Send the vote information to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.processVoteURL,
|
||||
data: d,
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem casting that vote.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a reply form used to reply to an existing comment.
|
||||
*/
|
||||
function openReply(id) {
|
||||
// Swap out the reply link for the hide link
|
||||
$('#rl' + id).hide();
|
||||
$('#cr' + id).show();
|
||||
|
||||
// Add the reply li to the children ul.
|
||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
||||
$('#cl' + id)
|
||||
.prepend(div)
|
||||
// Setup the submit handler for the reply form.
|
||||
.find('#rf' + id)
|
||||
.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment($('#rf' + id));
|
||||
closeReply(id);
|
||||
})
|
||||
.find('input[type=button]')
|
||||
.click(function() {
|
||||
closeReply(id);
|
||||
});
|
||||
div.slideDown('fast', function() {
|
||||
$('#rf' + id).find('textarea').focus();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reply form opened with openReply.
|
||||
*/
|
||||
function closeReply(id) {
|
||||
// Remove the reply div from the DOM.
|
||||
$('#rd' + id).slideUp('fast', function() {
|
||||
$(this).remove();
|
||||
});
|
||||
|
||||
// Swap out the hide link for the reply link
|
||||
$('#cr' + id).hide();
|
||||
$('#rl' + id).show();
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively sort a tree of comments using the comp comparator.
|
||||
*/
|
||||
function sortComments(comments) {
|
||||
comments.sort(comp);
|
||||
$.each(comments, function() {
|
||||
this.children = sortComments(this.children);
|
||||
});
|
||||
return comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children comments from a ul. If recursive is true,
|
||||
* recursively include childrens' children.
|
||||
*/
|
||||
function getChildren(ul, recursive) {
|
||||
var children = [];
|
||||
ul.children().children("[id^='cd']")
|
||||
.each(function() {
|
||||
var comment = $(this).data('comment');
|
||||
if (recursive)
|
||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
||||
children.push(comment);
|
||||
});
|
||||
return children;
|
||||
}
|
||||
|
||||
/** Create a div to display a comment in. */
|
||||
function createCommentDiv(comment) {
|
||||
if (!comment.displayed && !opts.moderator) {
|
||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
||||
+ 'once it is has been approved by a moderator.</div>');
|
||||
}
|
||||
// Prettify the comment rating.
|
||||
comment.pretty_rating = comment.rating + ' point' +
|
||||
(comment.rating == 1 ? '' : 's');
|
||||
// Make a class (for displaying not yet moderated comments differently)
|
||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
||||
// Create a div for this comment.
|
||||
var context = $.extend({}, opts, comment);
|
||||
var div = $(renderTemplate(commentTemplate, context));
|
||||
|
||||
// If the user has voted on this comment, highlight the correct arrow.
|
||||
if (comment.vote) {
|
||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
||||
div.find('#' + direction + 'v' + comment.id).hide();
|
||||
div.find('#' + direction + 'u' + comment.id).show();
|
||||
}
|
||||
|
||||
if (opts.moderator || comment.text != '[deleted]') {
|
||||
div.find('a.reply').show();
|
||||
if (comment.proposal_diff)
|
||||
div.find('#sp' + comment.id).show();
|
||||
if (opts.moderator && !comment.displayed)
|
||||
div.find('#cm' + comment.id).show();
|
||||
if (opts.moderator || (opts.username == comment.username))
|
||||
div.find('#dc' + comment.id).show();
|
||||
}
|
||||
return div;
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
||||
* are not escaped.
|
||||
*/
|
||||
function renderTemplate(template, context) {
|
||||
var esc = $(document.createElement('div'));
|
||||
|
||||
function handle(ph, escape) {
|
||||
var cur = context;
|
||||
$.each(ph.split('.'), function() {
|
||||
cur = cur[this];
|
||||
});
|
||||
return escape ? esc.text(cur || "").html() : cur;
|
||||
}
|
||||
|
||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
||||
});
|
||||
}
|
||||
|
||||
/** Flash an error message briefly. */
|
||||
function showError(message) {
|
||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
||||
.append($(document.createElement('div'))
|
||||
.attr({'class': 'error-message'}).text(message))
|
||||
.appendTo('body')
|
||||
.fadeIn("slow")
|
||||
.delay(2000)
|
||||
.fadeOut("slow");
|
||||
}
|
||||
|
||||
/** Add a link the user uses to open the comments popup. */
|
||||
$.fn.comment = function() {
|
||||
return this.each(function() {
|
||||
var id = $(this).attr('id').substring(1);
|
||||
var count = COMMENT_METADATA[id];
|
||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
||||
var addcls = count == 0 ? ' nocomment' : '';
|
||||
$(this)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-open' + addcls,
|
||||
id: 'ao' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: image,
|
||||
alt: 'comment',
|
||||
title: title
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
show($(this).attr('id').substring(2));
|
||||
})
|
||||
)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-close hidden',
|
||||
id: 'ah' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: opts.closeCommentImage,
|
||||
alt: 'close',
|
||||
title: 'close'
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
})
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
var opts = {
|
||||
processVoteURL: '/_process_vote',
|
||||
addCommentURL: '/_add_comment',
|
||||
getCommentsURL: '/_get_comments',
|
||||
acceptCommentURL: '/_accept_comment',
|
||||
deleteCommentURL: '/_delete_comment',
|
||||
commentImage: '/static/_static/comment.png',
|
||||
closeCommentImage: '/static/_static/comment-close.png',
|
||||
loadingImage: '/static/_static/ajax-loader.gif',
|
||||
commentBrightImage: '/static/_static/comment-bright.png',
|
||||
upArrow: '/static/_static/up.png',
|
||||
downArrow: '/static/_static/down.png',
|
||||
upArrowPressed: '/static/_static/up-pressed.png',
|
||||
downArrowPressed: '/static/_static/down-pressed.png',
|
||||
voting: false,
|
||||
moderator: false
|
||||
};
|
||||
|
||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
||||
}
|
||||
|
||||
var popupTemplate = '\
|
||||
<div class="sphinx-comments" id="sc<%id%>">\
|
||||
<p class="sort-options">\
|
||||
Sort by:\
|
||||
<a href="#" class="sort-option byrating">best rated</a>\
|
||||
<a href="#" class="sort-option byascage">newest</a>\
|
||||
<a href="#" class="sort-option byage">oldest</a>\
|
||||
</p>\
|
||||
<div class="comment-header">Comments</div>\
|
||||
<div class="comment-loading" id="cn<%id%>">\
|
||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
||||
<div id="ca<%id%>">\
|
||||
<p class="add-a-comment">Add a comment\
|
||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
||||
Propose a change ▹\
|
||||
</a>\
|
||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
||||
Propose a change ▿\
|
||||
</a>\
|
||||
</p>\
|
||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
||||
spellcheck="false"></textarea>\
|
||||
<input type="submit" value="Add comment" />\
|
||||
<input type="hidden" name="node" value="<%id%>" />\
|
||||
<input type="hidden" name="parent" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var commentTemplate = '\
|
||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
||||
<div class="vote">\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
||||
<img src="<%upArrow%>" />\
|
||||
</a>\
|
||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
||||
<img src="<%upArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
||||
</a>\
|
||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
||||
<img src="<%downArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
</div>\
|
||||
<div class="comment-content">\
|
||||
<p class="tagline comment">\
|
||||
<span class="user-id"><%username%></span>\
|
||||
<span class="rating"><%pretty_rating%></span>\
|
||||
<span class="delta"><%time.delta%></span>\
|
||||
</p>\
|
||||
<div class="comment-text comment"><#text#></div>\
|
||||
<p class="comment-opts comment">\
|
||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
||||
<span id="cm<%id%>" class="moderation hidden">\
|
||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
||||
</span>\
|
||||
</p>\
|
||||
<pre class="proposal" id="pr<%id%>">\
|
||||
<#proposal_diff#>\
|
||||
</pre>\
|
||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
||||
</div>\
|
||||
<div class="clearleft"></div>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var replyTemplate = '\
|
||||
<li>\
|
||||
<div class="reply-div" id="rd<%id%>">\
|
||||
<form id="rf<%id%>">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<input type="submit" value="Add reply" />\
|
||||
<input type="button" value="Cancel" />\
|
||||
<input type="hidden" name="parent" value="<%id%>" />\
|
||||
<input type="hidden" name="node" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</li>';
|
||||
|
||||
$(document).ready(function() {
|
||||
init();
|
||||
});
|
||||
})(jQuery);
|
||||
|
||||
$(document).ready(function() {
|
||||
// add comment anchors for all paragraphs that are commentable
|
||||
$('.sphinx-has-comment').comment();
|
||||
|
||||
// highlight search words in search results
|
||||
$("div.context").each(function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
||||
var result = $(this);
|
||||
$.each(terms, function() {
|
||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
});
|
||||
|
||||
// directly open comment window if requested
|
||||
var anchor = document.location.hash;
|
||||
if (anchor.substring(0, 9) == '#comment-') {
|
||||
$('#ao' + anchor.substring(9)).click();
|
||||
document.location.hash = '#s' + anchor.substring(9);
|
||||
}
|
||||
});
|
||||
|
|
@ -0,0 +1,196 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>About — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">About</div>
|
||||
<div class="card">
|
||||
<div class="section" id="about">
|
||||
<h1>About<a class="headerlink" href="#about" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="product-name">
|
||||
<h2>Slack Developer Kit for Python<a class="headerlink" href="#product-name" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Access the Slack Platform from your Python app. Slack Developer Kit for Python lets you build on the Slack Web APIs pythonically.</p>
|
||||
<p>Slack Developer Kit for Python is proudly maintained with 💖 by the Slack Developer Tools team</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a class="reference external" href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a class="reference external" href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a class="reference external" href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,300 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Tokens & Authentication — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Tokens & Authentication</div>
|
||||
<div class="card">
|
||||
<div class="section" id="tokens-authentication">
|
||||
<h1>Tokens & Authentication<a class="headerlink" href="#tokens-authentication" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="handling-tokens-and-other-sensitive-data">
|
||||
<span id="handling-tokens"></span><h2>Handling tokens and other sensitive data<a class="headerlink" href="#handling-tokens-and-other-sensitive-data" title="Permalink to this headline">¶</a></h2>
|
||||
<p>⚠️ <strong>Slack tokens are the keys to your—or your customers’—data.Keep them secret. Keep them safe.</strong></p>
|
||||
<p>One way to do that is to never explicitly hardcode them.</p>
|
||||
<p>Try to avoid this when possible:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">token</span> <span class="o">=</span> <span class="s1">'xoxb-abc-1232'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>⚠️ <strong>Never share test tokens with other users or applications. Do not publish test tokens in public code repositories.</strong></p>
|
||||
<p>We recommend you pass tokens in as environment variables, or persist them in a database that is accessed at runtime. You can add a token to the environment by starting your app as:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">SLACK_BOT_TOKEN</span><span class="o">=</span><span class="s2">"xoxb-abc-1232"</span> <span class="n">python</span> <span class="n">myapp</span><span class="o">.</span><span class="n">py</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Then retrieve the key with:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
|
||||
<span class="n">SLACK_BOT_TOKEN</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_BOT_TOKEN"</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You can use the same technique for other kinds of sensitive data that ne’er-do-wells could use in nefarious ways, including</p>
|
||||
<ul class="simple">
|
||||
<li>Incoming webhook URLs</li>
|
||||
<li>Slash command verification tokens</li>
|
||||
<li>App client ids and client secrets</li>
|
||||
</ul>
|
||||
<p>For additional information, please see our <a class="reference external" href="https://api.slack.com/docs/oauth-safety">Safely Storing Credentials</a> page.</p>
|
||||
</div>
|
||||
<div class="section" id="single-workspace-apps">
|
||||
<h2>Single-Workspace Apps<a class="headerlink" href="#single-workspace-apps" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you’re building an application for a single Slack workspace, there’s no need to build out the entire OAuth flow.</p>
|
||||
<p>Once you’ve setup your features, click on the <strong>Install App to Team</strong> button found on the <strong>Install App</strong> page.
|
||||
If you add new permission scopes or Slack app features after an app has been installed, you must reinstall the app to
|
||||
your workspace for changes to take effect.</p>
|
||||
<p>For additional information, see the <a class="reference external" href="https://api.slack.com/slack-apps#installing_apps">Installing Apps</a> of our <a class="reference external" href="https://api.slack.com/slack-apps#installing_apps">Building Slack apps</a> page.</p>
|
||||
</div>
|
||||
<div class="section" id="the-oauth-flow">
|
||||
<h2>The OAuth flow<a class="headerlink" href="#the-oauth-flow" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Authentication for Slack’s APIs is done using OAuth, so you’ll want to read up on <a class="reference external" href="https://api.slack.com/docs/oauth">OAuth</a>.</p>
|
||||
<p>In order to implement OAuth in your app, you will need to include a web server. In this example, we’ll use <a class="reference external" href="http://flask.pocoo.org/">Flask</a>.</p>
|
||||
<p>As mentioned above, we’re setting the app tokens and other configs in environment variables and pulling them into global variables.</p>
|
||||
<p>Depending on what actions your app will need to perform, you’ll need different OAuth permission scopes. Review the available scopes <a class="reference external" href="https://api.slack.com/docs/oauth-scopes">here</a>.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
|
||||
<span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">Flask</span><span class="p">,</span> <span class="n">request</span>
|
||||
<span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">client_id</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_CLIENT_ID"</span><span class="p">]</span>
|
||||
<span class="n">client_secret</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_CLIENT_SECRET"</span><span class="p">]</span>
|
||||
<span class="n">oauth_scope</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_BOT_SCOPE"</span><span class="p">]</span>
|
||||
|
||||
<span class="n">app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>The OAuth initiation link:</strong></p>
|
||||
<p>To begin the OAuth flow, you’ll need to provide the user with a link to Slack’s OAuth page.
|
||||
This directs the user to Slack’s OAuth acceptance page, where the user will review and accept
|
||||
or refuse the permissions your app is requesting as defined by the requested scope(s).</p>
|
||||
<p>For the best user experience, use the <a class="reference external" href="https://api.slack.com/docs/slack-button">Add to Slack button</a> to direct users to approve your application for access or <a class="reference external" href="https://api.slack.com/docs/sign-in-with-slack">Sign in with Slack</a> to log users in.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@app.route</span><span class="p">(</span><span class="s2">"/begin_auth"</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"GET"</span><span class="p">])</span>
|
||||
<span class="k">def</span> <span class="nf">pre_install</span><span class="p">():</span>
|
||||
<span class="k">return</span> <span class="s1">'''</span>
|
||||
<span class="s1"> <a href="https://slack.com/oauth/authorize?scope={0}&client_id={1}"></span>
|
||||
<span class="s1"> Add to Slack</span>
|
||||
<span class="s1"> </a></span>
|
||||
<span class="s1"> '''</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">oauth_scope</span><span class="p">,</span> <span class="n">client_id</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>The OAuth completion page</strong></p>
|
||||
<p>Once the user has agreed to the permissions you’ve requested on Slack’s OAuth
|
||||
page, Slack will redirect the user to your auth completion page. Included in this
|
||||
redirect is a <code class="docutils literal notranslate"><span class="pre">code</span></code> query string param which you’ll use to request access
|
||||
tokens from the <code class="docutils literal notranslate"><span class="pre">oauth.access</span></code> endpoint.</p>
|
||||
<p>Generally, Web API requests require a valid OAuth token, but there are a few endpoints
|
||||
which do not require a token. <code class="docutils literal notranslate"><span class="pre">oauth.access</span></code> is one example of this. Since this
|
||||
is the endpoint you’ll use to retrieve the tokens for later API requests,
|
||||
an empty string <code class="docutils literal notranslate"><span class="pre">""</span></code> is acceptable for this request.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@app.route</span><span class="p">(</span><span class="s2">"/finish_auth"</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"POST"</span><span class="p">])</span>
|
||||
<span class="k">def</span> <span class="nf">post_install</span><span class="p">():</span>
|
||||
|
||||
<span class="c1"># Retrieve the auth code from the request params</span>
|
||||
<span class="n">auth_code</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="s1">'code'</span><span class="p">]</span>
|
||||
|
||||
<span class="c1"># An empty string is a valid token for this request</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="s2">""</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Request the auth tokens from Slack</span>
|
||||
<span class="n">auth_response</span> <span class="o">=</span> <span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"oauth.access"</span><span class="p">,</span>
|
||||
<span class="n">client_id</span><span class="o">=</span><span class="n">client_id</span><span class="p">,</span>
|
||||
<span class="n">client_secret</span><span class="o">=</span><span class="n">client_secret</span><span class="p">,</span>
|
||||
<span class="n">code</span><span class="o">=</span><span class="n">auth_code</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A successful request to <code class="docutils literal notranslate"><span class="pre">oauth.access</span></code> will yield two tokens: A <code class="docutils literal notranslate"><span class="pre">user</span></code>
|
||||
token and a <code class="docutils literal notranslate"><span class="pre">bot</span></code> token. The <code class="docutils literal notranslate"><span class="pre">user</span></code> token <code class="docutils literal notranslate"><span class="pre">auth_response['access_token']</span></code>
|
||||
is used to make requests on behalf of the authorizing user and the <code class="docutils literal notranslate"><span class="pre">bot</span></code>
|
||||
token <code class="docutils literal notranslate"><span class="pre">auth_response['bot']['bot_access_token']</span></code> is for making requests
|
||||
on behalf of your app’s bot user.</p>
|
||||
<p>If your Slack app includes a bot user, upon approval the JSON response will contain
|
||||
an additional node containing an access token to be specifically used for your bot
|
||||
user, within the context of the approving team.</p>
|
||||
<p>When you use Web API methods on behalf of your bot user, you should use this bot
|
||||
user access token instead of the top-level access token granted to your application.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Save the bot token to an environmental variable or to your data store</span>
|
||||
<span class="c1"># for later use</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_USER_TOKEN"</span><span class="p">]</span> <span class="o">=</span> <span class="n">auth_response</span><span class="p">[</span><span class="s1">'access_token'</span><span class="p">]</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_BOT_TOKEN"</span><span class="p">]</span> <span class="o">=</span> <span class="n">auth_response</span><span class="p">[</span><span class="s1">'bot'</span><span class="p">][</span><span class="s1">'bot_access_token'</span><span class="p">]</span>
|
||||
|
||||
<span class="c1"># Don't forget to let the user know that auth has succeeded!</span>
|
||||
<span class="k">return</span> <span class="s2">"Auth complete!"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Once your user has completed the OAuth flow, you’ll be able to use the provided
|
||||
tokens to make a variety of Web API calls on behalf of the user and your app’s bot user.</p>
|
||||
<p>See the <a class="reference internal" href="basic_usage.html#web-api-examples"><span class="std std-ref">Web API usage</span></a> section of this documentation for usage examples.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,545 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Basic Usage — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Basic Usage</div>
|
||||
<div class="card">
|
||||
<div class="section" id="basic-usage">
|
||||
<span id="web-api-examples"></span><h1>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h1>
|
||||
<p>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.</p>
|
||||
<p>This package is a modular wrapper designed to make Slack <a class="reference external" href="https://api.slack.com/web">Web API</a> calls simpler and easier for your
|
||||
app. Provided below are examples of how to interact with commonly used API endpoints, but this is by no means
|
||||
a complete list. Review the full list of available methods <a class="reference external" href="https://api.slack.com/methods">here</a>.</p>
|
||||
<p>See <a class="reference internal" href="auth.html#handling-tokens"><span class="std std-ref">Tokens & Authentication</span></a> for API token handling best practices.</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="sending-a-message">
|
||||
<h2>Sending a message<a class="headerlink" href="#sending-a-message" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The primary use of Slack is sending messages. Whether you’re sending a message
|
||||
to a user or to a channel, this method handles both.</p>
|
||||
<p>To send a message to a channel, use the channel’s ID. For IMs, use the user’s ID.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.postMessage"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">text</span><span class="o">=</span><span class="s2">"Hello from Python! :tada:"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>There are some unique options specific to sending IMs, so be sure to read the <strong>channels</strong>
|
||||
section of the <a class="reference external" href="https://api.slack.com/methods/chat.postMessage#channels">chat.postMessage</a>
|
||||
page for a full list of formatting and authorship options.</p>
|
||||
<p>Sending an ephemeral message, which is only visible to an assigned user in a specified channel, is nearly the same
|
||||
as sending a regular message, but with an additional <code class="docutils literal notranslate"><span class="pre">user</span></code> parameter.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.postEphemeral"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">text</span><span class="o">=</span><span class="s2">"Hello from Python! :tada:"</span><span class="p">,</span>
|
||||
<span class="n">user</span><span class="o">=</span><span class="s2">"U0XXXXXXX"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/chat.postEphemeral">chat.postEphemeral</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="customizing-a-message-s-layout">
|
||||
<h2>Customizing a message’s layout<a class="headerlink" href="#customizing-a-message-s-layout" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The chat.postMessage method takes an optional blocks argument that allows you to customize the layout of a message.
|
||||
Blocks for Web API methods are all specified in a single object literal, so just add additional keys for any optional argument.</p>
|
||||
<p>To send a message to a channel, use the channel’s ID. For IMs, use the user’s ID.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.postMessage"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">blocks</span><span class="o">=</span><span class="p">[</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"section"</span><span class="p">,</span>
|
||||
<span class="s2">"text"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mrkdwn"</span><span class="p">,</span>
|
||||
<span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Danny Torrence left the following review for your property:"</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"section"</span><span class="p">,</span>
|
||||
<span class="s2">"text"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mrkdwn"</span><span class="p">,</span>
|
||||
<span class="s2">"text"</span><span class="p">:</span> <span class="s2">"<https://example.com|Overlook Hotel> </span><span class="se">\n</span><span class="s2"> :star: </span><span class="se">\n</span><span class="s2"> Doors had too many axe holes, guest in room "</span> <span class="o">+</span>
|
||||
<span class="s2">"237 was far too rowdy, whole place felt stuck in the 1920s."</span>
|
||||
<span class="p">},</span>
|
||||
<span class="s2">"accessory"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"image"</span><span class="p">,</span>
|
||||
<span class="s2">"image_url"</span><span class="p">:</span> <span class="s2">"https://images.pexels.com/photos/750319/pexels-photo-750319.jpeg"</span><span class="p">,</span>
|
||||
<span class="s2">"alt_text"</span><span class="p">:</span> <span class="s2">"Haunted hotel image"</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"section"</span><span class="p">,</span>
|
||||
<span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mrkdwn"</span><span class="p">,</span>
|
||||
<span class="s2">"text"</span><span class="p">:</span> <span class="s2">"*Average Rating*</span><span class="se">\n</span><span class="s2">1.0"</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Note:</strong> You can use the <a href="#id1"><span class="problematic" id="id2">`</span></a>Block Kit Builder <<a class="reference external" href="https://api.slack.com/tools/block-kit-builder">https://api.slack.com/tools/block-kit-builder</a>>`for a playground where you can prototype your message’s look and feel.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="replying-to-messages-and-creating-threads">
|
||||
<h2>Replying to messages and creating threads<a class="headerlink" href="#replying-to-messages-and-creating-threads" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Threaded messages are just like regular messages, except thread replies are grouped together to provide greater context
|
||||
to the user. You can reply to a thread or start a new threaded conversation by simply passing the original message’s <code class="docutils literal notranslate"><span class="pre">ts</span></code>
|
||||
ID in the <code class="docutils literal notranslate"><span class="pre">thread_ts</span></code> attribute when posting a message. If you’re replying to a threaded message, you’ll pass the <cite>thread_ts</cite>
|
||||
ID of the message you’re replying to.</p>
|
||||
<p>A channel or DM conversation is a nearly linear timeline of messages exchanged between people, bots, and apps.
|
||||
When one of these messages is replied to, it becomes the parent of a thread. By default, threaded replies do not
|
||||
appear directly in the channel, instead relegated to a kind of forked timeline descending from the parent message.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.postMessage"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">text</span><span class="o">=</span><span class="s2">"Hello from Python! :tada:"</span><span class="p">,</span>
|
||||
<span class="n">thread_ts</span><span class="o">=</span><span class="s2">"1476746830.000003"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>By default, <code class="docutils literal notranslate"><span class="pre">reply_broadcast</span></code> is set to <code class="docutils literal notranslate"><span class="pre">False</span></code>. To indicate your reply is germane to all members of a channel,
|
||||
set the <code class="docutils literal notranslate"><span class="pre">reply_broadcast</span></code> boolean parameter to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.postMessage"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">text</span><span class="o">=</span><span class="s2">"Hello from Python! :tada:"</span><span class="p">,</span>
|
||||
<span class="n">thread_ts</span><span class="o">=</span><span class="s2">"1476746830.000003"</span><span class="p">,</span>
|
||||
<span class="n">reply_broadcast</span><span class="o">=</span><span class="bp">True</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Note:</strong> While threaded messages may contain attachments and message buttons, when your reply is broadcast to the
|
||||
channel, it’ll actually be a reference to your reply, not the reply itself.
|
||||
So, when appearing in the channel, it won’t contain any attachments or message buttons. Also note that updates and
|
||||
deletion of threaded replies works the same as regular messages.</p>
|
||||
<p>See the <a class="reference external" href="https://api.slack.com/docs/message-threading#forking_conversations">Threading messages together</a>
|
||||
article for more information.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="updating-the-content-of-a-message">
|
||||
<h2>Updating the content of a message<a class="headerlink" href="#updating-the-content-of-a-message" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Let’s say you have a bot which posts the status of a request. When that request
|
||||
is updated, you’ll want to update the message to reflect it’s state. Or your user
|
||||
might want to fix a typo or change some wording. This is how you’ll make those changes.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.update"</span><span class="p">,</span>
|
||||
<span class="n">ts</span><span class="o">=</span><span class="s2">"1476746830.000003"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">text</span><span class="o">=</span><span class="s2">"Hello from Python! :tada:"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/chat.update">chat.update</a> for formatting options
|
||||
and some special considerations when calling this with a bot user.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="deleting-a-message">
|
||||
<h2>Deleting a message<a class="headerlink" href="#deleting-a-message" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Sometimes you need to delete things.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.delete"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">ts</span><span class="o">=</span><span class="s2">"1476745373.000002"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/chat.delete">chat.delete</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="adding-or-removing-an-emoji-reaction">
|
||||
<h2>Adding or removing an emoji reaction<a class="headerlink" href="#adding-or-removing-an-emoji-reaction" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can quickly respond to any message on Slack with an emoji reaction. Reactions
|
||||
can be used for any purpose: voting, checking off to-do items, showing excitement — and just for fun.</p>
|
||||
<p>This method adds a reaction (emoji) to an item (<code class="docutils literal notranslate"><span class="pre">file</span></code>, <code class="docutils literal notranslate"><span class="pre">file</span> <span class="pre">comment</span></code>, <code class="docutils literal notranslate"><span class="pre">channel</span> <span class="pre">message</span></code>, <code class="docutils literal notranslate"><span class="pre">group</span> <span class="pre">message</span></code>, or <code class="docutils literal notranslate"><span class="pre">direct</span> <span class="pre">message</span></code>). One of file, file_comment, or the combination of channel and timestamp must be specified.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"reactions.add"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="s2">"thumbsup"</span><span class="p">,</span>
|
||||
<span class="n">timestamp</span><span class="o">=</span><span class="s2">"1234567890.123456"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Removing an emoji reaction is basically the same format, but you’ll use <code class="docutils literal notranslate"><span class="pre">reactions.remove</span></code> instead of <code class="docutils literal notranslate"><span class="pre">reactions.add</span></code></p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"reactions.remove"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXX"</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="s2">"thumbsup"</span><span class="p">,</span>
|
||||
<span class="n">timestamp</span><span class="o">=</span><span class="s2">"1234567890.123456"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/reactions.add">reactions.add</a> and <a class="reference external" href="https://api.slack.com/methods/reactions.remove">reactions.remove</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="getting-a-list-of-channels">
|
||||
<h2>Getting a list of channels<a class="headerlink" href="#getting-a-list-of-channels" title="Permalink to this headline">¶</a></h2>
|
||||
<p>At some point, you’ll want to find out what channels are available to your app. This is how you get that list.</p>
|
||||
<p><strong>Note:</strong> This call requires the <code class="docutils literal notranslate"><span class="pre">channels:read</span></code> scope.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span><span class="s2">"channels.list"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Archived channels are included by default. You can exclude them by passing <code class="docutils literal notranslate"><span class="pre">exclude_archived=1</span></code> to your request.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"channels.list"</span><span class="p">,</span>
|
||||
<span class="n">exclude_archived</span><span class="o">=</span><span class="mi">1</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/channels.list">channels.list</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="getting-a-channel-s-info">
|
||||
<h2>Getting a channel’s info<a class="headerlink" href="#getting-a-channel-s-info" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Once you have the ID for a specific channel, you can fetch information about that channel.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"channels.info"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXX"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/channels.info">channels.info</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="joining-a-channel">
|
||||
<h2>Joining a channel<a class="headerlink" href="#joining-a-channel" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Channels are the social hub of most Slack teams. Here’s how you hop into one:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"channels.join"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXY"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you are already in the channel, the response is slightly different.
|
||||
<code class="docutils literal notranslate"><span class="pre">already_in_channel</span></code> will be true, and a limited <code class="docutils literal notranslate"><span class="pre">channel</span></code> object will be returned. Bot users cannot join a channel on their own, they need to be invited by another user.</p>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/channels.join">channels.join</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="leaving-a-channel">
|
||||
<h2>Leaving a channel<a class="headerlink" href="#leaving-a-channel" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Maybe you’ve finished up all the business you had in a channel, or maybe you
|
||||
joined one by accident. This is how you leave a channel.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"channels.leave"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXX"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/channels.leave">channels.leave</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="get-a-list-of-team-members">
|
||||
<h2>Get a list of team members<a class="headerlink" href="#get-a-list-of-team-members" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span><span class="s2">"users.list"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/users.list">users.list</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="uploading-files">
|
||||
<h2>Uploading files<a class="headerlink" href="#uploading-files" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'thinking_very_much.png'</span><span class="p">)</span> <span class="k">as</span> <span class="n">file_content</span><span class="p">:</span>
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"files.upload"</span><span class="p">,</span>
|
||||
<span class="n">channels</span><span class="o">=</span><span class="s2">"C3UKJTQAC"</span><span class="p">,</span>
|
||||
<span class="nb">file</span><span class="o">=</span><span class="n">file_content</span><span class="p">,</span>
|
||||
<span class="n">title</span><span class="o">=</span><span class="s2">"Test upload"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/files.upload">files.upload</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="web-api-rate-limits">
|
||||
<h2>Web API Rate Limits<a class="headerlink" href="#web-api-rate-limits" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Slack allows applications to send no more than one message per second. We allow bursts over that
|
||||
limit for short periods. However, if your app continues to exceed the limit over a longer period
|
||||
of time it will be rate limited.</p>
|
||||
<p>Here’s a very basic example of how one might deal with rate limited requests.</p>
|
||||
<p>If you go over these limits, Slack will start returning a HTTP 429 Too Many Requests error,
|
||||
a JSON object containing the number of calls you have been making, and a Retry-After header
|
||||
containing the number of seconds until you can retry.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
<span class="kn">import</span> <span class="nn">time</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Simple wrapper for sending a Slack message</span>
|
||||
<span class="k">def</span> <span class="nf">send_slack_message</span><span class="p">(</span><span class="n">channel</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"chat.postMessage"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="n">channel</span><span class="p">,</span>
|
||||
<span class="n">text</span><span class="o">=</span><span class="n">message</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="c1"># Make the API call and save results to `response`</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">send_slack_message</span><span class="p">(</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span> <span class="s2">"Hello, from Python!"</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Check to see if the message sent successfully.</span>
|
||||
<span class="c1"># If the message succeeded, `response["ok"]`` will be `True`</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="p">[</span><span class="s2">"ok"</span><span class="p">]:</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s2">"Message posted successfully: "</span> <span class="o">+</span> <span class="n">response</span><span class="p">[</span><span class="s2">"message"</span><span class="p">][</span><span class="s2">"ts"</span><span class="p">])</span>
|
||||
<span class="c1"># If the message failed, check for rate limit headers in the response</span>
|
||||
<span class="k">elif</span> <span class="n">response</span><span class="p">[</span><span class="s2">"ok"</span><span class="p">]</span> <span class="ow">is</span> <span class="bp">False</span> <span class="ow">and</span> <span class="n">response</span><span class="p">[</span><span class="s2">"headers"</span><span class="p">][</span><span class="s2">"Retry-After"</span><span class="p">]:</span>
|
||||
<span class="c1"># The `Retry-After` header will tell you how long to wait before retrying</span>
|
||||
<span class="n">delay</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">response</span><span class="p">[</span><span class="s2">"headers"</span><span class="p">][</span><span class="s2">"Retry-After"</span><span class="p">])</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s2">"Rate limited. Retrying in "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span> <span class="o">+</span> <span class="s2">" seconds"</span><span class="p">)</span>
|
||||
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
|
||||
<span class="n">send_slack_message</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">channel</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See the documentation on <a class="reference external" href="https://api.slack.com/docs/rate-limits">Rate Limiting</a> for more info.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,365 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Changelog — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Changelog</div>
|
||||
<div class="card">
|
||||
<div class="section" id="changelog">
|
||||
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="v1-3-0-2018-09-11">
|
||||
<h2>v1.3.0 (2018-09-11)<a class="headerlink" href="#v1-3-0-2018-09-11" title="Permalink to this headline">¶</a></h2>
|
||||
<p>## New Features
|
||||
- Adds support for short lived tokens and automatic token refresh #347 (Thanks @roach!)</p>
|
||||
<p>## Other
|
||||
- update RTM rate limiting comment and error message #308 (Thanks @benoitlavigne!)
|
||||
- Use logging instead of traceback #309 (Thanks @harlowja!)
|
||||
- Remove Python 3.3 from test environments #346 (Thanks @roach!)
|
||||
- Enforced linting when using VSCode. #347 (Thanks @roach!)</p>
|
||||
</div>
|
||||
<div class="section" id="v1-2-1-2018-03-26">
|
||||
<h2>v1.2.1 (2018-03-26)<a class="headerlink" href="#v1-2-1-2018-03-26" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Added rate limit handling for rtm connections (thanks @jayalane!)</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="v1-2-0-2018-03-20">
|
||||
<h2>v1.2.0 (2018-03-20)<a class="headerlink" href="#v1-2-0-2018-03-20" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>You can now tell the RTM client to automatically reconnect by passing <cite>auto_reconnect=True</cite></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="v1-1-3-2018-03-01">
|
||||
<h2>v1.1.3 (2018-03-01)<a class="headerlink" href="#v1-1-3-2018-03-01" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Fixed another API param encoding bug. It encodes things properly now.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="v1-1-2-2018-01-31">
|
||||
<h2>v1.1.2 (2018-01-31)<a class="headerlink" href="#v1-1-2-2018-01-31" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Fixed an encoding issue which was encoding some Web API params incorrectly (sorry)</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="v1-1-1-2018-01-30">
|
||||
<h2>v1.1.1 (2018-01-30)<a class="headerlink" href="#v1-1-1-2018-01-30" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Adds HTTP response headers to <cite>api_call</cite> responses to expose things like rate limit info</li>
|
||||
<li>Moves <cite>token</cite> into auth header rather than request params</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-1-0-2017-11-21">
|
||||
<h2>v1.1.0 (2017-11-21)<a class="headerlink" href="#v1-1-0-2017-11-21" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Aadds new SlackClientError and ResponseParseError types to describe errors - thanks @aoberoi!</li>
|
||||
<li>Fix Build Error (#245) - thanks @stasfilin!</li>
|
||||
<li>include email as user property (#173) - thanks @acaire!</li>
|
||||
<li>Add http reply into slack login and slack connection error (#216) - thanks @harlowja!</li>
|
||||
<li>Removed unused exception class (#233)</li>
|
||||
<li>Fix rtm_send_message bug (#225) - thanks @kt5356!</li>
|
||||
<li>Allow use of custom parameters on rtm_connect() (#210) - thanks @kamushadenes!</li>
|
||||
<li>Fix link to rtm.connect docs (#223) - @sampart!</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-9-2017-08-31">
|
||||
<h2>v1.0.9 (2017-08-31)<a class="headerlink" href="#v1-0-9-2017-08-31" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Fixed rtm_send_message ID bug introduced in 1.0.8</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-8-2017-08-31">
|
||||
<h2>v1.0.8 (2017-08-31)<a class="headerlink" href="#v1-0-8-2017-08-31" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Added rtm.connect support</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-7-2017-08-02">
|
||||
<h2>v1.0.7 (2017-08-02)<a class="headerlink" href="#v1-0-7-2017-08-02" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Fixes an issue where connecting over RTM to large teams may result in “Websocket URL expired” errors</li>
|
||||
<li>A load of packaging improvements</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-6-2017-06-12">
|
||||
<h2>v1.0.6 (2017-06-12)<a class="headerlink" href="#v1-0-6-2017-06-12" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Added proxy support (thanks @timfeirg!)</li>
|
||||
<li>Tidied up docs (thanks @schlueter!)</li>
|
||||
<li>Added tox settings for Python 3 testing (thanks @cclauss!)</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-5-2017-01-23">
|
||||
<h2>v1.0.5 (2017-01-23)<a class="headerlink" href="#v1-0-5-2017-01-23" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Allow RTM Channel.send_message to reply to a thread</li>
|
||||
<li>Index users by ID instead of Name (non-breaking change)</li>
|
||||
<li>Added timeout to api calls.</li>
|
||||
<li>Fixed a typo about token access in auth.rst, thanks @kelvintaywl!</li>
|
||||
<li>Added Message Threads to the docs</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-4-2016-12-15">
|
||||
<h2>v1.0.4 (2016-12-15)<a class="headerlink" href="#v1-0-4-2016-12-15" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>fixed the ability to search for a user by ID</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-3-2016-12-13">
|
||||
<h2>v1.0.3 (2016-12-13)<a class="headerlink" href="#v1-0-3-2016-12-13" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>fixed an issue causing RTM connections to fail for large teams</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-2-2016-09-22">
|
||||
<h2>v1.0.2 (2016-09-22)<a class="headerlink" href="#v1-0-2-2016-09-22" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>removed unused ping counter</li>
|
||||
<li>fixed contributor guidelines links</li>
|
||||
<li>updated documentation</li>
|
||||
<li>Fix bug preventing API calls requiring a file ID</li>
|
||||
<li>Removes files from api_calls before JSON encoding, so the request is properly formatted</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-1-2016-03-25">
|
||||
<h2>v1.0.1 (2016-03-25)<a class="headerlink" href="#v1-0-1-2016-03-25" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>fix for __eq__ comparison in channels using ‘#’ in channel name</li>
|
||||
<li>added copyright info to the LICENSE file</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v1-0-0-2016-02-28">
|
||||
<h2>v1.0.0 (2016-02-28)<a class="headerlink" href="#v1-0-0-2016-02-28" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>the <code class="docutils literal notranslate"><span class="pre">api_call</span></code> function now returns a decoded JSON object, rather than a JSON encoded string</li>
|
||||
<li>some <code class="docutils literal notranslate"><span class="pre">api_call</span></code> calls now call actions on the parent server object:
|
||||
- <code class="docutils literal notranslate"><span class="pre">im.open</span></code>
|
||||
- <code class="docutils literal notranslate"><span class="pre">mpim.open</span></code>, <code class="docutils literal notranslate"><span class="pre">groups.create</span></code>, <code class="docutils literal notranslate"><span class="pre">groups.createChild</span></code>
|
||||
- <code class="docutils literal notranslate"><span class="pre">channels.create</span></code>, <cite>channels.join`</cite></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v0-18-0-2016-02-21">
|
||||
<h2>v0.18.0 (2016-02-21)<a class="headerlink" href="#v0-18-0-2016-02-21" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Moves to use semver for versioning</li>
|
||||
<li>Adds support for private groups and MPDMs</li>
|
||||
<li>Switches to use requests instead of urllib</li>
|
||||
<li>Gets Travis CI integration working</li>
|
||||
<li>Fixes some formatting issues so the code will work for python 2.6</li>
|
||||
<li>Cleans up some unused imports, some PEP-8 fixes and a couple bad default args fixes</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="v0-17-0-2016-02-15">
|
||||
<h2>v0.17.0 (2016-02-15)<a class="headerlink" href="#v0-17-0-2016-02-15" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Fixes the server so that it doesn’t add duplicate users or channels to its internal lists, <a class="reference external" href="https://github.com/slackapi/python-slackclient/commit/0cb4bcd6e887b428e27e8059b6278b86ee661aaa">https://github.com/slackapi/python-slackclient/commit/0cb4bcd6e887b428e27e8059b6278b86ee661aaa</a></li>
|
||||
<li>README updates:
|
||||
- Updates the URLs pointing to Slack docs for configuring authentication, <a class="reference external" href="https://github.com/slackapi/python-slackclient/commit/7d01515cebc80918a29100b0e4793790eb83e7b9">https://github.com/slackapi/python-slackclient/commit/7d01515cebc80918a29100b0e4793790eb83e7b9</a>
|
||||
- s/channnels/channels, <a class="reference external" href="https://github.com/slackapi/python-slackclient/commit/d45285d2f1025899dcd65e259624ee73771f94bb">https://github.com/slackapi/python-slackclient/commit/d45285d2f1025899dcd65e259624ee73771f94bb</a></li>
|
||||
<li>Adds users to the local cache when they join the team, <a class="reference external" href="https://github.com/slackapi/python-slackclient/commit/f7bb8889580cc34471ba1ddc05afc34d1a5efa23">https://github.com/slackapi/python-slackclient/commit/f7bb8889580cc34471ba1ddc05afc34d1a5efa23</a></li>
|
||||
<li>Fixes urllib py 2/3 compatibility, <a class="reference external" href="https://github.com/slackapi/python-slackclient/commit/1046cc2375a85a22e94573e2aad954ba7287c886">https://github.com/slackapi/python-slackclient/commit/1046cc2375a85a22e94573e2aad954ba7287c886</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,313 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Conversations API — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Conversations API</div>
|
||||
<div class="card">
|
||||
<div class="section" id="conversations-api">
|
||||
<span id="id1"></span><h1>Conversations API<a class="headerlink" href="#conversations-api" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Slack Conversations API provides your app with a unified interface to work with all the
|
||||
channel-like things encountered in Slack; public channels, private channels, direct messages, group
|
||||
direct messages, and our newest channel type, Shared Channels.</p>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/docs/conversations-api">Conversations API</a> docs for more info.</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="creating-a-direct-message-or-multi-person-direct-message">
|
||||
<h2>Creating a direct message or multi-person direct message<a class="headerlink" href="#creating-a-direct-message-or-multi-person-direct-message" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This Conversations API method opens a multi-person direct message or just a 1:1 direct message.</p>
|
||||
<p><em>Use conversations.create for public or private channels.</em></p>
|
||||
<p>Provide 1 to 8 user IDs in the <code class="docutils literal notranslate"><span class="pre">user</span></code> parameter to open or resume a conversation. Providing only
|
||||
1 ID will create a direct message. Providing more will create an <code class="docutils literal notranslate"><span class="pre">mpim</span></code>.</p>
|
||||
<p>If there are no conversations already in progress including that exact set of members, a new
|
||||
multi-person direct message conversation begins.</p>
|
||||
<p>Subsequent calls to <code class="docutils literal notranslate"><span class="pre">conversations.open</span></code> with the same set of users will return the already
|
||||
existing conversation.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"conversations.open"</span><span class="p">,</span>
|
||||
<span class="n">users</span><span class="o">=</span><span class="p">[</span><span class="s2">"W1234567890"</span><span class="p">,</span><span class="s2">"U2345678901"</span><span class="p">,</span><span class="s2">"U3456789012"</span><span class="p">]</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/conversations.open">conversations.open</a> additional info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="creating-a-public-or-private-channel">
|
||||
<h2>Creating a public or private channel<a class="headerlink" href="#creating-a-public-or-private-channel" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Initiates a public or private channel-based conversation</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"conversations.create"</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="s2">"myprivatechannel"</span><span class="p">,</span>
|
||||
<span class="n">is_private</span><span class="o">=</span><span class="bp">True</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/conversations.create">conversations.create</a> additional info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="getting-information-about-a-conversation">
|
||||
<h2>Getting information about a conversation<a class="headerlink" href="#getting-information-about-a-conversation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This Conversations API method returns information about a workspace conversation.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"conversations.info"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXX"</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/conversations.info">conversations.info</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="getting-a-list-of-conversations">
|
||||
<h2>Getting a list of conversations<a class="headerlink" href="#getting-a-list-of-conversations" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This Conversations API method returns a list of all channel-like conversations in a workspace.
|
||||
The “channels” returned depend on what the calling token has access to and the directives placed
|
||||
in the <code class="docutils literal notranslate"><span class="pre">types</span></code> parameter.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span><span class="s2">"conversations.list"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Only public conversations are included by default. You may include additional conversations types
|
||||
by passing <code class="docutils literal notranslate"><span class="pre">types</span></code> (as a string) into your list request. Additional conversation types include
|
||||
<code class="docutils literal notranslate"><span class="pre">public_channel</span></code> and <code class="docutils literal notranslate"><span class="pre">private_channel</span></code>.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Note that `types` is a string</span>
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"conversations.list"</span><span class="p">,</span>
|
||||
<span class="n">types</span><span class="o">=</span><span class="s2">"public_channel, private_channel"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/conversations.list">conversations.list</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="leaving-a-conversation">
|
||||
<h2>Leaving a conversation<a class="headerlink" href="#leaving-a-conversation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Maybe you’ve finished up all the business you had in a conversation, or maybe you
|
||||
joined one by accident. This is how you leave a conversation.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
|
||||
<span class="s2">"conversations.leave"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXX"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/conversations.leave">conversations.leave</a> for more info.</p>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="get-conversation-members">
|
||||
<h2>Get conversation members<a class="headerlink" href="#get-conversation-members" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Get a list fo the members of a conversation</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span><span class="s2">"conversations.members"</span><span class="p">,</span>
|
||||
<span class="n">channel</span><span class="o">=</span><span class="s2">"C0XXXXXXX"</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/methods/conversations.members">users.list</a> for more info.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,230 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Frequently Asked Questions — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Frequently Asked Questions</div>
|
||||
<div class="card">
|
||||
<div class="section" id="frequently-asked-questions">
|
||||
<h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="what-even-is-product-name-and-why-should-i-care">
|
||||
<h2>What even is Slack Developer Kit for Python and why should I care?<a class="headerlink" href="#what-even-is-product-name-and-why-should-i-care" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Slack Developer Kit for Python is a wrapper around commonly accessed parts of the Slack Platform. It provides basic mechanisms for
|
||||
using the Slack Web API from within your Python app.</p>
|
||||
<p>On the other hand, Slack Developer Kit for Python does not provide access to the Events bot-building API, but
|
||||
[this adapter](<a class="reference external" href="https://github.com/slackapi/python-slack-events-api">https://github.com/slackapi/python-slack-events-api</a>) does.</p>
|
||||
</div>
|
||||
<div class="section" id="omg-i-found-a-bug">
|
||||
<h2>OMG I found a bug!<a class="headerlink" href="#omg-i-found-a-bug" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Well, poop. Take a deep breath, and then let us know on the <a class="reference external" href="http://github.com/SlackAPI/python-slackclient/issues">Issue Tracker</a>. If you’re feeling particularly ambitious,
|
||||
why not submit a <a class="reference external" href="http://github.com/SlackAPI/python-slackclient/pulls">pull request</a> with a bug fix?</p>
|
||||
</div>
|
||||
<div class="section" id="hey-there-s-a-feature-missing">
|
||||
<h2>Hey, there’s a feature missing!<a class="headerlink" href="#hey-there-s-a-feature-missing" title="Permalink to this headline">¶</a></h2>
|
||||
<p>There’s always something more that could be added! You can let us know in the <a class="reference external" href="http://github.com/SlackAPI/python-slackclient/issues">Issue Tracker</a> to start a discussion
|
||||
around the proposed feature, that’s a good start. If you’re feeling particularly ambitious, why not write the feature
|
||||
yourself, and submit a <a class="reference external" href="http://github.com/SlackAPI/python-slackclient/pulls">pull request</a>! We love feedback and we love help and we don’t bite. Much.</p>
|
||||
</div>
|
||||
<div class="section" id="i-d-like-to-contribute-but-how">
|
||||
<h2>I’d like to contribute…but how?<a class="headerlink" href="#i-d-like-to-contribute-but-how" title="Permalink to this headline">¶</a></h2>
|
||||
<p>What an excellent question. First of all, please have a look at our general <a class="reference external" href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">contributing guidelines</a>. We’ll wait for
|
||||
you here.</p>
|
||||
<p>All done? Great! While we’re super excited to incorporate your new feature into Slack Developer Kit for Python, there are a
|
||||
couple of things we want to make sure you’ve given thought to.</p>
|
||||
<ul class="simple">
|
||||
<li>Please write unit tests for your new code. But don’t <strong>just</strong> aim to increase the test coverage, rather, we expect you
|
||||
to have written <strong>thoughtful</strong> tests that ensure your new feature will continue to work as expected, and to help future
|
||||
contributors to ensure they don’t break it!</li>
|
||||
<li>Please document your new feature. Think about <strong>concrete use cases</strong> for your feature, and add a section to the
|
||||
appropriate document, including a <strong>complete</strong> sample program that demonstrates your feature. Don’t forget to update
|
||||
the changelog in <code class="docutils literal notranslate"><span class="pre">changelog.rst</span></code>!</li>
|
||||
</ul>
|
||||
<p>Including these two items with your pull request will totally make our day—and, more importantly, your future users’ days!</p>
|
||||
<p>On that note…</p>
|
||||
</div>
|
||||
<div class="section" id="how-do-i-compile-the-documentation">
|
||||
<h2>How do I compile the documentation?<a class="headerlink" href="#how-do-i-compile-the-documentation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This project’s documentation is generated with <a class="reference external" href="http://www.sphinx-doc.org">Sphinx</a>. If you are editing one of the many
|
||||
reStructuredText files in the <code class="docutils literal notranslate"><span class="pre">docs-src</span></code> folder, you’ll need to rebuild the documentation. It is recommended to run
|
||||
the following steps inside a <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> environment.</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tox -e docs
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Do be sure to add the <code class="docutils literal notranslate"><span class="pre">docs</span></code> folder and its contents to your pull request!</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,189 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Index</div>
|
||||
<div class="card">
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Slack Developer Kit for Python — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="#" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Slack Developer Kit for Python</div>
|
||||
<div class="card">
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
<div class="section" id="product-name">
|
||||
<h1>Slack Developer Kit for Python<a class="headerlink" href="#product-name" title="Permalink to this headline">¶</a></h1>
|
||||
<p>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.</p>
|
||||
<div class="section" id="requirements-and-installation">
|
||||
<h2>Requirements and Installation<a class="headerlink" href="#requirements-and-installation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>We recommend using <a class="reference external" href="https://pypi.python.org/pypi">PyPI</a> to install Slack Developer Kit for Python</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install slackclient
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Of course, if you prefer doing things the hard way, you can always implement Slack Developer Kit for Python
|
||||
by pulling down the source code directly into your project:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/slackapi/python-slackclient.git
|
||||
pip install -r requirements.txt
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="getting-help">
|
||||
<h2>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:</p>
|
||||
<ul class="simple">
|
||||
<li>Use our <a class="reference external" href="https://github.com/slackapi/python-slackclient/issues">Github Issue Tracker</a> for reporting bugs or requesting features.</li>
|
||||
<li>Visit the <a class="reference external" href="http://community.botkit.ai">Bot Developer Hangout</a> for getting help using Slack Developer Kit for Python or just generally bond with your fellow Slack developers.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,182 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title><no title> — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title"><no title></div>
|
||||
<div class="card">
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Sphinx inventory version 2
|
||||
# Project: Slack Developer Kit for Python
|
||||
# Version: 1.0
|
||||
# The remainder of this file is compressed using zlib.
|
||||
xÚ}“ÁNÃ0 †ïy
|
||||
KCEâŠR!&4iŒq®¼Ök£¥Iפc{{’¥-ÉÜâßþìØNp¥:Úw…Ê!¹tÂMej©;2ìLXÛû—jCRÃ%¤V"ixŽ†+ÉV¨yžuK
|
||||
Á@öü£àÓ ,¯P–$T£è㟓åJî¨ÕÇr:"BGOE±é|Ó6ü˜AàŠÄù “HJ ñ;ë·áM¬éë¿´´íìtÄR½¡Þ;ÒGŒ•$¹,h × T<>OÝ‘ÙÎ Áe™?ó72¹€×>ú@k‚²ÛiA[“¾#(Ð û)Ü_8¨ù!0ßÀ3íì°‹¾qkÕÂü`*»ßš º !=h>Á½T`¸ôÀjUœé±9$ƒÃ3Ut‚ún[B‘^SR“¶ÏÃõá. sÙ0 `a]°´.˜<>ìÕb9»fg °ƒ¿rþ“Q¶y_Íký ½î øÜÃIh<49>u#èd…§Ã6þŽoàM
|
||||
|
|
@ -0,0 +1,290 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Real Time Messaging (RTM) — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Real Time Messaging (RTM)</div>
|
||||
<div class="card">
|
||||
<div class="section" id="real-time-messaging-rtm">
|
||||
<span id="real-time-messaging"></span><h1>Real Time Messaging (RTM)<a class="headerlink" href="#real-time-messaging-rtm" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The <a class="reference external" href="https://api.slack.com/rtm">Real Time Messaging (RTM) API</a> is a WebSocket-based API that allows you to
|
||||
receive events from Slack in real time and send messages as users.</p>
|
||||
<p>If you prefer events to be pushed to you instead, we recommend using the
|
||||
HTTP-based <a class="reference external" href="https://api.slack.com/events-api">Events API</a> instead.
|
||||
Most event types supported by the RTM API are also available
|
||||
in <a class="reference external" href="https://api.slack.com/events/api">the Events API</a>.</p>
|
||||
<p>See <a class="reference internal" href="auth.html#handling-tokens"><span class="std std-ref">Tokens & Authentication</span></a> for API token handling best practices.</p>
|
||||
<div class="section" id="connecting-to-the-rtm-api">
|
||||
<h2>Connecting to the RTM API<a class="headerlink" href="#connecting-to-the-rtm-api" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">sc</span><span class="o">.</span><span class="n">rtm_connect</span><span class="p">():</span>
|
||||
<span class="k">while</span> <span class="n">sc</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">connected</span> <span class="ow">is</span> <span class="bp">True</span><span class="p">:</span>
|
||||
<span class="k">print</span> <span class="n">sc</span><span class="o">.</span><span class="n">rtm_read</span><span class="p">()</span>
|
||||
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">print</span> <span class="s2">"Connection Failed"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you connect successfully the first event received will be a hello:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||||
<span class="sa">u</span><span class="s1">'type'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'hello'</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If there was a problem connecting an error will be returned, including a descriptive error message:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||||
<span class="sa">u</span><span class="s1">'type'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'error'</span><span class="p">,</span>
|
||||
<span class="sa">u</span><span class="s1">'error'</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="sa">u</span><span class="s1">'code'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||||
<span class="sa">u</span><span class="s1">'msg'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'Socket URL has expired'</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="rtm-start-vs-rtm-connect">
|
||||
<h2>rtm.start vs rtm.connect<a class="headerlink" href="#rtm-start-vs-rtm-connect" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you expect your app to be used on large teams, we recommend starting the RTM client with <cite>rtm.connect</cite> rather than the default connection method for this client, <cite>rtm.start</cite>.
|
||||
<cite>rtm.connect</cite> provides a lighter initial connection payload, without the team’s channel and user information included. You’ll need to request channel and user info via
|
||||
the Web API separately.</p>
|
||||
<p>To do this, simply pass <cite>with_team_state=False</cite> into the <cite>rtm_connect</cite> call, like so:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">sc</span><span class="o">.</span><span class="n">rtm_connect</span><span class="p">(</span><span class="n">with_team_state</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
|
||||
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
|
||||
<span class="k">print</span> <span class="n">sc</span><span class="o">.</span><span class="n">rtm_read</span><span class="p">()</span>
|
||||
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">print</span> <span class="s2">"Connection Failed"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Passing <cite>auto_reconnect=True</cite> will tell the websocket client to automatically reconnect if the connection gets dropped.</p>
|
||||
<p>See the <a class="reference external" href="https://api.slack.com/methods/rtm.start">rtm.start docs</a> and the <a class="reference external" href="https://api.slack.com/methods/rtm.connect">rtm.connect docs</a>
|
||||
for more details.</p>
|
||||
</div>
|
||||
<div class="section" id="rtm-events">
|
||||
<h2>RTM Events<a class="headerlink" href="#rtm-events" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||||
<span class="sa">u</span><span class="s1">'type'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'message'</span><span class="p">,</span>
|
||||
<span class="sa">u</span><span class="s1">'ts'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'1358878749.000002'</span><span class="p">,</span>
|
||||
<span class="sa">u</span><span class="s1">'user'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'U023BECGF'</span><span class="p">,</span>
|
||||
<span class="sa">u</span><span class="s1">'text'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'Hello'</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/rtm#events">RTM Events</a> for a complete list of events.</p>
|
||||
</div>
|
||||
<div class="section" id="sending-messages-via-the-rtm-api">
|
||||
<h2>Sending messages via the RTM API<a class="headerlink" href="#sending-messages-via-the-rtm-api" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can send a message to Slack by sending JSON over the websocket connection.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">rtm_send_message</span><span class="p">(</span><span class="s2">"welcome-test"</span><span class="p">,</span> <span class="s2">"test"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You can send a message to a private group or direct message channel in the same
|
||||
way, but using a Group ID (<code class="docutils literal notranslate"><span class="pre">C024BE91L</span></code>) or DM channel ID (<code class="docutils literal notranslate"><span class="pre">D024BE91L</span></code>).</p>
|
||||
<p>You can send a message in reply to a thread using the <code class="docutils literal notranslate"><span class="pre">thread</span></code> argument, and
|
||||
optionally broadcast that message back to the channel by setting
|
||||
<code class="docutils literal notranslate"><span class="pre">reply_broadcast</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span>
|
||||
|
||||
<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span>
|
||||
<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span>
|
||||
|
||||
<span class="n">sc</span><span class="o">.</span><span class="n">rtm_send_message</span><span class="p">(</span><span class="s2">"welcome-test"</span><span class="p">,</span> <span class="s2">"test"</span><span class="p">,</span> <span class="s2">"1482960137.003543"</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://api.slack.com/docs/message-threading#threads_party">Threading messages</a>
|
||||
for more details on using threads.</p>
|
||||
<p>The RTM API only supports posting messages with <a class="reference external" href="https://api.slack.com/docs/message-formatting">basic formatting</a>.
|
||||
It does not support attachments or other message formatting modes.</p>
|
||||
<blockquote>
|
||||
<div>To post a more complex message as a user, see <a class="reference internal" href="basic_usage.html#web-api-examples"><span class="std std-ref">Web API usage</span></a>.</div></blockquote>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,204 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — Slack Developer Kit for Python</title>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || []; w[l].push({
|
||||
'gtm.start':
|
||||
new Date().getTime(), event: 'gtm.js'
|
||||
}); var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
|
||||
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
|
||||
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<link href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css" rel="stylesheet" type="text/css">
|
||||
<link href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css" rel="stylesheet" type="text/css">
|
||||
<link rel="stylesheet" href="./_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="./_static/docs.css" type="text/css" />
|
||||
<link id="favicon" rel="shortcut icon" href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png" type="image/png" />
|
||||
<link rel="top" title="Slack Developer Kit for Python 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body class="api light_theme">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<header>
|
||||
<a id="menu_toggle" class="no_transition show_on_mobile">
|
||||
<span class="menu_icon"></span>
|
||||
<span class="vert_divider"></span>
|
||||
</a>
|
||||
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile" style="float:left; display: inline-block;">
|
||||
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
|
||||
</a>
|
||||
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;">
|
||||
<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>
|
||||
</span>
|
||||
<div class="header_nav">
|
||||
<a href="https://github.com/SlackAPI/python-slackclient" class="btn header_btn float_right" data-qa="go_to_slack">Go
|
||||
to GitHub</a>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="page">
|
||||
<div id="page_contents" class="clearfix">
|
||||
<!-- Sidebar Content -->
|
||||
<nav id="api_nav" class="col span_1_of_4">
|
||||
<div id="api_sections">
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#handling-tokens-and-other-sensitive-data">Handling tokens and other sensitive data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-apps">Single-Workspace Apps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="auth.html#the-oauth-flow">The OAuth flow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="basic_usage.html">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#sending-a-message">Sending a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#customizing-a-message-s-layout">Customizing a message’s layout</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#replying-to-messages-and-creating-threads">Replying to messages and creating threads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-the-content-of-a-message">Updating the content of a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#deleting-a-message">Deleting a message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#adding-or-removing-an-emoji-reaction">Adding or removing an emoji reaction</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-list-of-channels">Getting a list of channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#getting-a-channel-s-info">Getting a channel’s info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#joining-a-channel">Joining a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#leaving-a-channel">Leaving a channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#get-a-list-of-team-members">Get a list of team members</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#uploading-files">Uploading files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#web-api-rate-limits">Web API Rate Limits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-direct-message-or-multi-person-direct-message">Creating a direct message or multi-person direct message</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-a-public-or-private-channel">Creating a public or private channel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-information-about-a-conversation">Getting information about a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-a-list-of-conversations">Getting a list of conversations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="conversations.html#get-conversation-members">Get conversation members</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-even-is-product-name-and-why-should-i-care">What even is Slack Developer Kit for Python and why should I care?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#omg-i-found-a-bug">OMG I found a bug!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#hey-there-s-a-feature-missing">Hey, there’s a feature missing!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-d-like-to-contribute-but-how">I’d like to contribute…but how?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-3-0-2018-09-11">v1.3.0 (2018-09-11)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-1-2018-03-26">v1.2.1 (2018-03-26)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-2-0-2018-03-20">v1.2.0 (2018-03-20)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-3-2018-03-01">v1.1.3 (2018-03-01)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-2-2018-01-31">v1.1.2 (2018-01-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-1-2018-01-30">v1.1.1 (2018-01-30)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-1-0-2017-11-21">v1.1.0 (2017-11-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-9-2017-08-31">v1.0.9 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-8-2017-08-31">v1.0.8 (2017-08-31)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-7-2017-08-02">v1.0.7 (2017-08-02)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-6-2017-06-12">v1.0.6 (2017-06-12)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-5-2017-01-23">v1.0.5 (2017-01-23)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-4-2016-12-15">v1.0.4 (2016-12-15)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-3-2016-12-13">v1.0.3 (2016-12-13)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-2-2016-09-22">v1.0.2 (2016-09-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-1-2016-03-25">v1.0.1 (2016-03-25)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v1-0-0-2016-02-28">v1.0.0 (2016-02-28)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-18-0-2016-02-21">v0.18.0 (2016-02-21)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-17-0-2016-02-15">v0.17.0 (2016-02-15)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<ul id="footer_nav">
|
||||
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>
|
||||
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
|
||||
<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>
|
||||
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
|
||||
</ul>
|
||||
|
||||
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
|
||||
Community
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
<!-- /Sidebar Content -->
|
||||
|
||||
<!-- Body Content -->
|
||||
<div class="col span_3_of_4">
|
||||
<div class="section-title">Search</div>
|
||||
<div class="card">
|
||||
<h1 id="search-documentation">Search</h1>
|
||||
<div id="fallback" class="admonition warning">
|
||||
<script type="text/javascript">$('#fallback').hide();</script>
|
||||
<p>
|
||||
Please activate JavaScript to enable the search
|
||||
functionality.
|
||||
</p>
|
||||
</div>
|
||||
<p>
|
||||
From here you can search these documents. Enter your search
|
||||
words into the box below and click "search". Note that the search
|
||||
function will automatically search for all of the words. Pages
|
||||
containing fewer words won't appear in the result list.
|
||||
</p>
|
||||
<form action="" method="get">
|
||||
<input type="text" name="q" value="" />
|
||||
<input type="submit" value="search" />
|
||||
<span id="search-progress" style="padding-left: 10px"></span>
|
||||
</form>
|
||||
|
||||
<div id="search-results">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="clear_both large_bottom_margin"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- /Body Content -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p class="light tiny align_center">© 2019 Slack Technologies, Inc. and contributors</p>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
window.ga = window.ga || function () { (ga.q = ga.q || []).push(arguments) }; ga.l = +new Date;
|
||||
ga('create', 'UA-56978219-13', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,3 @@
|
|||
--index-url https://pypi.python.org/simple/
|
||||
|
||||
-e .
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
[metadata]
|
||||
description-file = README.rst
|
||||
|
||||
[bdist_wheel]
|
||||
universal=1
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
from setuptools import setup, find_packages
|
||||
import io
|
||||
import os
|
||||
import re
|
||||
|
||||
|
||||
def read(*names, **kwargs):
|
||||
with io.open(
|
||||
os.path.join(os.path.dirname(__file__), *names),
|
||||
encoding=kwargs.get("encoding", "utf8")
|
||||
) as fp:
|
||||
return fp.read()
|
||||
|
||||
|
||||
long_description = read('README.rst')
|
||||
|
||||
|
||||
def find_version(*file_paths):
|
||||
version_file = read(*file_paths)
|
||||
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
|
||||
if version_match:
|
||||
return version_match.group(1)
|
||||
raise RuntimeError("Unable to find version string.")
|
||||
|
||||
|
||||
setup(name='slackclient',
|
||||
version=find_version('slackclient', 'version.py'),
|
||||
description='Slack API clients for Web API and RTM API',
|
||||
long_description=long_description,
|
||||
url='https://github.com/slackapi/python-slackclient',
|
||||
author='Slack Technologies, Inc.',
|
||||
author_email='opensource@slack.com',
|
||||
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 :: 2',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
'Programming Language :: Python :: 3.6',
|
||||
],
|
||||
keywords='slack slack-web slack-rtm chat chatbots bots chatops',
|
||||
packages=find_packages(exclude=['docs', 'docs-src', 'tests']),
|
||||
install_requires=[
|
||||
'websocket-client >=0.35, <0.55.0',
|
||||
'requests >=2.11, <3.0a0',
|
||||
'six >=1.10, <2.0a0',
|
||||
])
|
||||
|
|
@ -0,0 +1 @@
|
|||
from .client import SlackClient # noqa
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
class Channel(object):
|
||||
'''
|
||||
A Channel represents a public or private Slack Channel instance
|
||||
'''
|
||||
def __init__(self, server, name, channel_id, members=None):
|
||||
self.server = server
|
||||
self.name = name
|
||||
self.id = channel_id
|
||||
self.members = [] if members is None else members
|
||||
|
||||
def __eq__(self, compare_str):
|
||||
if self.name == compare_str or "#" + self.name == compare_str or self.id == compare_str:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def __hash__(self):
|
||||
return hash(self.id)
|
||||
|
||||
def __str__(self):
|
||||
data = ""
|
||||
for key in list(self.__dict__.keys()):
|
||||
data += "{0} : {1}\n".format(key, str(self.__dict__[key])[:40])
|
||||
return data
|
||||
|
||||
def __repr__(self):
|
||||
return self.__str__()
|
||||
|
||||
def send_message(self, message, thread=None, reply_broadcast=False):
|
||||
'''
|
||||
Sends a message to a this Channel.
|
||||
|
||||
Include the parent message's thread_ts value in `thread`
|
||||
to send to a thread.
|
||||
|
||||
:Args:
|
||||
message (message) - the string you'd like to send to the channel
|
||||
thread (str or None) - the parent message ID, if sending to a
|
||||
thread
|
||||
reply_broadcast (bool) - if messaging a thread, whether to
|
||||
also send the message back to the channel
|
||||
|
||||
:Returns:
|
||||
None
|
||||
'''
|
||||
self.server.rtm_send_message(self.id, message, thread, reply_broadcast)
|
||||
|
|
@ -0,0 +1,295 @@
|
|||
#!/usr/bin/python
|
||||
# mostly a proxy object to abstract how some of this works
|
||||
|
||||
import json
|
||||
import logging
|
||||
import time
|
||||
|
||||
from .server import Server
|
||||
from .exceptions import ParseResponseError, TokenRefreshError
|
||||
|
||||
|
||||
LOG = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class SlackClient(object):
|
||||
"""
|
||||
The SlackClient makes API Calls to the `Slack Web API <https://api.slack.com/web>`_ as well as
|
||||
managing connections to the `Real-time Messaging API via websocket <https://api.slack.com/rtm>`_
|
||||
|
||||
It also manages some of the Client state for Channels that the associated token (User or Bot)
|
||||
is associated with.
|
||||
|
||||
For more information, check out the `Slack API Docs <https://api.slack.com/>`_
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
token=None,
|
||||
refresh_token=None,
|
||||
token_update_callback=None,
|
||||
client_id=None,
|
||||
client_secret=None,
|
||||
proxies=None,
|
||||
**kwargs
|
||||
):
|
||||
"""
|
||||
Init:
|
||||
:Args:
|
||||
token (str): Your Slack Authentication token. You can find or generate a test token
|
||||
`here <https://api.slack.com/docs/oauth-test-tokens>`_
|
||||
Note: Be `careful with your token <https://api.slack.com/docs/oauth-safety>`_
|
||||
proxies (dict): Proxies to use when create websocket or api calls,
|
||||
declare http and websocket proxies using {'http': 'http://127.0.0.1'},
|
||||
and https proxy using {'https': 'https://127.0.0.1:443'}
|
||||
refresh_token (str): Your Slack app's refresh token. This token is used to
|
||||
update your app's OAuth access token
|
||||
client_id (str): Your app's Client ID
|
||||
client_secret (srt): Your app's Client Secret (Used for OAuth requests)
|
||||
refresh_callback (function): Your application's function for updating Slack
|
||||
OAuth tokens inside your data store
|
||||
"""
|
||||
|
||||
self.client_id = client_id
|
||||
self.client_secret = client_secret
|
||||
self.refresh_token = refresh_token
|
||||
self.token_update_callback = token_update_callback
|
||||
self.token = token
|
||||
self.access_token_expires_at = 0
|
||||
|
||||
if refresh_token:
|
||||
if callable(token_update_callback):
|
||||
self.server = Server(
|
||||
connect=False,
|
||||
proxies=proxies,
|
||||
refresh_token=refresh_token,
|
||||
client_id=client_id,
|
||||
client_secret=client_secret,
|
||||
token_update_callback=token_update_callback,
|
||||
)
|
||||
else:
|
||||
raise TokenRefreshError(
|
||||
"Token refresh callback function is required when using refresh token."
|
||||
)
|
||||
else:
|
||||
# Slack app configs
|
||||
self.server = Server(token=token, connect=False, proxies=proxies)
|
||||
|
||||
def refresh_access_token(self):
|
||||
"""
|
||||
Refresh the client's OAUth access tokens
|
||||
https://api.slack.com/docs/rotating-and-refreshing-credentials
|
||||
"""
|
||||
post_data = {
|
||||
"refresh_token": self.refresh_token,
|
||||
"grant_type": "refresh_token",
|
||||
"client_id": self.client_id,
|
||||
"client_secret": self.client_secret,
|
||||
}
|
||||
response = self.server.api_requester.post_http_request(
|
||||
self.refresh_token, api_method="oauth.access", post_data=post_data
|
||||
)
|
||||
response_json = json.loads(response.text)
|
||||
|
||||
# If Slack returned an updated access token, update the client, otherwise
|
||||
# raise TokenRefreshError exception with the error returned from the API
|
||||
if response_json["ok"]:
|
||||
# Update the client's access token and expiration timestamp
|
||||
self.team_id = response_json["team_id"]
|
||||
# TODO: Minimize the numer of places token is stored.
|
||||
self.token = response_json["access_token"]
|
||||
self.server.token = response_json["access_token"]
|
||||
|
||||
# Update the token expiration timestamp
|
||||
current_ts = int(time.time())
|
||||
expires_at = int(current_ts + response_json["expires_in"])
|
||||
self.access_token_expires_at = expires_at
|
||||
# Call the developer's token update callback
|
||||
update_args = {
|
||||
"enterprise_id": response_json["enterprise_id"],
|
||||
"team_id": response_json["team_id"],
|
||||
"access_token": response_json["access_token"],
|
||||
"expires_in": response_json["expires_in"],
|
||||
}
|
||||
self.token_update_callback(update_args)
|
||||
else:
|
||||
raise TokenRefreshError("Token refresh failed")
|
||||
|
||||
def append_user_agent(self, name, version):
|
||||
self.server.append_user_agent(name, version)
|
||||
|
||||
def rtm_connect(self, with_team_state=True, **kwargs):
|
||||
"""
|
||||
Connects to the RTM Websocket
|
||||
|
||||
:Args:
|
||||
with_team_state (bool): Connect via `rtm.start` to pull workspace state information.
|
||||
`False` connects via `rtm.connect`, which is lighter weight and better for very large
|
||||
teams.
|
||||
|
||||
:Returns:
|
||||
False on exceptions
|
||||
"""
|
||||
|
||||
if self.refresh_token:
|
||||
raise TokenRefreshError(
|
||||
"Workspace tokens may not be used to connect to the RTM API."
|
||||
)
|
||||
|
||||
try:
|
||||
self.server.rtm_connect(use_rtm_start=with_team_state, **kwargs)
|
||||
return self.server.connected
|
||||
except Exception:
|
||||
LOG.warn("Failed RTM connect", exc_info=True)
|
||||
return False
|
||||
|
||||
def api_call(self, method, timeout=None, **kwargs):
|
||||
"""
|
||||
Call the Slack Web API as documented here: https://api.slack.com/web
|
||||
|
||||
:Args:
|
||||
method (str): The API Method to call. See
|
||||
`the full list here <https://api.slack.com/methods>`_
|
||||
:Kwargs:
|
||||
(optional) kwargs: any arguments passed here will be bundled and sent to the api
|
||||
requester as post_data and will be passed along to the API.
|
||||
|
||||
Example::
|
||||
|
||||
sc.api_call(
|
||||
"channels.setPurpose",
|
||||
channel="CABC12345",
|
||||
purpose="Writing some code!"
|
||||
)
|
||||
|
||||
:Returns:
|
||||
str -- returns the text of the HTTP response.
|
||||
|
||||
Examples::
|
||||
|
||||
u'{"ok":true,"purpose":"Testing bots"}'
|
||||
or
|
||||
u'{"ok":false,"error":"channel_not_found"}'
|
||||
|
||||
See here for more information on responses: https://api.slack.com/web
|
||||
"""
|
||||
# Check for missing or expired access token before submitting the request
|
||||
if method != "oauth.access" and self.refresh_token:
|
||||
current_ts = int(time.time())
|
||||
token_is_expired = current_ts > self.access_token_expires_at
|
||||
if token_is_expired or self.token is None:
|
||||
self.refresh_access_token()
|
||||
|
||||
response_body = self.server.api_call(
|
||||
self.token, request=method, timeout=timeout, **kwargs
|
||||
)
|
||||
|
||||
# Attempt to parse the response as JSON
|
||||
try:
|
||||
result = json.loads(response_body)
|
||||
except ValueError as json_decode_error:
|
||||
raise ParseResponseError(response_body, json_decode_error)
|
||||
response_json = json.loads(response_body)
|
||||
|
||||
if result.get("ok", False):
|
||||
if method == "im.open":
|
||||
self.server.attach_channel(kwargs["user"], result["channel"]["id"])
|
||||
elif method in ("mpim.open", "groups.create", "groups.createchild"):
|
||||
self.server.parse_channel_data([result["group"]])
|
||||
elif method in ("channels.create", "channels.join"):
|
||||
self.server.parse_channel_data([result["channel"]])
|
||||
else:
|
||||
# if the API request returns an invalid_auth error, refresh the token and try again
|
||||
if (
|
||||
self.refresh_token
|
||||
and "error" in response_json
|
||||
and response_json["error"] == "invalid_auth"
|
||||
):
|
||||
self.refresh_access_token()
|
||||
# If token refresh was successful, retry the original API request
|
||||
return self.api_call(method, timeout, **kwargs)
|
||||
return result
|
||||
|
||||
def rtm_read(self):
|
||||
"""
|
||||
Reads from the RTM Websocket stream then calls `self.process_changes(item)` for each line
|
||||
in the returned data.
|
||||
|
||||
Multiple events may be returned, always returns a list [], which is empty if there are no
|
||||
incoming messages.
|
||||
|
||||
:Args:
|
||||
None
|
||||
|
||||
:Returns:
|
||||
data (json) - The server response. For example::
|
||||
|
||||
[{u'presence': u'active', u'type': u'presence_change', u'user': u'UABC1234'}]
|
||||
|
||||
:Raises:
|
||||
SlackNotConnected if self.server is not defined.
|
||||
"""
|
||||
# in the future, this should handle some events internally i.e. channel
|
||||
# creation
|
||||
if self.server:
|
||||
json_data = self.server.websocket_safe_read()
|
||||
data = []
|
||||
if json_data != "":
|
||||
for d in json_data.split("\n"):
|
||||
data.append(json.loads(d))
|
||||
for item in data:
|
||||
self.process_changes(item)
|
||||
return data
|
||||
else:
|
||||
raise SlackNotConnected
|
||||
|
||||
def rtm_send_message(self, channel, message, thread=None, reply_broadcast=None):
|
||||
"""
|
||||
Sends a message to a given channel.
|
||||
|
||||
:Args:
|
||||
channel (str) - the string identifier for a channel or channel name (e.g. 'C1234ABC',
|
||||
'bot-test' or '#bot-test')
|
||||
message (message) - the string you'd like to send to the channel
|
||||
thread (str or None) - the parent message ID, if sending to a
|
||||
thread
|
||||
reply_broadcast (bool) - if messaging a thread, whether to
|
||||
also send the message back to the channel
|
||||
|
||||
:Returns:
|
||||
None
|
||||
|
||||
"""
|
||||
# The `channel` argument can be a channel name or an ID. At first its assumed to be a
|
||||
# name and an attempt is made to find the ID in the workspace state cache.
|
||||
# If that lookup fails, the argument is used as the channel ID.
|
||||
found_channel = self.server.channels.find(channel)
|
||||
channel_id = found_channel.id if found_channel else channel
|
||||
return self.server.rtm_send_message(
|
||||
channel_id, message, thread, reply_broadcast
|
||||
)
|
||||
|
||||
def process_changes(self, data):
|
||||
"""
|
||||
Internal method which processes RTM events and modifies the local data store
|
||||
accordingly.
|
||||
|
||||
Stores new channels when joining a group (Multi-party DM), IM (DM) or channel.
|
||||
|
||||
Stores user data on a team join event.
|
||||
"""
|
||||
if "type" in data.keys():
|
||||
if data["type"] in ("channel_created", "group_joined"):
|
||||
channel = data["channel"]
|
||||
self.server.attach_channel(channel["name"], channel["id"], [])
|
||||
if data["type"] == "im_created":
|
||||
channel = data["channel"]
|
||||
self.server.attach_channel(channel["user"], channel["id"], [])
|
||||
if data["type"] == "team_join":
|
||||
user = data["user"]
|
||||
self.server.parse_user_data([user])
|
||||
pass
|
||||
|
||||
|
||||
class SlackNotConnected(Exception):
|
||||
pass
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
class SlackClientError(Exception):
|
||||
"""
|
||||
Base exception for all errors raised by the SlackClient library
|
||||
"""
|
||||
def __init__(self, msg=None):
|
||||
if msg is None:
|
||||
# default error message
|
||||
msg = "An error occurred in the SlackClient library"
|
||||
super(SlackClientError, self).__init__(msg)
|
||||
|
||||
|
||||
class ParseResponseError(SlackClientError, ValueError):
|
||||
"""
|
||||
Error raised when responses to Web API methods cannot be parsed as valid JSON
|
||||
"""
|
||||
def __init__(self, response_body, original_exception):
|
||||
super(ParseResponseError, self).__init__(
|
||||
"Slack API response body could not be parsed: {0}. Original exception: {1}".format(
|
||||
response_body, original_exception
|
||||
)
|
||||
)
|
||||
self.response_body = response_body
|
||||
self.original_exception = original_exception
|
||||
|
||||
|
||||
class TokenRefreshError(SlackClientError):
|
||||
"""
|
||||
This exception is rasied when a token related error occurs within the client
|
||||
"""
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
class Im(object):
|
||||
'''
|
||||
IMs represent direct message channels between two users on Slack.
|
||||
'''
|
||||
def __init__(self, server, user, im_id):
|
||||
self.server = server
|
||||
self.user = user
|
||||
self.id = im_id
|
||||
|
||||
def __eq__(self, compare_str):
|
||||
if self.id == compare_str or self.user == compare_str:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def __hash__(self):
|
||||
return hash(self.id)
|
||||
|
||||
def __str__(self):
|
||||
data = ""
|
||||
for key in list(self.__dict__.keys()):
|
||||
if key != "server":
|
||||
data += "{0} : {1}\n".format(key, str(self.__dict__[key])[:40])
|
||||
return data
|
||||
|
||||
def __repr__(self):
|
||||
return self.__str__()
|
||||
|
||||
def send_message(self, message):
|
||||
'''
|
||||
Sends a message to a this IM (or DM depending on your preferred terminology).
|
||||
|
||||
:Args:
|
||||
message (message) - the string you'd like to send to the IM
|
||||
|
||||
:Returns:
|
||||
None
|
||||
'''
|
||||
message_json = {"type": "message", "channel": self.id, "text": message}
|
||||
self.server.send_to_websocket(message_json)
|
||||
|
|
@ -0,0 +1,377 @@
|
|||
from .channel import Channel
|
||||
from .exceptions import SlackClientError
|
||||
from .slackrequest import SlackRequest
|
||||
from .user import User
|
||||
from .util import SearchList, SearchDict
|
||||
|
||||
import json
|
||||
import logging
|
||||
import time
|
||||
import random
|
||||
|
||||
from requests.packages.urllib3.util.url import parse_url
|
||||
from ssl import SSLError
|
||||
from websocket import create_connection
|
||||
from websocket._exceptions import WebSocketConnectionClosedException
|
||||
|
||||
|
||||
class Server(object):
|
||||
"""
|
||||
The Server object owns the websocket connection and all attached channel information.
|
||||
"""
|
||||
|
||||
def __init__(self, token=None, connect=True, proxies=None, **kwargs):
|
||||
# Slack app configs
|
||||
self.token = token
|
||||
|
||||
# api configs
|
||||
self.proxies = proxies
|
||||
|
||||
# HTTP Request handler
|
||||
self.api_requester = SlackRequest(proxies=proxies)
|
||||
|
||||
# Workspace metadata
|
||||
self.username = None
|
||||
self.domain = None
|
||||
self.login_data = None
|
||||
self.users = SearchDict()
|
||||
self.channels = SearchList()
|
||||
|
||||
# RTM configs
|
||||
self.websocket = None
|
||||
self.ws_url = None
|
||||
self.connected = False
|
||||
self.auto_reconnect = False
|
||||
self.last_connected_at = 0
|
||||
self.reconnect_count = 0
|
||||
self.rtm_connect_retries = 0
|
||||
|
||||
# Connect to RTM on load
|
||||
if connect:
|
||||
self.rtm_connect()
|
||||
|
||||
def __eq__(self, compare_str):
|
||||
if compare_str == self.domain or compare_str == self.token:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def __hash__(self):
|
||||
return hash(self.token)
|
||||
|
||||
def __str__(self):
|
||||
"""
|
||||
Example Output::
|
||||
|
||||
username : None
|
||||
domain : None
|
||||
websocket : None
|
||||
users : []
|
||||
login_data : None
|
||||
api_requester : <slackclient.slackrequest.SlackRequest
|
||||
channels : []
|
||||
token : xoxb-asdlfkyadsofii7asdf734lkasdjfllakjba7zbu
|
||||
connected : False
|
||||
ws_url : None
|
||||
"""
|
||||
data = ""
|
||||
for key in list(self.__dict__.keys()):
|
||||
data += "{} : {}\n".format(key, str(self.__dict__[key])[:40])
|
||||
return data
|
||||
|
||||
def __repr__(self):
|
||||
return self.__str__()
|
||||
|
||||
def append_user_agent(self, name, version):
|
||||
self.api_requester.append_user_agent(name, version)
|
||||
|
||||
def rtm_connect(self, reconnect=False, timeout=None, use_rtm_start=True, **kwargs):
|
||||
"""
|
||||
Connects to the RTM API - https://api.slack.com/rtm
|
||||
|
||||
If `auto_reconnect` is set to `True` then the SlackClient is initialized, this method
|
||||
will be used to reconnect on websocket read failures, which indicate disconnection
|
||||
|
||||
:Args:
|
||||
reconnect (boolean) Whether this method is being called to reconnect to RTM
|
||||
timeout (int): Stop waiting for Web API response after this many seconds
|
||||
use_rtm_start (boolean): `True` to connect using `rtm.start` or
|
||||
`False` to connect using`rtm.connect`
|
||||
https://api.slack.com/rtm#connecting_with_rtm.connect_vs._rtm.start
|
||||
|
||||
:Returns:
|
||||
None
|
||||
|
||||
"""
|
||||
# rtm.start returns user and channel info, rtm.connect does not.
|
||||
connect_method = "rtm.start" if use_rtm_start else "rtm.connect"
|
||||
|
||||
# If the `auto_reconnect` param was passed, set the server's `auto_reconnect` attr
|
||||
if "auto_reconnect" in kwargs:
|
||||
self.auto_reconnect = kwargs["auto_reconnect"]
|
||||
|
||||
# If this is an auto reconnect, rate limit reconnect attempts
|
||||
if self.auto_reconnect and reconnect:
|
||||
# Raise a SlackConnectionError after 5 retries within 3 minutes
|
||||
recon_count = self.reconnect_count
|
||||
if recon_count == 5:
|
||||
logging.error("RTM connection failed, reached max reconnects.")
|
||||
raise SlackConnectionError(
|
||||
"RTM connection failed, reached max reconnects."
|
||||
)
|
||||
# Wait to reconnect if the last reconnect was less than 3 minutes ago
|
||||
if (time.time() - self.last_connected_at) < 180:
|
||||
if recon_count > 0:
|
||||
# Back off after the the first attempt
|
||||
backoff_offset_multiplier = random.randint(1, 4)
|
||||
retry_timeout = (
|
||||
backoff_offset_multiplier * recon_count * recon_count
|
||||
)
|
||||
logging.debug("Reconnecting in %d seconds", retry_timeout)
|
||||
|
||||
time.sleep(retry_timeout)
|
||||
self.reconnect_count += 1
|
||||
else:
|
||||
self.reconnect_count = 0
|
||||
|
||||
reply = self.api_requester.do(
|
||||
self.token, connect_method, post_data=kwargs, timeout=timeout
|
||||
)
|
||||
|
||||
if reply.status_code != 200:
|
||||
if self.rtm_connect_retries < 5 and reply.status_code == 429:
|
||||
self.rtm_connect_retries += 1
|
||||
retry_after = int(reply.headers.get("retry-after", 120))
|
||||
logging.debug(
|
||||
"HTTP 429: Rate limited. Retrying in %d seconds", retry_after
|
||||
)
|
||||
time.sleep(retry_after)
|
||||
self.rtm_connect(
|
||||
reconnect=reconnect,
|
||||
timeout=timeout,
|
||||
use_rtm_start=use_rtm_start,
|
||||
**kwargs
|
||||
)
|
||||
else:
|
||||
raise SlackConnectionError(
|
||||
"RTM connection attempt was rate limited 5 times."
|
||||
)
|
||||
else:
|
||||
self.rtm_connect_retries = 0
|
||||
login_data = reply.json()
|
||||
if login_data["ok"]:
|
||||
self.ws_url = login_data["url"]
|
||||
self.connect_slack_websocket(self.ws_url)
|
||||
if not reconnect:
|
||||
self.parse_slack_login_data(login_data, use_rtm_start)
|
||||
else:
|
||||
raise SlackLoginError(reply=reply)
|
||||
|
||||
def parse_slack_login_data(self, login_data, use_rtm_start):
|
||||
self.login_data = login_data
|
||||
self.domain = self.login_data["team"]["domain"]
|
||||
self.username = self.login_data["self"]["name"]
|
||||
|
||||
# if the connection was made via rtm.start, update the server's state
|
||||
if use_rtm_start:
|
||||
self.parse_channel_data(login_data["channels"])
|
||||
self.parse_channel_data(login_data["groups"])
|
||||
self.parse_user_data(login_data["users"])
|
||||
self.parse_channel_data(login_data["ims"])
|
||||
|
||||
def connect_slack_websocket(self, ws_url):
|
||||
"""Uses http proxy if available"""
|
||||
if self.proxies and "http" in self.proxies:
|
||||
parts = parse_url(self.proxies["http"])
|
||||
proxy_host, proxy_port = parts.host, parts.port
|
||||
auth = parts.auth
|
||||
proxy_auth = auth and auth.split(":")
|
||||
else:
|
||||
proxy_auth, proxy_port, proxy_host = None, None, None
|
||||
|
||||
try:
|
||||
self.websocket = create_connection(
|
||||
ws_url,
|
||||
http_proxy_host=proxy_host,
|
||||
http_proxy_port=proxy_port,
|
||||
http_proxy_auth=proxy_auth,
|
||||
)
|
||||
self.connected = True
|
||||
self.last_connected_at = time.time()
|
||||
logging.debug("RTM connected")
|
||||
self.websocket.sock.setblocking(0)
|
||||
except Exception as e:
|
||||
self.connected = False
|
||||
raise SlackConnectionError(message=str(e))
|
||||
|
||||
def parse_channel_data(self, channel_data):
|
||||
for channel in channel_data:
|
||||
if "name" not in channel:
|
||||
channel["name"] = channel["id"]
|
||||
if "members" not in channel:
|
||||
channel["members"] = []
|
||||
self.attach_channel(channel["name"], channel["id"], channel["members"])
|
||||
|
||||
def parse_user_data(self, user_data):
|
||||
for user in user_data:
|
||||
if "tz" not in user:
|
||||
user["tz"] = "unknown"
|
||||
if "real_name" not in user:
|
||||
user["real_name"] = user["name"]
|
||||
if "email" not in user["profile"]:
|
||||
user["profile"]["email"] = ""
|
||||
self.attach_user(
|
||||
user["name"],
|
||||
user["id"],
|
||||
user["real_name"],
|
||||
user["tz"],
|
||||
user["profile"]["email"],
|
||||
)
|
||||
|
||||
def send_to_websocket(self, data):
|
||||
"""
|
||||
Send a JSON message directly to the websocket. See
|
||||
`RTM documentation <https://api.slack.com/rtm` for allowed types.
|
||||
|
||||
:Args:
|
||||
data (dict) the key/values to send the websocket.
|
||||
|
||||
"""
|
||||
try:
|
||||
data = json.dumps(data)
|
||||
self.websocket.send(data)
|
||||
except Exception:
|
||||
self.rtm_connect(reconnect=True, use_rtm_start=False)
|
||||
|
||||
def rtm_send_message(self, channel, message, thread=None, reply_broadcast=None):
|
||||
"""
|
||||
Sends a message to a given channel.
|
||||
|
||||
:Args:
|
||||
channel (str) - the string identifier for a channel or channel name (e.g. 'C1234ABC',
|
||||
'bot-test' or '#bot-test')
|
||||
message (message) - the string you'd like to send to the channel
|
||||
thread (str or None) - the parent message ID, if sending to a
|
||||
thread
|
||||
reply_broadcast (bool) - if messaging a thread, whether to
|
||||
also send the message back to the channel
|
||||
|
||||
:Returns:
|
||||
None
|
||||
|
||||
"""
|
||||
message_json = {"type": "message", "channel": channel, "text": message}
|
||||
if thread is not None:
|
||||
message_json["thread_ts"] = thread
|
||||
if reply_broadcast:
|
||||
message_json["reply_broadcast"] = True
|
||||
|
||||
self.send_to_websocket(message_json)
|
||||
|
||||
def ping(self):
|
||||
return self.send_to_websocket({"type": "ping"})
|
||||
|
||||
def websocket_safe_read(self):
|
||||
"""
|
||||
Returns data if available, otherwise ''. Newlines indicate multiple
|
||||
messages
|
||||
"""
|
||||
|
||||
data = ""
|
||||
while True:
|
||||
try:
|
||||
data += "{0}\n".format(self.websocket.recv())
|
||||
except SSLError as e:
|
||||
if e.errno == 2:
|
||||
# errno 2 occurs when trying to read or write data, but more
|
||||
# data needs to be received on the underlying TCP transport
|
||||
# before the request can be fulfilled.
|
||||
#
|
||||
# Python 2.7.9+ and Python 3.3+ give this its own exception,
|
||||
# SSLWantReadError
|
||||
return ""
|
||||
raise
|
||||
except WebSocketConnectionClosedException:
|
||||
logging.debug("RTM disconnected")
|
||||
self.connected = False
|
||||
if self.auto_reconnect:
|
||||
self.rtm_connect(reconnect=True, use_rtm_start=False)
|
||||
else:
|
||||
raise SlackConnectionError(
|
||||
"Unable to send due to closed RTM websocket"
|
||||
)
|
||||
return data.rstrip()
|
||||
|
||||
def attach_user(self, name, user_id, real_name, tz, email):
|
||||
self.users.update({user_id: User(self, name, user_id, real_name, tz, email)})
|
||||
|
||||
def attach_channel(self, name, channel_id, members=None):
|
||||
if members is None:
|
||||
members = []
|
||||
if self.channels.find(channel_id) is None:
|
||||
self.channels.append(Channel(self, name, channel_id, members))
|
||||
|
||||
def join_channel(self, name, timeout=None):
|
||||
"""
|
||||
Join a channel by name.
|
||||
|
||||
Note: this action is not allowed by bots, they must be invited to channels.
|
||||
"""
|
||||
response = self.api_call("channels.join", channel=name, timeout=timeout)
|
||||
return response
|
||||
|
||||
def api_call(self, token, request="?", timeout=None, **kwargs):
|
||||
"""
|
||||
Call the Slack Web API as documented here: https://api.slack.com/web
|
||||
|
||||
:Args:
|
||||
method (str): The API Method to call. See here for a list: https://api.slack.com/methods
|
||||
:Kwargs:
|
||||
(optional) timeout: stop waiting for a response after a given number of seconds
|
||||
(optional) kwargs: any arguments passed here will be bundled and sent to the api
|
||||
requester as post_data
|
||||
and will be passed along to the API.
|
||||
|
||||
Example::
|
||||
|
||||
sc.server.api_call(
|
||||
"channels.setPurpose",
|
||||
channel="CABC12345",
|
||||
purpose="Writing some code!"
|
||||
)
|
||||
|
||||
Returns:
|
||||
str -- returns HTTP response text and headers as JSON.
|
||||
|
||||
Examples::
|
||||
|
||||
u'{"ok":true,"purpose":"Testing bots"}'
|
||||
or
|
||||
u'{"ok":false,"error":"channel_not_found"}'
|
||||
|
||||
See here for more information on responses: https://api.slack.com/web
|
||||
"""
|
||||
response = self.api_requester.do(token, request, kwargs, timeout=timeout)
|
||||
response_json = {}
|
||||
resp_text = response.text
|
||||
if resp_text:
|
||||
response_json = json.loads(resp_text)
|
||||
response_json["headers"] = dict(response.headers)
|
||||
return json.dumps(response_json)
|
||||
|
||||
|
||||
# TODO: Move the error types defined below into the .exceptions namespace. This would be a semver
|
||||
# major change because any clients already referencing these types in order to catch them
|
||||
# specifically would need to deal with the symbol names changing.
|
||||
|
||||
|
||||
class SlackConnectionError(SlackClientError):
|
||||
def __init__(self, message="", reply=None):
|
||||
super(SlackConnectionError, self).__init__(message)
|
||||
self.reply = reply
|
||||
|
||||
|
||||
class SlackLoginError(SlackClientError):
|
||||
def __init__(self, message="", reply=None):
|
||||
super(SlackLoginError, self).__init__(message)
|
||||
self.reply = reply
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
import json
|
||||
import platform
|
||||
import requests
|
||||
import six
|
||||
import sys
|
||||
|
||||
from .version import __version__
|
||||
|
||||
|
||||
class SlackRequest(object):
|
||||
def __init__(
|
||||
self,
|
||||
proxies=None
|
||||
):
|
||||
# HTTP configs
|
||||
self.custom_user_agent = None
|
||||
self.proxies = proxies
|
||||
|
||||
# Construct the user-agent header with the package info, Python version and OS version.
|
||||
self.default_user_agent = {
|
||||
# __name__ returns all classes, we only want the client
|
||||
"client": "{0}/{1}".format(__name__.split('.')[0], __version__),
|
||||
"python": "Python/{v.major}.{v.minor}.{v.micro}".format(v=sys.version_info),
|
||||
"system": "{0}/{1}".format(platform.system(), platform.release())
|
||||
}
|
||||
|
||||
def get_user_agent(self):
|
||||
# Check for custom user-agent and append if found
|
||||
if self.custom_user_agent:
|
||||
custom_ua_list = ["/".join(client_info) for client_info in self.custom_user_agent]
|
||||
custom_ua_string = " ".join(custom_ua_list)
|
||||
self.default_user_agent['custom'] = custom_ua_string
|
||||
|
||||
# Concatenate and format the user-agent string to be passed into request headers
|
||||
ua_string = []
|
||||
for key, val in self.default_user_agent.items():
|
||||
ua_string.append(val)
|
||||
|
||||
user_agent_string = " ".join(ua_string)
|
||||
return user_agent_string
|
||||
|
||||
def append_user_agent(self, name, version):
|
||||
if self.custom_user_agent:
|
||||
self.custom_user_agent.append([name.replace("/", ":"), version.replace("/", ":")])
|
||||
else:
|
||||
self.custom_user_agent = [[name, version]]
|
||||
|
||||
def do(self, token=None, request="?", post_data=None, domain="slack.com", timeout=None):
|
||||
"""
|
||||
Perform a POST request to the Slack Web API
|
||||
Args:
|
||||
token (str): your authentication token
|
||||
request (str): the method to call from the Slack API. For example: 'channels.list'
|
||||
post_data (dict): key/value arguments to pass for the request. For example:
|
||||
{'channel': 'CABC12345'}
|
||||
domain (str): if for some reason you want to send your request to something other
|
||||
than slack.com
|
||||
timeout (float): stop waiting for a response after a given number of seconds
|
||||
"""
|
||||
# Pull `file` out so it isn't JSON encoded like normal fields.
|
||||
# Only do this for requests that are UPLOADING files; downloading files
|
||||
# use the 'file' argument to point to a File ID.
|
||||
post_data = post_data or {}
|
||||
|
||||
# Move singular file objects into `files`
|
||||
upload_requests = ['files.upload']
|
||||
|
||||
# Move file content into requests' `files` param
|
||||
files = None
|
||||
if request in upload_requests:
|
||||
files = {'file': post_data.pop('file')} if 'file' in post_data else None
|
||||
|
||||
# Check for plural fields and convert them to comma-separated strings if needed
|
||||
for field in {'channels', 'users', 'types'} & set(post_data.keys()):
|
||||
if isinstance(post_data[field], list):
|
||||
post_data[field] = ",".join(post_data[field])
|
||||
|
||||
# Convert any params which are list-like to JSON strings
|
||||
# Example: `attachments` is a dict, and needs to be passed as JSON
|
||||
for k, v in six.iteritems(post_data):
|
||||
if isinstance(v, (list, dict)):
|
||||
post_data[k] = json.dumps(v)
|
||||
|
||||
return self.post_http_request(token, request, post_data, files, timeout, domain)
|
||||
|
||||
def post_http_request(self, token, api_method, post_data,
|
||||
files=None, timeout=None, domain="slack.com"):
|
||||
"""
|
||||
This method build and submits the Web API HTTP request
|
||||
|
||||
:param token: You app's Slack access token
|
||||
:param api_method: The API method endpoint to submit the request to
|
||||
:param post_data: The request payload
|
||||
:param domain: The URL to submit the API request to
|
||||
:param files: Any files to be submitted during upload calls
|
||||
:param timeout: Stop waiting for a response after a given number of seconds
|
||||
:return:
|
||||
"""
|
||||
# Override token header if `token` is passed in post_data
|
||||
if post_data is not None and "token" in post_data:
|
||||
token = post_data['token']
|
||||
|
||||
# Set user-agent and auth headers
|
||||
headers = {
|
||||
'user-agent': self.get_user_agent(),
|
||||
'Authorization': 'Bearer {}'.format(token)
|
||||
}
|
||||
|
||||
# Submit the request
|
||||
res = requests.post(
|
||||
'https://{0}/api/{1}'.format(domain, api_method),
|
||||
headers=headers,
|
||||
data=post_data,
|
||||
files=files,
|
||||
timeout=timeout,
|
||||
proxies=self.proxies
|
||||
)
|
||||
return res
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
class User(object):
|
||||
def __init__(self, server, name, user_id, real_name, tz, email):
|
||||
self.tz = tz
|
||||
self.name = name
|
||||
self.real_name = real_name
|
||||
self.server = server
|
||||
self.id = user_id
|
||||
self.email = email
|
||||
|
||||
def __eq__(self, compare_str):
|
||||
if compare_str in (self.id, self.name):
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def __hash__(self):
|
||||
return hash(self.id)
|
||||
|
||||
def __str__(self):
|
||||
data = ""
|
||||
for key in list(self.__dict__.keys()):
|
||||
if key != "server":
|
||||
data += "{0} : {1}\n".format(key, str(self.__dict__[key])[:40])
|
||||
return data
|
||||
|
||||
def __repr__(self):
|
||||
return self.__str__()
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
class SearchList(list):
|
||||
|
||||
def find(self, name):
|
||||
items = []
|
||||
for child in self:
|
||||
if child.__class__ == self.__class__:
|
||||
items += child.find(name)
|
||||
else:
|
||||
if child == name:
|
||||
items.append(child)
|
||||
|
||||
if len(items) == 1:
|
||||
return items[0]
|
||||
elif items:
|
||||
return items
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
class SearchDict(dict):
|
||||
def find(self, search_string):
|
||||
# Find the user by ID
|
||||
user = self.get(search_string)
|
||||
if user:
|
||||
return user
|
||||
else:
|
||||
# If the user can't be found by ID, try searching by name
|
||||
for id, user in self.items():
|
||||
if str(user.name) == search_string:
|
||||
return user
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# see: http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers
|
||||
__version__ = "1.3.2"
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
pytest<4
|
||||
codecov
|
||||
coverage
|
||||
mock
|
||||
pytest-cov>=2.4.0,<2.6
|
||||
pytest-mock
|
||||
responses
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
import pytest
|
||||
import requests
|
||||
from slackclient.channel import Channel
|
||||
from slackclient.server import Server
|
||||
from slackclient.client import SlackClient
|
||||
|
||||
|
||||
# This is so that tests work on Travis for python 2.6, it's really hacky, but expedient
|
||||
def get_unverified_post():
|
||||
requests_post = requests.post
|
||||
|
||||
def unverified_post(*args, **kwargs):
|
||||
# don't throw SSL errors plz
|
||||
kwargs['verify'] = False
|
||||
return requests_post(*args, **kwargs)
|
||||
|
||||
return unverified_post
|
||||
|
||||
|
||||
requests.post = get_unverified_post()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def server(monkeypatch):
|
||||
my_server = Server(token='xoxp-1234123412341234-12341234-1234', connect=False)
|
||||
return my_server
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def slackclient():
|
||||
my_slackclient = SlackClient('xoxp-1234123412341234-12341234-1234')
|
||||
return my_slackclient
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def channel(server):
|
||||
my_channel = Channel(server, "somechannel", "C12341234", ["user"])
|
||||
return my_channel
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"type": "channel_created",
|
||||
"channel": {
|
||||
"id": "C024BE91L",
|
||||
"name": "fun",
|
||||
"created": 1360782804,
|
||||
"creator": "U024BE7LH"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"type": "im_created",
|
||||
"user": "U024BE7LH",
|
||||
"channel": {
|
||||
"id": "D024BE91L",
|
||||
"user": "U123BL234",
|
||||
"created": 1360782804
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,321 @@
|
|||
{
|
||||
"ok": true,
|
||||
"self": {
|
||||
"id": "U10CX1234",
|
||||
"name": "fakeuser",
|
||||
"prefs": {
|
||||
"highlight_words": "",
|
||||
"user_colors": "",
|
||||
"color_names_in_list": true,
|
||||
"growls_enabled": true,
|
||||
"tz": "America\/Los_Angeles",
|
||||
"push_dm_alert": true,
|
||||
"push_mention_alert": true,
|
||||
"push_everything": true,
|
||||
"push_idle_wait": 2,
|
||||
"push_sound": "b2.mp3",
|
||||
"push_loud_channels": "",
|
||||
"push_mention_channels": "",
|
||||
"push_loud_channels_set": "",
|
||||
"email_alerts": "instant",
|
||||
"email_alerts_sleep_until": 0,
|
||||
"email_misc": true,
|
||||
"email_weekly": true,
|
||||
"welcome_message_hidden": false,
|
||||
"all_channels_loud": true,
|
||||
"loud_channels": "",
|
||||
"never_channels": "",
|
||||
"loud_channels_set": "",
|
||||
"show_member_presence": true,
|
||||
"search_sort": "timestamp",
|
||||
"expand_inline_imgs": true,
|
||||
"expand_internal_inline_imgs": true,
|
||||
"expand_snippets": false,
|
||||
"posts_formatting_guide": true,
|
||||
"seen_welcome_2": true,
|
||||
"seen_ssb_prompt": false,
|
||||
"search_only_my_channels": false,
|
||||
"emoji_mode": "default",
|
||||
"has_invited": false,
|
||||
"has_uploaded": false,
|
||||
"has_created_channel": false,
|
||||
"search_exclude_channels": "",
|
||||
"messages_theme": "default",
|
||||
"webapp_spellcheck": true,
|
||||
"no_joined_overlays": false,
|
||||
"no_created_overlays": false,
|
||||
"dropbox_enabled": false,
|
||||
"seen_user_menu_tip_card": true,
|
||||
"seen_team_menu_tip_card": true,
|
||||
"seen_channel_menu_tip_card": true,
|
||||
"seen_message_input_tip_card": true,
|
||||
"seen_channels_tip_card": true,
|
||||
"seen_domain_invite_reminder": false,
|
||||
"seen_member_invite_reminder": false,
|
||||
"seen_flexpane_tip_card": true,
|
||||
"seen_search_input_tip_card": true,
|
||||
"mute_sounds": false,
|
||||
"arrow_history": false,
|
||||
"tab_ui_return_selects": true,
|
||||
"obey_inline_img_limit": true,
|
||||
"new_msg_snd": "knock_brush.mp3",
|
||||
"collapsible": false,
|
||||
"collapsible_by_click": true,
|
||||
"require_at": false,
|
||||
"mac_ssb_bounce": "",
|
||||
"mac_ssb_bullet": true,
|
||||
"expand_non_media_attachments": true,
|
||||
"show_typing": true,
|
||||
"pagekeys_handled": true,
|
||||
"last_snippet_type": "",
|
||||
"display_real_names_override": 0,
|
||||
"time24": false,
|
||||
"enter_is_special_in_tbt": false,
|
||||
"graphic_emoticons": false,
|
||||
"convert_emoticons": true,
|
||||
"autoplay_chat_sounds": true,
|
||||
"ss_emojis": true,
|
||||
"sidebar_behavior": "",
|
||||
"mark_msgs_read_immediately": true,
|
||||
"start_scroll_at_oldest": true,
|
||||
"snippet_editor_wrap_long_lines": false,
|
||||
"ls_disabled": false,
|
||||
"sidebar_theme": "default",
|
||||
"sidebar_theme_custom_values": "",
|
||||
"f_key_search": false,
|
||||
"k_key_omnibox": true,
|
||||
"speak_growls": false,
|
||||
"mac_speak_voice": "com.apple.speech.synthesis.voice.Alex",
|
||||
"mac_speak_speed": 250,
|
||||
"comma_key_prefs": false,
|
||||
"at_channel_suppressed_channels": "",
|
||||
"push_at_channel_suppressed_channels": "",
|
||||
"prompted_for_email_disabling": false,
|
||||
"full_text_extracts": false,
|
||||
"no_text_in_notifications": false,
|
||||
"muted_channels": "",
|
||||
"no_macssb1_banner": true,
|
||||
"no_winssb1_banner": false,
|
||||
"privacy_policy_seen": true,
|
||||
"search_exclude_bots": false,
|
||||
"fuzzy_matching": false,
|
||||
"load_lato_2": false,
|
||||
"fuller_timestamps": false,
|
||||
"last_seen_at_channel_warning": 0,
|
||||
"enable_flexpane_rework": false,
|
||||
"flex_resize_window": false,
|
||||
"msg_preview": false,
|
||||
"msg_preview_displaces": true,
|
||||
"msg_preview_persistent": true,
|
||||
"emoji_autocomplete_big": false,
|
||||
"winssb_run_from_tray": true
|
||||
},
|
||||
"created": 1421456475,
|
||||
"manual_presence": "active"
|
||||
},
|
||||
"team": {
|
||||
"id": "T03CX4S34",
|
||||
"name": "TESTteam, INC",
|
||||
"email_domain": "",
|
||||
"domain": "testteaminc",
|
||||
"msg_edit_window_mins": -1,
|
||||
"prefs": {
|
||||
"default_channels": [
|
||||
"C01CX1234",
|
||||
"C05BX1234"
|
||||
],
|
||||
"msg_edit_window_mins": -1,
|
||||
"allow_message_deletion": true,
|
||||
"hide_referers": true,
|
||||
"display_real_names": false,
|
||||
"who_can_at_everyone": "regular",
|
||||
"who_can_at_channel": "ra",
|
||||
"warn_before_at_channel": "always",
|
||||
"who_can_create_channels": "regular",
|
||||
"who_can_archive_channels": "regular",
|
||||
"who_can_create_groups": "ra",
|
||||
"who_can_post_general": "ra",
|
||||
"who_can_kick_channels": "admin",
|
||||
"who_can_kick_groups": "regular",
|
||||
"retention_type": 0,
|
||||
"retention_duration": 0,
|
||||
"group_retention_type": 0,
|
||||
"group_retention_duration": 0,
|
||||
"dm_retention_type": 0,
|
||||
"dm_retention_duration": 0,
|
||||
"require_at_for_mention": 0,
|
||||
"compliance_export_start": 0
|
||||
},
|
||||
"icon": {
|
||||
"image_34": "https:\/\/slack.global.ssl.fastly.net\/b3b7\/img\/avatars-teams\/ava_0025-34.png",
|
||||
"image_44": "https:\/\/slack.global.ssl.fastly.net\/b3b7\/img\/avatars-teams\/ava_0025-44.png",
|
||||
"image_68": "https:\/\/slack.global.ssl.fastly.net\/b3b7\/img\/avatars-teams\/ava_0025-68.png",
|
||||
"image_88": "https:\/\/slack.global.ssl.fastly.net\/b3b7\/img\/avatars-teams\/ava_0025-88.png",
|
||||
"image_102": "https:\/\/slack.global.ssl.fastly.net\/b3b7\/img\/avatars-teams\/ava_0025-102.png",
|
||||
"image_132": "https:\/\/slack.global.ssl.fastly.net\/b3b7\/img\/avatars-teams\/ava_0025-132.png",
|
||||
"image_default": true
|
||||
},
|
||||
"over_storage_limit": false
|
||||
},
|
||||
"latest_event_ts": "1426103085.000000",
|
||||
"channels": [
|
||||
{
|
||||
"id": "C01CX1234",
|
||||
"name": "general",
|
||||
"is_channel": true,
|
||||
"created": 1421456475,
|
||||
"creator": "U03CX4S38",
|
||||
"is_archived": false,
|
||||
"is_general": true,
|
||||
"is_member": true,
|
||||
"last_read": "0000000000.000000",
|
||||
"latest": {
|
||||
"type": "message",
|
||||
"user": "U03CX4S38",
|
||||
"text": "a",
|
||||
"ts": "1425499421.000004"
|
||||
},
|
||||
"unread_count": 0,
|
||||
"unread_count_display": 0,
|
||||
"members": [
|
||||
"U03CX4S38"
|
||||
],
|
||||
"topic": {
|
||||
"value": "",
|
||||
"creator": "",
|
||||
"last_set": 0
|
||||
},
|
||||
"purpose": {
|
||||
"value": "This channel is for team-wide communication and announcements. All team members are in this channel.",
|
||||
"creator": "",
|
||||
"last_set": 0
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "C05BX1234",
|
||||
"name": "random",
|
||||
"is_channel": true,
|
||||
"created": 1421456475,
|
||||
"creator": "U03CX4S38",
|
||||
"is_archived": false,
|
||||
"is_general": false,
|
||||
"is_member": true,
|
||||
"last_read": "0000000000.000000",
|
||||
"latest": null,
|
||||
"unread_count": 0,
|
||||
"unread_count_display": 0,
|
||||
"members": [
|
||||
"U03CX4S38"
|
||||
],
|
||||
"topic": {
|
||||
"value": "",
|
||||
"creator": "",
|
||||
"last_set": 0
|
||||
},
|
||||
"purpose": {
|
||||
"value": "A place for non-work banter, links, articles of interest, humor or anything else which you'd like concentrated in some place other than work-related channels.",
|
||||
"creator": "",
|
||||
"last_set": 0
|
||||
}
|
||||
}
|
||||
],
|
||||
"groups": [],
|
||||
"ims": [
|
||||
{
|
||||
"id": "D03CX4S3E",
|
||||
"is_im": true,
|
||||
"user": "USLACKBOT",
|
||||
"created": 1421456475,
|
||||
"last_read": "1425318850.000003",
|
||||
"latest": {
|
||||
"type": "message",
|
||||
"user": "USLACKBOT",
|
||||
"text": "To start, what is your first name?",
|
||||
"ts": "1425318850.000003"
|
||||
},
|
||||
"unread_count": 0,
|
||||
"unread_count_display": 0,
|
||||
"is_open": true
|
||||
}
|
||||
],
|
||||
"users": [
|
||||
{
|
||||
"id": "U10CX1234",
|
||||
"name": "fakeuser",
|
||||
"deleted": false,
|
||||
"status": null,
|
||||
"color": "9f69e7",
|
||||
"profile": {
|
||||
"email": "fakeuser@example.com",
|
||||
"image_24": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=24&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002-24.png",
|
||||
"image_32": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=32&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002-32.png",
|
||||
"image_48": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=48&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F272a%2Fimg%2Favatars%2Fava_0002-48.png",
|
||||
"image_72": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=72&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002-72.png",
|
||||
"image_192": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=192&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002.png"
|
||||
},
|
||||
"is_admin": true,
|
||||
"is_owner": true,
|
||||
"is_primary_owner": true,
|
||||
"is_restricted": false,
|
||||
"is_ultra_restricted": false,
|
||||
"is_bot": false,
|
||||
"has_files": false,
|
||||
"presence": "away"
|
||||
},
|
||||
{
|
||||
"id": "U10CX1235",
|
||||
"name": "userwithoutemail",
|
||||
"deleted": false,
|
||||
"status": null,
|
||||
"color": "9f69e7",
|
||||
"profile": {
|
||||
"image_24": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=24&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002-24.png",
|
||||
"image_32": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=32&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002-32.png",
|
||||
"image_48": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=48&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F272a%2Fimg%2Favatars%2Fava_0002-48.png",
|
||||
"image_72": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=72&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002-72.png",
|
||||
"image_192": "https:\/\/secure.gravatar.com\/avatar\/4f1bd7fd71e645fa19620504b4c0e3ba.jpg?s=192&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F3654%2Fimg%2Favatars%2Fava_0002.png"
|
||||
},
|
||||
"is_admin": true,
|
||||
"is_owner": true,
|
||||
"is_primary_owner": true,
|
||||
"is_restricted": false,
|
||||
"is_ultra_restricted": false,
|
||||
"is_bot": false,
|
||||
"has_files": false,
|
||||
"presence": "away"
|
||||
},
|
||||
{
|
||||
"id": "USLACKBOT",
|
||||
"name": "slackbot",
|
||||
"deleted": false,
|
||||
"status": null,
|
||||
"color": "757575",
|
||||
"real_name": "Slack Bot",
|
||||
"tz": null,
|
||||
"tz_label": "Pacific Daylight Time",
|
||||
"tz_offset": -25200,
|
||||
"profile": {
|
||||
"first_name": "Slack",
|
||||
"last_name": "Bot",
|
||||
"image_24": "https:\/\/slack-assets2.s3-us-west-2.amazonaws.com\/10068\/img\/slackbot_24.png",
|
||||
"image_32": "https:\/\/slack-assets2.s3-us-west-2.amazonaws.com\/10068\/img\/slackbot_32.png",
|
||||
"image_48": "https:\/\/slack-assets2.s3-us-west-2.amazonaws.com\/10068\/img\/slackbot_48.png",
|
||||
"image_72": "https:\/\/slack-assets2.s3-us-west-2.amazonaws.com\/10068\/img\/slackbot_72.png",
|
||||
"image_192": "https:\/\/slack-assets2.s3-us-west-2.amazonaws.com\/10068\/img\/slackbot_192.png",
|
||||
"real_name": "Slack Bot",
|
||||
"real_name_normalized": "Slack Bot",
|
||||
"email": null
|
||||
},
|
||||
"is_admin": false,
|
||||
"is_owner": false,
|
||||
"is_primary_owner": false,
|
||||
"is_restricted": false,
|
||||
"is_ultra_restricted": false,
|
||||
"is_bot": false,
|
||||
"presence": "active"
|
||||
}
|
||||
],
|
||||
"bots": [],
|
||||
"cache_version": "v5-dog",
|
||||
"url": "wss:\/\/cerberus-xxxx.lb.slack-msgs.com\/websocket\/ifkp3MKfNXd6ftbrEGllwcHn"
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
|
|
@ -0,0 +1,47 @@
|
|||
from slackclient.channel import Channel
|
||||
|
||||
|
||||
def test_channel(channel):
|
||||
assert type(channel) == Channel
|
||||
|
||||
|
||||
def test_channel_eq(channel):
|
||||
channel = Channel(
|
||||
'test-server',
|
||||
'test-channel',
|
||||
'C12345678',
|
||||
)
|
||||
assert channel == 'test-channel'
|
||||
assert channel == '#test-channel'
|
||||
assert channel == 'C12345678'
|
||||
assert 'C12345678' in str(channel)
|
||||
assert 'C12345678' in "%r" % channel
|
||||
assert (channel == 'foo') is False
|
||||
|
||||
|
||||
def test_channel_is_hashable(channel):
|
||||
channel = Channel(
|
||||
'test-server',
|
||||
'test-channel',
|
||||
'C12345678',
|
||||
)
|
||||
channel_map = {channel: channel.id}
|
||||
assert channel_map[channel] == 'C12345678'
|
||||
assert (channel_map[channel] == 'foo') is False
|
||||
|
||||
|
||||
def test_channel_send_message(channel, mocker, monkeypatch):
|
||||
mock_server = mocker.Mock()
|
||||
monkeypatch.setattr(channel, 'server', mock_server)
|
||||
channel.send_message('hi')
|
||||
mock_server.rtm_send_message.assert_called_with(channel.id, 'hi', None, False)
|
||||
|
||||
|
||||
def test_channel_send_message_to_thread(channel, mocker, monkeypatch):
|
||||
mock_server = mocker.Mock()
|
||||
monkeypatch.setattr(channel, 'server', mock_server)
|
||||
channel.send_message('hi', thread='123456.789')
|
||||
mock_server.rtm_send_message.assert_called_with(channel.id, 'hi', '123456.789', False)
|
||||
|
||||
channel.send_message('hi', thread='123456.789', reply_broadcast=True)
|
||||
mock_server.rtm_send_message.assert_called_with(channel.id, 'hi', '123456.789', True)
|
||||
|
|
@ -0,0 +1,236 @@
|
|||
import json
|
||||
import pytest
|
||||
import responses
|
||||
import time
|
||||
import urllib3
|
||||
|
||||
from mock import patch
|
||||
|
||||
from slackclient.user import User
|
||||
from slackclient.server import Server, SlackConnectionError
|
||||
from slackclient.channel import Channel
|
||||
|
||||
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
|
||||
|
||||
@pytest.fixture
|
||||
def rtm_start_fixture():
|
||||
file_login_data = open('tests/data/rtm.start.json', 'r').read()
|
||||
json_login_data = json.loads(file_login_data)
|
||||
return json_login_data
|
||||
|
||||
|
||||
def test_server():
|
||||
server = Server(token="valid_token", connect=False)
|
||||
assert type(server) == Server
|
||||
|
||||
# The server eqs to a string, either the token or workspace domain
|
||||
assert server.token == "valid_token"
|
||||
|
||||
|
||||
def test_server_connect(rtm_start_fixture):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.start",
|
||||
status=200,
|
||||
json=rtm_start_fixture
|
||||
)
|
||||
|
||||
Server(token="token", connect=True)
|
||||
|
||||
for call in rsps.calls:
|
||||
assert call.request.url in [
|
||||
"https://slack.com/api/rtm.start"
|
||||
]
|
||||
|
||||
|
||||
def test_api_call_for_empty_slack_responses(server):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/chat.postMessage",
|
||||
status=429,
|
||||
headers={"Retry-After": "1"},
|
||||
)
|
||||
|
||||
response_received = server.api_call("token", "chat.postMessage")
|
||||
chat_postMessage_response = rsps.calls[0].response
|
||||
|
||||
assert chat_postMessage_response.text == ""
|
||||
expected_response = {
|
||||
"headers": {"Content-Type": "text/plain", "Retry-After": "1"}
|
||||
}
|
||||
assert json.loads(response_received) == expected_response
|
||||
|
||||
|
||||
def test_server_is_hashable(server):
|
||||
server_map = {server: server.token}
|
||||
assert server_map[server] == 'xoxp-1234123412341234-12341234-1234'
|
||||
assert (server_map[server] == 'foo') is False
|
||||
|
||||
|
||||
@patch('time.sleep', return_value=None)
|
||||
def test_rate_limiting(patched_time_sleep, server):
|
||||
# Testing for rate limit retry headers
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.start",
|
||||
status=429,
|
||||
json={"ok": False},
|
||||
headers={'Retry-After': "1"}
|
||||
)
|
||||
|
||||
with pytest.raises(SlackConnectionError) as e:
|
||||
server.rtm_connect()
|
||||
for call in rsps.calls:
|
||||
assert call.response.status_code == 429
|
||||
assert e.message == "RTM connection attempt was rate limited 10 times."
|
||||
|
||||
|
||||
def test_custom_agent(server):
|
||||
server.append_user_agent("test agent", 1.0)
|
||||
assert server.api_requester.custom_user_agent[0] == ['test agent', 1.0]
|
||||
|
||||
|
||||
def test_server_parse_channel_data(server, rtm_start_fixture):
|
||||
server.parse_channel_data(rtm_start_fixture["channels"])
|
||||
assert type(server.channels.find('general')) == Channel
|
||||
|
||||
|
||||
def test_server_parse_user_data(server, rtm_start_fixture):
|
||||
server.parse_user_data(rtm_start_fixture["users"])
|
||||
# Find user by Name
|
||||
user_by_name = server.users.find('fakeuser')
|
||||
assert type(user_by_name) == User
|
||||
assert user_by_name == "fakeuser"
|
||||
assert user_by_name != "someotheruser"
|
||||
# Find user by ID
|
||||
user_by_id = server.users.find('U10CX1234')
|
||||
assert type(user_by_id) == User
|
||||
assert user_by_id == "fakeuser"
|
||||
assert user_by_id.email == 'fakeuser@example.com'
|
||||
# Don't find invalid user
|
||||
user_by_id = server.users.find('invaliduser')
|
||||
assert user_by_id is None
|
||||
|
||||
|
||||
def test_server_cant_connect(server):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.start",
|
||||
status=403,
|
||||
json={"ok": False}
|
||||
)
|
||||
|
||||
with pytest.raises(SlackConnectionError) as e:
|
||||
server.rtm_connect()
|
||||
|
||||
|
||||
def test_reconnect_flag(server, rtm_start_fixture):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.start",
|
||||
status=200,
|
||||
json=rtm_start_fixture
|
||||
)
|
||||
|
||||
server.rtm_connect(auto_reconnect=True)
|
||||
assert server.auto_reconnect is True
|
||||
|
||||
for call in rsps.calls:
|
||||
assert call.request.url in [
|
||||
"https://slack.com/api/rtm.start"
|
||||
]
|
||||
|
||||
|
||||
def test_rtm_reconnect(server, rtm_start_fixture):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.connect",
|
||||
status=200,
|
||||
json=rtm_start_fixture
|
||||
)
|
||||
|
||||
server.rtm_connect(auto_reconnect=True, reconnect=True, use_rtm_start=False)
|
||||
|
||||
for call in rsps.calls:
|
||||
assert call.request.url in [
|
||||
"https://slack.com/api/rtm.connect"
|
||||
]
|
||||
|
||||
|
||||
@patch('time.sleep', return_value=None)
|
||||
def test_rtm_max_reconnect_timeout(patched_time_sleep, server, rtm_start_fixture):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.connect",
|
||||
status=200,
|
||||
json=rtm_start_fixture
|
||||
)
|
||||
|
||||
server.reconnect_count = 4
|
||||
server.last_connected_at = time.time()
|
||||
server.rtm_connect(auto_reconnect=True, reconnect=True, use_rtm_start=False)
|
||||
|
||||
assert server.reconnect_count == 5
|
||||
|
||||
|
||||
def test_rtm_reconnect_timeout_recently_connected(server, rtm_start_fixture):
|
||||
# If reconnected recently, server must wait to reconnect and increment the counter
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.connect",
|
||||
status=200,
|
||||
json=rtm_start_fixture
|
||||
)
|
||||
|
||||
server.reconnect_count = 0
|
||||
server.last_connected_at = time.time()
|
||||
server.rtm_connect(auto_reconnect=True, reconnect=True, use_rtm_start=False)
|
||||
|
||||
assert server.reconnect_count == 1
|
||||
for call in rsps.calls:
|
||||
assert call.request.url in [
|
||||
"https://slack.com/api/rtm.connect"
|
||||
]
|
||||
|
||||
|
||||
def test_rtm_reconnect_timeout_not_recently_connected(server, rtm_start_fixture):
|
||||
# If reconnecting after 3 minutes since last reconnect, reset counter and connect without wait
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/rtm.connect",
|
||||
status=200,
|
||||
json=rtm_start_fixture
|
||||
)
|
||||
|
||||
server.reconnect_count = 1
|
||||
server.last_connected_at = time.time() - 180
|
||||
server.rtm_connect(auto_reconnect=True, reconnect=True, use_rtm_start=False)
|
||||
|
||||
assert server.reconnect_count == 0
|
||||
for call in rsps.calls:
|
||||
assert call.request.url in [
|
||||
"https://slack.com/api/rtm.connect"
|
||||
]
|
||||
|
||||
|
||||
def test_max_rtm_reconnects(server, monkeypatch):
|
||||
monkeypatch.setattr("time.sleep", None)
|
||||
with pytest.raises(SlackConnectionError) as e:
|
||||
server.reconnect_count = 5
|
||||
server.rtm_connect(auto_reconnect=True, reconnect=True, use_rtm_start=False)
|
||||
assert e.message == "RTM connection failed, reached max reconnects."
|
||||
|
||||
|
||||
@pytest.mark.xfail
|
||||
def test_server_ping(server, monkeypatch):
|
||||
monkeypatch.setattr("websocket.create_connection", lambda: True)
|
||||
reply = server.ping()
|
||||
|
|
@ -0,0 +1,295 @@
|
|||
import json
|
||||
import pytest
|
||||
from requests.exceptions import ProxyError
|
||||
import responses
|
||||
from slackclient.exceptions import TokenRefreshError
|
||||
from slackclient.channel import Channel
|
||||
from slackclient.client import SlackClient
|
||||
from slackclient.server import SlackConnectionError
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def channel_created_fixture():
|
||||
file_channel_created_data = open("tests/data/channel.created.json", "r").read()
|
||||
json_channel_created_data = json.loads(file_channel_created_data)
|
||||
return json_channel_created_data
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def im_created_fixture():
|
||||
file_channel_created_data = open("tests/data/im.created.json", "r").read()
|
||||
json_channel_created_data = json.loads(file_channel_created_data)
|
||||
return json_channel_created_data
|
||||
|
||||
|
||||
def test_proxy():
|
||||
proxies = {"http": "some-bad-proxy", "https": "some-bad-proxy"}
|
||||
client = SlackClient("xoxp-1234123412341234-12341234-1234", proxies=proxies)
|
||||
server = client.server
|
||||
|
||||
assert server.proxies == proxies
|
||||
|
||||
with pytest.raises(ProxyError):
|
||||
server.rtm_connect()
|
||||
|
||||
with pytest.raises(SlackConnectionError):
|
||||
server.connect_slack_websocket(
|
||||
"wss://mpmulti-xw58.slack-msgs.com/websocket/bad-token"
|
||||
)
|
||||
|
||||
api_requester = server.api_requester
|
||||
assert api_requester.proxies == proxies
|
||||
with pytest.raises(ProxyError):
|
||||
api_requester.do("xoxp-1234123412341234-12341234-1234", request="channels.list")
|
||||
|
||||
|
||||
def test_SlackClient(slackclient):
|
||||
assert type(slackclient) == SlackClient
|
||||
|
||||
|
||||
def test_custom_user_agent(slackclient):
|
||||
slackclient.append_user_agent("customua", "1.0.0")
|
||||
assert "customua" in slackclient.server.api_requester.get_user_agent()
|
||||
|
||||
|
||||
def test_SlackClient_process_changes(
|
||||
slackclient, channel_created_fixture, im_created_fixture
|
||||
):
|
||||
slackclient.process_changes(channel_created_fixture)
|
||||
assert type(slackclient.server.channels.find("fun")) == Channel
|
||||
slackclient.process_changes(im_created_fixture)
|
||||
assert type(slackclient.server.channels.find("U123BL234")) == Channel
|
||||
|
||||
|
||||
def test_api_not_ok(slackclient):
|
||||
# Testing for rate limit retry headers
|
||||
client = SlackClient("xoxp-1234123412341234-12341234-1234")
|
||||
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/im.open",
|
||||
status=200,
|
||||
json={"ok": False, "error": "invalid_auth"},
|
||||
headers={},
|
||||
)
|
||||
|
||||
client.api_call("im.open", user="UXXXX")
|
||||
|
||||
for call in rsps.calls:
|
||||
assert call.response.status_code == 200
|
||||
assert call.request.url in ["https://slack.com/api/im.open"]
|
||||
|
||||
|
||||
def test_im_open(slackclient):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/im.open",
|
||||
status=200,
|
||||
json={"ok": True, "channel": {"id": "CXXXXXX"}},
|
||||
headers={},
|
||||
)
|
||||
|
||||
slackclient.api_call("im.open", user="UXXXX")
|
||||
|
||||
for call in rsps.calls:
|
||||
assert call.response.status_code == 200
|
||||
assert call.request.url in ["https://slack.com/api/im.open"]
|
||||
|
||||
|
||||
def test_channel_join(slackclient):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/channels.join",
|
||||
status=200,
|
||||
json={
|
||||
"ok": True,
|
||||
"channel": {
|
||||
"id": "CXXXX",
|
||||
"name": "test",
|
||||
"members": ("U0G9QF9C6", "U1QNSQB9U"),
|
||||
},
|
||||
},
|
||||
)
|
||||
|
||||
slackclient.api_call("channels.join", channel="CXXXX")
|
||||
|
||||
for call in rsps.calls:
|
||||
assert call.response.status_code == 200
|
||||
assert call.request.url in ["https://slack.com/api/channels.join"]
|
||||
response_json = call.response.json()
|
||||
assert response_json["ok"] is True
|
||||
|
||||
|
||||
def test_noncallable_refresh_callback():
|
||||
with pytest.raises(TokenRefreshError):
|
||||
SlackClient(
|
||||
client_id="12345",
|
||||
client_secret="12345",
|
||||
refresh_token="refresh_token",
|
||||
token_update_callback="THIS IS A STRING, NOT A CALLABLE METHOD",
|
||||
)
|
||||
|
||||
|
||||
def test_no_RTM_with_workspace_tokens():
|
||||
def token_update_callback(update_data):
|
||||
return update_data
|
||||
|
||||
with pytest.raises(TokenRefreshError):
|
||||
sc = SlackClient(
|
||||
client_id="12345",
|
||||
client_secret="12345",
|
||||
refresh_token="refresh_token",
|
||||
token_update_callback=token_update_callback,
|
||||
)
|
||||
|
||||
sc.rtm_connect()
|
||||
|
||||
|
||||
def test_token_refresh_on_initial_api_request():
|
||||
# Client should fetch and append an access token on the first API request
|
||||
|
||||
# When the token is refreshed, the client will call this callback
|
||||
access_token = "xoxa-2-abcdef"
|
||||
client_args = {}
|
||||
|
||||
def token_update_callback(update_data):
|
||||
client_args[update_data["team_id"]] = update_data
|
||||
|
||||
sc = SlackClient(
|
||||
client_id="12345",
|
||||
client_secret="12345",
|
||||
refresh_token="refresh_token",
|
||||
token_update_callback=token_update_callback,
|
||||
)
|
||||
|
||||
# The client starts out with an empty token
|
||||
assert sc.token is None
|
||||
|
||||
# Mock both the main API request and the token refresh request
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/auth.test",
|
||||
status=200,
|
||||
json={"ok": True},
|
||||
)
|
||||
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/oauth.access",
|
||||
status=200,
|
||||
json={
|
||||
"ok": True,
|
||||
"access_token": access_token,
|
||||
"token_type": "app",
|
||||
"expires_in": 3600,
|
||||
"team_id": "T2U81E2FP",
|
||||
"enterprise_id": "T2U81ELK",
|
||||
},
|
||||
)
|
||||
|
||||
# Calling the API for the first time will trigger a token refresh
|
||||
sc.api_call("auth.test")
|
||||
|
||||
# Store the calls in order
|
||||
calls = {}
|
||||
for index, call in enumerate(rsps.calls):
|
||||
calls[index] = {"url": call.request.url}
|
||||
|
||||
# After the initial call, the refresh method will update the client's token,
|
||||
# then the callback will update client_args
|
||||
assert sc.token == access_token
|
||||
assert client_args["T2U81E2FP"]["access_token"] == access_token
|
||||
|
||||
# Verify that the client first tried to call the API, refreshed the token, then retried
|
||||
assert calls[0]["url"] == "https://slack.com/api/oauth.access"
|
||||
assert calls[1]["url"] == "https://slack.com/api/auth.test"
|
||||
|
||||
|
||||
def test_token_refresh_failed():
|
||||
# Client should raise TokenRefreshError is token refresh returns error
|
||||
def token_update_callback(update_data):
|
||||
return update_data
|
||||
|
||||
sc = SlackClient(
|
||||
client_id="12345",
|
||||
client_secret="12345",
|
||||
refresh_token="refresh_token",
|
||||
token_update_callback=token_update_callback,
|
||||
)
|
||||
|
||||
with pytest.raises(TokenRefreshError):
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/channels.list",
|
||||
status=200,
|
||||
json={"ok": False, "error": "invalid_auth"},
|
||||
)
|
||||
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/oauth.access",
|
||||
status=200,
|
||||
json={"ok": False, "error": "invalid_auth"},
|
||||
)
|
||||
|
||||
sc.api_call("channels.list")
|
||||
|
||||
|
||||
def test_token_refresh_on_expired_token():
|
||||
# Client should fetch and append an access token on the first API request
|
||||
|
||||
# When the token is refreshed, the client will call this callback
|
||||
client_args = {}
|
||||
|
||||
def token_update_callback(update_data):
|
||||
client_args[update_data["team_id"]] = update_data
|
||||
|
||||
sc = SlackClient(
|
||||
client_id="12345",
|
||||
client_secret="12345",
|
||||
refresh_token="refresh_token",
|
||||
token_update_callback=token_update_callback,
|
||||
)
|
||||
|
||||
# Set the token TTL to some time in the past
|
||||
sc.access_token_expires_at = 0
|
||||
|
||||
# Mock both the main API request and the token refresh request
|
||||
with responses.RequestsMock() as rsps:
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/auth.test",
|
||||
status=200,
|
||||
json={"ok": True},
|
||||
)
|
||||
|
||||
rsps.add(
|
||||
responses.POST,
|
||||
"https://slack.com/api/oauth.access",
|
||||
status=200,
|
||||
json={
|
||||
"ok": True,
|
||||
"access_token": "xoxa-2-abcdef",
|
||||
"token_type": "app",
|
||||
"expires_in": 3600,
|
||||
"team_id": "T2U81E2FP",
|
||||
"enterprise_id": "T2U81ELK",
|
||||
},
|
||||
)
|
||||
|
||||
# Calling the API for the first time will trigger a token refresh
|
||||
sc.api_call("auth.test")
|
||||
|
||||
# Store the calls in order
|
||||
calls = {}
|
||||
for index, call in enumerate(rsps.calls):
|
||||
calls[index] = {"url": call.request.url}
|
||||
|
||||
# Verify that the client first fetches the token, then submits the request
|
||||
assert calls[0]["url"] == "https://slack.com/api/oauth.access"
|
||||
assert calls[1]["url"] == "https://slack.com/api/auth.test"
|
||||
|
|
@ -0,0 +1,114 @@
|
|||
from slackclient.slackrequest import SlackRequest
|
||||
from slackclient.version import __version__
|
||||
import os
|
||||
|
||||
|
||||
def test_http_headers(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123', 'chat.postMessage', {'text': 'test', 'channel': '#general'})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert kwargs['headers']['user-agent'] is not None
|
||||
|
||||
|
||||
def test_custom_user_agent(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.append_user_agent("fooagent1", "0.1")
|
||||
request.append_user_agent("baragent/2", "0.2")
|
||||
|
||||
request.do('xoxb-123', 'chat.postMessage', {'text': 'test', 'channel': '#general'})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
# Verify user-agent includes both default and custom agent info
|
||||
assert "slackclient/{}".format(__version__) in kwargs['headers']['user-agent']
|
||||
assert "fooagent1/0.1" in kwargs['headers']['user-agent']
|
||||
|
||||
# verify escaping of slashes in custom agent name
|
||||
assert "baragent:2/0.2" in kwargs['headers']['user-agent']
|
||||
|
||||
|
||||
def test_auth_header(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123', 'chat.postMessage', {'text': 'test', 'channel': '#general'})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert "Bearer xoxb-123" in kwargs['headers']['Authorization']
|
||||
|
||||
|
||||
def test_token_override(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123', 'chat.postMessage',
|
||||
{
|
||||
'token': "newtoken",
|
||||
'text': 'test',
|
||||
'channel': '#general'
|
||||
})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert "Bearer newtoken" in kwargs['headers']['Authorization']
|
||||
|
||||
|
||||
def test_plural_field(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123', 'conversations.open', {'users': ['U123', 'U234', 'U345']})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert kwargs['data'] == {'users': 'U123,U234,U345'}
|
||||
|
||||
request.do('xoxb-123', 'conversations.open', {'users': "U123,U234,U345"})
|
||||
args2, kwargs2 = requests.post.call_args
|
||||
|
||||
assert kwargs2['data'] == {'users': 'U123,U234,U345'}
|
||||
|
||||
|
||||
def test_post_file(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123',
|
||||
'files.upload',
|
||||
{'file': open(os.path.join('.', 'tests', 'data', 'slack_logo.png'), 'rb'),
|
||||
'filename': 'slack_logo.png'})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert requests.post.call_count == 1
|
||||
assert 'https://slack.com/api/files.upload' == args[0]
|
||||
assert {'filename': 'slack_logo.png'} == kwargs['data']
|
||||
assert kwargs['files'] is not None
|
||||
|
||||
|
||||
def test_get_file(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123', 'files.info', {'file': 'myFavoriteFileID'})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert requests.post.call_count == 1
|
||||
assert 'https://slack.com/api/files.info' == args[0]
|
||||
assert {'file': "myFavoriteFileID"} == kwargs['data']
|
||||
assert kwargs['files'] is None
|
||||
|
||||
|
||||
def test_post_attachements(mocker):
|
||||
requests = mocker.patch('slackclient.slackrequest.requests')
|
||||
request = SlackRequest()
|
||||
|
||||
request.do('xoxb-123',
|
||||
'chat.postMessage',
|
||||
{'attachments': [{'title': 'hello'}]})
|
||||
args, kwargs = requests.post.call_args
|
||||
|
||||
assert requests.post.call_count == 1
|
||||
assert 'https://slack.com/api/chat.postMessage' == args[0]
|
||||
assert isinstance(kwargs["data"]["attachments"], str)
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
[tox]
|
||||
; you probably don't have all of these python versions on your machine. when you invoke tox, you should pick an
|
||||
; environment that you have (e.g. `tox -e py27,py36,flake8`).
|
||||
; for quality analysis, use `tox -e flake8` or just `flake8 slackclient`
|
||||
; to build the docs, use `tox -e docs`
|
||||
envlist=
|
||||
py{27,34,35,36},
|
||||
flake8,
|
||||
docs
|
||||
|
||||
[testenv]
|
||||
deps = -rtest_requirements.txt
|
||||
commands =
|
||||
; `--cov-report=html:cov_html`: suppress terminal output, html report in `cov_html/`, populate `.coverage/`
|
||||
; `--cov=slackclient`: name project
|
||||
; `{posargs:tests}`: tests located in `tests` by default unless otherwise overriden by tox positional args
|
||||
py.test --cov-report=html:cov_html --cov=slackclient {posargs:tests}
|
||||
; `codecov` will run the `coverage` utility and then upload results in xml format
|
||||
; `coverage` utility has configuration in `.coveragerc`
|
||||
; CI systems use their own build matricies and virtualenvs and don't need tox. therefore tox shouldn't be used
|
||||
; to upload coverage to codecov
|
||||
; codecov -e TOXENV
|
||||
|
||||
[testenv:flake8]
|
||||
basepython = python
|
||||
deps = flake8
|
||||
commands = flake8 slackclient
|
||||
|
||||
[testenv:docs]
|
||||
basepython = python
|
||||
whitelist_externals = /bin/bash
|
||||
deps =
|
||||
Sphinx
|
||||
sphinx_rtd_theme
|
||||
commands = bash ./docs.sh
|
||||
Loading…
Add table
Add a link
Reference in a new issue