Skip to main content

A small library to simplify slack web API calls

Project description

Introduction

NOTE: This is an alpha version. Expect bugs and expect everything to change.

slackutils is a small library for simplifying some tasks with the Slack Web API. It is an extension of slackclient, and mostly contains methods for looking up users or channels by other parameters than their ID.

Installation

Recommended method is to install using pip. Note that we're still in alpha:

pip install --upgrade slackutils

Usage

Authenication

You need a slack token to use this library. slackutils looks for the token using one of two alternatives:

  1. All methods support a named parameter SLACK_API_TOKEN which is used to authenticate.
  2. If no named parameter is found, slackutils will look for the environment variable SLACK_API_TOKEN.

If neither of the above variables exist, an error will be raised.

Examples

Simplify looking up users and channels by other parameters than their ID

import slackutils
marketing_channel = slackutils.conversations.get(name='marketing')

from slackutils import get_user
dave = get_user(email='dave@example.com')

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

slackutils-0.0.4.tar.gz (2.6 kB view hashes)

Uploaded Source

Built Distribution

slackutils-0.0.4-py3-none-any.whl (4.3 kB view hashes)

Uploaded Python 3

Supported by

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