Skip to main content

/əˈslæk/

PyPI Version Travis Build Status Code Coverage Code Issues ISC License

aSlack is a lightweight, asynchronous wrapper for Slack’s Web and Real-Time Messaging (RTM) APIs, designed to allow the easy development of Slack tools and bots in Python. It defines two principal components:

  • SlackApi - a wrapper around the Web API; and

  • SlackBot - a messaging bot built on top of the RTM API.

Compatibility

aSlack uses asyncio with the async and await syntax, so is only compatible with Python versions 3.5 and above.

Dependencies

Asynchronous HTTP and WebSocket functionality is provided by aiohttp (version 0.15 and above required for out-of-the-box WebSocket client support).

Documentation

aSlack’s documentation is available on PythonHosted.

Installation

aSlack is available through the Python Package Index, PyPI, you can install it with:

pip install aslack

Alternatively, clone or fork the repository and use e.g.:

python setup.py develop

to install locally for development. In this case, you should also install the development dependencies (ideally in a virtualenv) using:

pip install -r requirements.txt

Testing

The test suite can be run using py.test directly or by running:

python setup.py test

in which case pylint will also be run to check the code quality.

Additionally, a demo test for the Halliwell example can be run by setting the environment variable TMDB_API_TOKEN.

Examples

See the /examples directory for examples of the kinds of bots that you can build with aSlack.

Halliwell

Based on both aSlack and aTMDb, Halliwell is a bot that can provide information on movies or actors and find overlaps. Two environment variables, SLACK_API_TOKEN and TMDB_API_TOKEN, are required to run this example, and configuration for easy deployment to Cloud Foundry is provided.

Release files for aslack 0.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aslack 0.11.0
File Size Uploaded
aslack-0.11.0.tar.gz 10.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aslack 0.11.0
File Interpreter ABI Platform
aslack-0.11.0-py3-none-any.whl Python 3 none any Details

Total release size: 25.5 kB

Release files / aslack-0.11.0.tar.gz

Download URL aslack-0.11.0.tar.gz
Size 10.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f8f1de907fb212c6ec5d37dcc3aa5ccade904ecc8fe01c5ba9c20f8ce758282e
BLAKE2b-256 checksum
How to use checksums
8710656d91ba5cccf5775edce5d61ef2a7559f0e453861c3e1476caa1b7bc52e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / aslack-0.11.0-py3-none-any.whl

Download URL aslack-0.11.0-py3-none-any.whl
Size 14.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
722f75e84ca3deb03554712054d956e5a5303734360d84117af34054a5e9962a
BLAKE2b-256 checksum
How to use checksums
c429fdf2a6011b1e75bdc53f06215203e281f8be4c875fc323a5348213bdf80f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.11.0 This release

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.2.0

2 release files

0.1.0

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

1 release file

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page