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


Download files

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

Source Distribution

simple-slackbot-0.1.0.tar.gz (2.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_slackbot-0.1.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file simple-slackbot-0.1.0.tar.gz.

File metadata

  • Download URL: simple-slackbot-0.1.0.tar.gz
  • Upload date:
  • Size: 2.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for simple-slackbot-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ee2b8acb2577e6bdacf3ae2cca488063d6f504e0ceff7cf5d89da2656a1d5b2a
MD5 7e5b19bea4cdc200f9061fe07d38303e
BLAKE2b-256 e22c9cc93185985c0faa6ceb690b987582a93f1fd4ccaa5e8528fb78f90cb1af

See more details on using hashes here.

File details

Details for the file simple_slackbot-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: simple_slackbot-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for simple_slackbot-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94b9bb1debd1350a1d0572c8268e7df810b55b9796eb956d1197a63a7f079134
MD5 c65b6f255f05994ca5ab42c0afa8d85d
BLAKE2b-256 57bdeb7ad11ae1108f6b37ba1c2d311f7ae04e079a8229d7b49a6b0295e66d7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page