Skip to main content

Slack API client

Project description

build status pylint

About

Slackest is a full-featured Python interface for the Slack API.

Examples

from slackest import Slackest

slack = Slackest('<your-slack-api-token-goes-here>')

# Send a message to #general channel
slack.conversation.post_message('#general', 'Hello fellow slackers!')

# Get users list
response = slack.users.list()
users = response.body['members']

# Upload a file
slack.files.upload('hello.txt')

# If you need to proxy the requests
proxy_endpoint = 'http://myproxy:3128'
slack = Slackest('<your-slack-api-token-goes-here>',
                http_proxy=proxy_endpoint,
                https_proxy=proxy_endpoint)

# Advanced: Use `request.Session` for connection pooling (reuse)
from requests.sessions import Session
with Session() as session:
    slack = Slackest(token, session=session)
    slack.conversation.post_message('#general', 'All these requests')
    slack.conversation.post_message('#general', 'go through')
    slack.conversation.post_message('#general', 'a single https connection')

Installation

$ pip install slackest

CICD

This project uses AWS CodeBuild to build. CodeBuild uses a YAML-based file called builspec.yml that runs the appropriate commands.

A wheel and a source distribution is provided according to the buildspec.

Building Locally

For local build testing, use the local CodeBuild image. See this AWS blog post <https://aws.amazon.com/blogs/devops/announcing-local-build-support-for-aws-codebuild/> for more details.

$ git clone https://github.com/aws/aws-codebuild-docker-images.git
$ cd aws-codebuild-docker-images/ubuntu/python/3.7.1
$ docker build -t aws/codebuild/python:3.7.1 .
$ docker pull amazon/aws-codebuild-local:latest --disable-content-trust=false
$ wget https://raw.githubusercontent.com/aws/aws-codebuild-docker-images/master/local_builds/codebuild_build.sh && chmod +x codebuild_build.sh
$ ./codebuild_build.sh -i aws/codebuild/python:3.7.1 -a /tmp/codebuild/

Documentation

Slack API

https://api.slack.com/methods

Slackest

Coming soon!

TODO

  • Test completion, full coverage

  • Documentation on RTD

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

slackest-0.13.1.tar.gz (14.3 kB view hashes)

Uploaded Source

Built Distribution

slackest-0.13.1-py2.py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 2 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