Metadata-Version: 2.1
Name: slackapidecorator
Version: 0.1.2
Summary: slack api decorator
Home-page: https://github.com/gsy0911/slack-api-decorator
Author: gsy0911
Author-email: yoshiki0911@gmail.com
License: MIT
Description: # slack-api-decorator
        
        [![github-pytest](https://github.com/gsy0911/slack-api-decorator/workflows/pytest/badge.svg)](https://github.com/gsy0911/slack-api-decorator/actions?query=workflow%3Apytest)
        [![codecov](https://codecov.io/gh/gsy0911/slack-api-decorator/branch/master/graph/badge.svg)](https://codecov.io/gh/gsy0911/slack-api-decorator)
        [![PythonVersion](https://img.shields.io/badge/python-3.7|3.8-blue.svg)](https://www.python.org/downloads/release/python-377/)
        [![PiPY](https://img.shields.io/badge/pypi-0.1.2-blue.svg)](https://pypi.org/project/slackapidecorator/)
        
        Slack-API-decorator provides simple decorator to receive slack-payload: `Slash Command` and `Event Subscription`. 
        
        ## install
        
        ```bash
        $ pip install slackapidecorator
        ```
        
        ## usage
        
        ### Slash Command
        
        ```python
        from slack_api_decorator import SlashCommand 
        sc = SlashCommand(app_name="sample")
        
        @sc.add(command="/example")
        def accept_example(params):
            return params
        
        
        sc.execute(params={"payload from": "slack"})
        ```
        
        ### Event Subscription
        
        The events below are supported:
        
        * `file_upload`
        * `message`
        * `reaction_added`
        
        ```python
        from slack_api_decorator import EventSubscription
        
        event_subscription = EventSubscription(app_name="sample")
        
        @event_subscription.add(event_type="file_upload")
        def file_upload_example(params):
            return params
        
        @event_subscription.add("reaction_added", channel_id="Uxxxxxxxx")
        def reaction_added_in_channel(params):
            return params
        
        event_subscription.execute(params={"payload from": "slack"})
        ```
Keywords: slack,slack-api,slash-command,event-subscription
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
