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()
```

### 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
```

> 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()
```

### 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
```

Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distributions
File details
Details for the file slaccato-0.1.8-py3-none-any.whl
.
File metadata
- Download URL: slaccato-0.1.8-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
1c3164bec7b6f6721af446ed7f9800fcdc8cce70483d17bbf89b16da61b38a33
|
|
MD5 |
2181a32295f20d28d5ffd79a5fcd350d
|
|
BLAKE2b-256 |
4f107428ebf22a5d4c7ae6b5a368950bd6ab40ee7616843915ea4c3820c664eb
|
File details
Details for the file slaccato-0.1.8-py2-none-any.whl
.
File metadata
- Download URL: slaccato-0.1.8-py2-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
cbf64a6933a663ee0408f9dc5f35b1f1fed9bbe63fddae70331c6a58d8b43236
|
|
MD5 |
eced05034ffe65ceb41d187c9fbf06e5
|
|
BLAKE2b-256 |
4ae034d897f4ec91565f71146ba7957e49495a66f1e0157b8d25dab18215b7bb
|