Sample app for Pycon 2018 Slack app workshop
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Pycon 2018 Workshop.pdf
README.rst
complete-example.py
requirements.txt
starting-example.py

README.rst

https://user-images.githubusercontent.com/32463/39790649-1e029fc6-52ec-11e8-8e51-845f1f77dd58.png

Slack Pycon Workshop Bot

This repo is to complement the live demonstration being given at Pycon 2018.

This example app shows how easy it is to implement the Slack Events API Adapter to receive Slack Events and respond to messages using Slack's Web API via python-slackclient, with the added flair of message buttons to provide a neat feedback mechanism.

We'll be starting off with starting-example.py, which is a very basic echo bot based on the Slack Evants API Adapter example app available in that library's github repo. From there, we'll incrementally add additional functionality to end up in the same state as complete-example.py. If you're checking this out on your own, you may want to start with complete-example.py to see the completed [but still pretty basic] app.

πŸ€– Setup and running the app

Set up your Python environment:

We're using virtualenv to keep the dependencies and environmental variables specific to this app. See virtualenv docs for more info.

This example app works best in Python 2.7. If 2.7 is your default version, create a virtual environment by running:

virtualenv env

Otherwise, if Python 3+ is your default, specify the path to your 2.7 instance:

virtualenv -p /your/path/to/python2 env

Then initialize the virtualenv:

source env/bin/activate

Install the app's dependencies:

pip install -r requirements.txt

πŸ€– Create a Slack app

Create a Slack app on https://api.slack.com/apps/

https://cloud.githubusercontent.com/assets/32463/24877733/32979776-1de5-11e7-87d4-b5dc9e3e7973.png

πŸ€– Add a bot user to your app

https://cloud.githubusercontent.com/assets/32463/24877750/47a16034-1de5-11e7-989b-2a90b9d8e7e3.png

πŸ€– Install your app on your team

Visit your app's Install App page and click Install App to Team.

https://cloud.githubusercontent.com/assets/32463/24877770/61804c36-1de5-11e7-91ef-5cf2e0845729.png

Authorize your app

https://cloud.githubusercontent.com/assets/32463/24877792/774ed94c-1de5-11e7-8857-ac8d662c5b27.png

πŸ€– Save your app's credentials

Once you've authorized your app, you'll be presented with your app's tokens.

https://cloud.githubusercontent.com/assets/32463/24877652/d8eebbb4-1de4-11e7-8f75-2cfb1e9d45ee.png

Copy your app's Bot User OAuth Access Token and add it to your python environmental variables

export SLACK_BOT_TOKEN=xxxXXxxXXxXXxXXXXxxxX.xXxxxXxxxx

Next, go back to your app's Basic Information page

https://cloud.githubusercontent.com/assets/32463/24877833/950dd53c-1de5-11e7-984f-deb26e8b9482.png

Add your app's Verification Token to your python environmental variables

export SLACK_VERIFICATION_TOKEN=xxxxxxxxXxxXxxXxXXXxxXxxx

πŸ€– Start ngrok

In order for Slack to contact your local server, you'll need to run a tunnel. We recommend ngrok or localtunnel. We're going to use ngrok for this example.

If you don't have ngrok, download it here.

Here's a rudimentary diagream of how ngrok allows Slack to connect to your server

https://cloud.githubusercontent.com/assets/32463/25376866/940435fa-299d-11e7-9ee3-08d9427417f6.png

πŸ’‘ Slack requires event requests be delivered over SSL, so you'll want to
use the HTTPS URL provided by ngrok.

Run ngrok and copy the HTTPS URL

ngrok http 3000
ngrok by @inconshreveable (Ctrl+C to quit)

Session status                      online
Version                             2.1.18
Region                  United States (us)
Web Interface        http://127.0.0.1:4040

Forwarding http://h7465j.ngrok.io -> localhost:9292
Forwarding https://h7465j.ngrok.io -> localhost:9292

πŸ€– Run the app:

You'll need to have your server and ngrok running to complete your app's Event Subscription setup

python example.py

πŸ€– Subscribe your app to events

Add your Request URL (your ngrok URL + /slack/events) and subscribe your app to reaction_added, message.channels and app_mentions under bot events. Save and toggle Enable Events to on

https://user-images.githubusercontent.com/1573454/30185162-644d0cb8-93ee-11e7-96af-55fe10d9d5c8.png

https://cloud.githubusercontent.com/assets/32463/24877931/e119181a-1de5-11e7-8b0c-fcbc3419bad7.png

πŸŽ‰ Once your app has been installed and subscribed to Bot Events, you will begin receiving event data from Slack

πŸ‘‹ Interact with your bot:

Invite your bot to a public channel, then say hi and your bot will respond

hi @bot πŸ‘‹

React to your bot's greeting and the bot will echo back the eomi you reacted with

@roach reacted with 😎

Next, mention your app's bot user directly and the bot will promt you for feedback

prompt:

@bot I have feedback!

response:

Hi @roach! How do you feel this workshop is going?

https://cloud.githubusercontent.com/assets/32463/23047918/964defec-f467-11e6-87c3-9c7da11fc810.gif

More neat things:

Check out the other events you can subscribe to 😎

Play with our Message Builder to see more message formatting options πŸ˜„

Browse our example apps on Github for more functionality, like Dialogs 🀩

πŸ€” Support

Need help? Join Bot Developer Hangout and talk to us in #slack-api.

You can also create an Issue right here on GitHub.