Frequently Asked Questions¶
What even is Slack Developer Kit for Python and why should I care?¶
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.
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.
OMG I found a bug!¶
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 Slack Developer Kit for Python, 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
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. If you are editing one of the many
reStructuredText files in the
docs-src folder, you’ll need to rebuild the documentation. First, install the project’s
development dependencies (ideally using virtualenv.
pip install -r requirements.txt -r requirements-dev.text
Then run Sphinx.
sphinx-build -c ./docs-src/_themes/slack/ -b html docs-src docs
Do be sure to add the
docs folder and its contents to your pull request!