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

https://s3.amazonaws.com/slackest/index.html

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.2.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

slackest-0.13.2-py2.py3-none-any.whl (20.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file slackest-0.13.2.tar.gz.

File metadata

  • Download URL: slackest-0.13.2.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for slackest-0.13.2.tar.gz
Algorithm Hash digest
SHA256 47b8bdf4bee7f0a557257af280386115b872440817831743ad11e463826dc6dc
MD5 649c341362fd10d9410e8abec8c6315f
BLAKE2b-256 e0646d211f2ab9dd4d0b50aa2c0719fdc318266febd86f99beef8a8b4aceb3bf

See more details on using hashes here.

File details

Details for the file slackest-0.13.2-py2.py3-none-any.whl.

File metadata

  • Download URL: slackest-0.13.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for slackest-0.13.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f5af65f6f71b2445907ec2ff9c0bae85a532dad61a41e7b13c1df5ed4997713d
MD5 7b65f0bf4ef70d5d149f35e13c5efe37
BLAKE2b-256 b0f2b9e253d043602173af5144038ea2332c85e94eff6d45591f2cef098f0e9c

See more details on using hashes here.

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