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.chat.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.chat.post_message('#general', 'All these requests')
    slack.chat.post_message('#general', 'go through')
    slack.chat.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 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

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

Uploaded Source

Built Distribution

slackest-0.15.0-py2.py3-none-any.whl (39.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: slackest-0.15.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.7.0 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.3

File hashes

Hashes for slackest-0.15.0.tar.gz
Algorithm Hash digest
SHA256 4d8d1a45731ce9ec6652be1064347106ededfde353d400826ad49659a4f147d8
MD5 a9922fcc5fcb36d13c66a86e27bc1f7a
BLAKE2b-256 d8fec6baaf0a7df27204a3255370370ddb5c76cb483d915e8cd1f8edba72b2d7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: slackest-0.15.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 39.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.7.0 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.3

File hashes

Hashes for slackest-0.15.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 412b8041acd810bc3bf6027c0b1e90d9cba848c3d10f313e21c0e05c19779ef5
MD5 90243d8bdb8521bb037c6d034b4ab890
BLAKE2b-256 b192d75c3b52f62bd605bb35fa68c8122769a4611afa8075362664322db5e054

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