python-slackclient/docs/faq.html at master · farshield/python-slackclient

History

189 lines (170 loc) · 13.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

<!DOCTYPE html>

<head>

<title>Frequently Asked Questions — Slack Developer Kit for Python</title>

</head>

</a>

</a>

<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>

</span>

<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>

<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#test-tokens">Test Tokens</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#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>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging</a><ul>

<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-real-time-messaging-api">Connecting to the Real Time Messaging API</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>

</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>

<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>

<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/CODE_OF_CONDUCT.md">Code of Conduct</a></li>

<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/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>

</nav>

<div class="section-title">Frequently Asked Questions</div>

<h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permalink to this headline">¶</a></h1>

<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=&quo 80C0 t;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 RTM or Events bot-building APIs, although we anticipate

adding support for these in the future.</p>

</div>

<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>

<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>

<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/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>

<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"><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>

</div>

<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"><span class="pre">docs-src</span></code> folder, you’ll need to rebuild the documentation. First, install the project’s

development dependencies (ideally using <a class="reference external" href="https://virtualenv.pypa.io">virtualenv</a>.</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>pip install -r requirements.txt -r requirements-dev.text

</pre></div>

</div>

<p>Then run Sphinx.</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>sphinx-build -c ./docs-src/_themes/slack/ -b html docs-src docs

</pre></div>

</div>

<p>Do be sure to add the <code class="docutils literal"><span class="pre">docs</span></code> folder and its contents to your pull request!</p>

</div>

</div>

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

faq.html

Latest commit

History

faq.html

File metadata and controls