python-slackclient/docs/faq.html at master · matt-stack/python-slackclient

History

284 lines (269 loc) · 16.6 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

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

<!DOCTYPE html>

<head>

<meta

http-equiv="Content-Type"

content="text/html; charset=utf-8"

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

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

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

<noscript

><iframe

src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7"

height="0"

width="0"

style="display:none;visibility:hidden"

></iframe

></noscript>

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

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#keeping-tokens-safe">Keeping tokens safe</a></li>

<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

<li class="toctree-l2"><a class="reference internal" href="auth.html#multiple-workspace-install">Multiple Workspace Install</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#formatting-with-block-kit">Formatting with Block Kit</a></li>

<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#threading-messages">Threading Messages</a></li>

<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-a-message">Updating 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#opening-a-modal">Opening a modal</a></li>

<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#updating-and-pushing-modals">Updating and pushing modals</a></li>

<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#emoji-reactions">Emoji reactions</a></li>

<li class="toctree-l2"><a class="reference internal" href="basic_usage.html#listing-channels">Listing 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#listing-team-members">Listing 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#direct-messages">Direct messages</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-channels">Creating channels</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-more-information">Getting more information</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#listing-conversations">Listing 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#getting-members">Getting 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>

</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="#i-found-a-bug">I found a bug!</a></li>

<li class="toctree-l2"><a class="reference internal" href="#there-s-a-feature-missing">There’s a feature missing!</a></li>

<li class="toctree-l2"><a class="reference internal" href="#how-do-i-contribute">How do I contribute?</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://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>

</nav>

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

<h2>I found a bug!<a class="headerlink" href="#i-found-a-bug" title="Permalink to this headline">¶</a></h2>

<p>That’s great! Thank you. Let us know on the <a href="#id4"><span class="problematic" id="id5">`Issue Tracker`_</span></a>. If you’re feeling particularly ambitious, why not submit a <a href="#id6"><span class="problematic" id="id7">`pull request`_</span></a> with a bug fix?</p>

</div>

<h2>There’s a feature missing!<a class="headerlink" href="#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="https://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="https://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>How do I contribute?<a class="headerlink" href="#how-do-i-contribute" 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>.</p>

<p>All done? Great! While we’re super excited to incorporate your new feature, there are a couple of things we want to make sure you’ve given thought to.</p>

<li><p>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!</p></li>

<li><p>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>!</p></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 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>

</p>

</footer>

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>

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