django-channels

django-channels

.. image:: https://badge.fury.io/py/django-channels.svg :target: https://pypi.python.org/pypi/django-channels/ :alt: PyPI version .. image:: https://travis-ci.org/ymyzk/django-channels.svg?branch=master :target: https://travis-ci.org/ymyzk/django-channels :alt: Build Status .. image:: https://readthedocs.org/projects/django-channels/badge/?version=latest :target: http://django-channels.readthedocs.org/ :alt: Documentation Status .. image:: https://codeclimate.com/github/ymyzk/django-channels/badges/gpa.svg :target: https://codeclimate.com/github/ymyzk/django-channels :alt: Code Climate .. image:: https://coveralls.io/repos/ymyzk/django-channels/badge.svg?branch=master :target: https://coveralls.io/r/ymyzk/django-channels?branch=master :alt: Coverage Status .. image:: https://requires.io/github/ymyzk/django-channels/requirements.svg?branch=master :target: https://requires.io/github/ymyzk/django-channels/requirements/?branch=master :alt: Requirements Status

django-channels is a Django library for sending notifications. HipChat, Slack, Twitter and Yo are supported for now.

Note: This should not be confused with the official Django Channels project which you can see at https://channels.readthedocs.io/.

At a Glance

After installation and configuration, you can send notifications to HipChat, Slack, Twitter, or Yo with a following simple code:

.. code-block:: python

import channels

channels.send("Sample notification.")

See Quickstart_ page for more details.

Requirements

Python ^^^^^^

• Python 2.7+
• Python 3.3+
• PyPy
• PyPy3

Django ^^^^^^

• Django 1.8
• Django 1.9
• Django 1.10

Installation

.. code-block:: shell

pip install django-channels

Note: Please use the latest version of setuptools & pip

.. code-block:: shell

pip install -U setuptools pip

Links

• Documentation_
• GitHub_

.. _Documentation: http://django-channels.readthedocs.org/ .. _GitHub: https://github.com/ymyzk/django-channels .. _Quickstart: http://django-channels.readthedocs.org/en/latest/quickstart.html