Skip to content

Latest commit

 

History

History
93 lines (65 loc) · 3.53 KB

README.rst

File metadata and controls

93 lines (65 loc) · 3.53 KB

python-slacktools

A toolbelt for working with the various Slack APIs in python.

Documentation Status Build Status Code Coverage PyPI - Version PyPI - Python Version

Install

Install slacktools with PyPI

pip install slacktools

This library is tested against Python 3.4+. Open an issue if you need this library to work on an older version.

Features

Check out the docs for more info and API documentation.

Tests

Running the tests is simple enough:

python setup.py test

Or just pytest will do the trick. This will run the tests in the tests/ directory as well as as bunch of docstring tests in the src/ directory.

The Makefile also has some good test commands that will spin up a docker container:

  • make test will run the tests in python 3.7.
  • make test-all will run a series of tests from python 3.7 down to 3.4.
  • make test-{{PY_VERSION}} where PY_VERSION can be any tagged version of the official python docker image will run tests under that python version. Ex: make test-3.5 will run under Python 3.5.

Roadmap

  • Wider python support? This lib only supports python 3 right now. However, if someone needs it, I can add python 2 compatibility.
  • Friendly message builder API?
  • Build deep links into clients

In the Wild

austinpray/kizuna is a silly chatbot that uses this library.