Skip to main content

Structured Slack bot framework.

Project description

# Slaccato

> Structured Slack bot framework

## Installation

```shell
$ pip install slaccato
```

## Example

### General Usage

```python
import slaccato

# Write a new method
class TestMethod(slaccato.SlackMethod):
@property
def execution_words(self):
return ['테스트', 'test', 'ping']

@property
def help_text(self):
return '*{}*: You can test me!'.format('/'.join(self.execution_words))

def response(self, channel, user_command, request_user):
response = 'Oh, {}! here I am!!!'.format(request_user)
return channel, response

slack_bot = slaccato.SlackBot(
slack_bot_token='SLACK_BOT_TOKEN',
slack_bot_name='SLACK_BOT_NAME',
std_out_path='/path/to/MY_LOG_FILE.log',
std_err_path='/path/to/MY_ERR_FILE.log')

slack_bot.add_method(TestMethod)
slack_bot.run()
```

![Test screenshot](./screenshots/screenshot-1.png)

### Message Customization

Please see [Slack API documentations](https://slack.dev/python-slackclient/basic_usage.html#customizing-a-message-s-layout)

```python
import slaccato

# Write a new method
class TestMethod(slaccato.SlackMethod):
@property
def execution_words(self):
return ['테스트', 'test', 'ping']

@property
def help_text(self):
return '*{}*: You can test me!'.format('/'.join(self.execution_words))

def response(self, channel, user_command, request_user):
response = [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "Danny Torrence left the following review for your property:"
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "<https://example.com|Overlook Hotel> \n :star: \n Doors had too many axe holes, guest in room " +
"237 was far too rowdy, whole place felt stuck in the 1920s."
},
"accessory": {
"type": "image",
"image_url": "https://images.pexels.com/photos/750319/pexels-photo-750319.jpeg",
"alt_text": "Haunted hotel image"
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Average Rating*\n1.0"
}
]
}
]
return channel, response
```

![Test screenshot](./screenshots/screenshot-2.png)


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for slaccato, version 0.1.8
Filename, size File type Python version Upload date Hashes
Filename, size slaccato-0.1.8-py2-none-any.whl (6.6 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size slaccato-0.1.8-py3-none-any.whl (6.6 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page