Skip to main content

A simple python wrapper for the slack API

Project description

slackbot

A simple python wrapper for the Slack api

Requirements

Installation

pip install simple-slackbot

Usage

Generate a slack api token

First you need to get the slack api token for your bot. You can create a bot on the slack website and manage permissions.

Instantiate a SlackBot

from slackbot import SlackBot

slackbot = SlackBot()

By default, the SlackBot retrieved the slack token from environment variable SLACK_API_TOKEN. You can overwrite the default behaviour by instantiating with the token argument.

If running it in a Jupyter notebook, instantiate with run_async=True.

Send a message

You can send messages to any channel (using the channel name or id), or any user (just set channel=@<username>) slackbot.send_message(channel='#general', message='Hello!')

Send a file

You can also send files over slack, to any channel or user.

slackbot.send_file(channel='#general', file='<filepath>', message='Check out this file!')

More using the slack api directly

You can access methods from the raw slack client to use them directly.

slackbot.client.chat_postMessage(...)

Project details


Release history Release notifications

Download files

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

Files for simple-slackbot, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size simple_slackbot-0.1.0-py3-none-any.whl (15.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size simple-slackbot-0.1.0.tar.gz (2.3 kB) File type Source Python version None 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