Skip to content

Commit f8ba477

Browse files
authored
Updated README (#1)
* Initial release updates
1 parent 0110257 commit f8ba477

11 files changed

Lines changed: 27 additions & 18 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.cache
33
.idea
44
dist
5-
slackceventsapi.egg-info
5+
slackeventsapi.egg-info
66
*.log
77
env
88
.tox

travis.yml renamed to .travis.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
sudo: false
22
language: python
33
python:
4-
- "3.5"
4+
- "2.7"
55
env:
66
matrix:
77
- TOX_ENV=py27
8-
- TOX_ENV=py34
9-
- TOX_ENV=py35
108
- TOX_ENV=flake8
119
cache: pip
1210
install:

README.rst

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
Slack Events API adapter for Python
22
===================================
33

4+
.. image:: https://travis-ci.org/slackapi/python-slack-events-api.svg?branch=master
5+
:target: https://travis-ci.org/slackapi/python-slack-events-api
6+
.. image:: https://codecov.io/gh/slackapi/python-slack-events-api/branch/master/graph/badge.svg
7+
:target: https://codecov.io/gh/slackapi/python-slack-events-api
8+
9+
410
The Slack Events Adapter is a Python-based solution to receive and parse events
511
from Slack’s Events API. This library uses an event emitter framework to allow
612
you to easily process Slack events by simply attaching functions
713
to event listeners.
814

15+
This adapter enhances and simplifies Slack's Events API by incorporating useful best practices, patterns, and opportunities to abstract out common tasks.
16+
17+
💡 We wrote a `blog post which explains how`_ the Events API can help you, why we built these tools, and how you can use them to build production-ready Slack apps.
18+
19+
.. _blog post which explains how: https://medium.com/@SlackAPI/enhancing-slacks-events-api-7535827829ab
20+
21+
922
🤖 Installation
1023
------------
1124

@@ -20,10 +33,6 @@ Before you can use the `Events API`_ you must
2033
`create a Slack App`_, and turn on
2134
`Event Subscriptions`_.
2235

23-
.. _Events API: https://api.slack.com/events-api
24-
.. _create a Slack App: https://api.slack.com/apps/new
25-
.. _Event Subscriptions: https://api.slack.com/events-api#subscriptions
26-
2736
💡 When you add the Request URL to your app's Event Subscription settings,
2837
Slack will send a request containing a `challenge` code to verify that your
2938
server is alive. This package handles that URL Verification event for you, so
@@ -106,13 +115,13 @@ SlackClient Web API client.
106115
🤔 Support
107116
-------
108117

109-
Need help? Join `dev4slack`_ and talk to us in `#slack-api`_.
118+
Need help? Join `Bot Developer Hangout`_ and talk to us in `#slack-api`_.
110119

111120
You can also `create an Issue`_ right here on GitHub.
112121

113122
.. _Events API: https://api.slack.com/events-api
114123
.. _create a Slack App: https://api.slack.com/apps/new
115124
.. _Event Subscriptions: https://api.slack.com/events-api#subscriptions
116-
.. _dev4slack: http://dev4slack.xoxco.com/
125+
.. _Bot Developer Hangout: http://dev4slack.xoxco.com/
117126
.. _#slack-api: https://dev4slack.slack.com/messages/slack-api/
118127
.. _create an Issue: https://github.com/slackapi/python-slack-events-api/issues/new

example/README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Example Slack events API bot
2-
===================================
2+
============================
33

44
This example app shows how easy it is to implement the Slack Events API Adapter
55
to receive Slack Events, extend it to handle the OAuth flow and respond to
@@ -114,24 +114,24 @@ Go to your ngrok URL (e.g. https://myapp12.ngrok.com/) and auth your app.
114114

115115
**🎉 Once your app has been authorized, you will begin receiving Slack events**
116116

117-
**👋🏻 Interact with your bot:**
117+
**👋 Interact with your bot:**
118118

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

121-
hi @bot 👋🏻
121+
hi @bot 👋
122122

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

125125
🤔 Support
126126
-------
127127

128-
Need help? Join `dev4slack`_ and talk to us in `#slack-api`_.
128+
Need help? Join `Bot Developer Hangout`_ and talk to us in `#slack-api`_.
129129

130130
You can also `create an Issue`_ right here on GitHub.
131131

132132
.. _Events API: https://api.slack.com/events-api
133133
.. _create a Slack App: https://api.slack.com/apps/new
134134
.. _Event Subscriptions: https://api.slack.com/events-api#subscriptions
135-
.. _dev4slack: http://dev4slack.xoxco.com/
135+
.. _Bot Developer Hangout: http://dev4slack.xoxco.com/
136136
.. _#slack-api: https://dev4slack.slack.com/messages/slack-api/
137137
.. _create an Issue: https://github.com/slackapi/node-slack-events-api/issues/new

slackeventsapi/__init__.pyc

-1.05 KB
Binary file not shown.

slackeventsapi/server.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ def event():
1818

1919
# Echo the URL verification challenge code
2020
if "challenge" in event_data:
21-
return make_response(event_data.get("challenge"), 200, {"content_type": "application/json"})
21+
return make_response(
22+
event_data.get("challenge"), 200, {"content_type": "application/json"}
23+
)
2224

2325
# Parse the Event payload and emit the event to the event listener
2426
if "event" in event_data:

slackeventsapi/server.pyc

-1.65 KB
Binary file not shown.
-1.65 KB
Binary file not shown.
-2.09 KB
Binary file not shown.
-3.26 KB
Binary file not shown.

0 commit comments

Comments
 (0)