Metadata-Version: 2.1
Name: sentry-telegram
Version: 0.3.0
Summary: Plugin for Sentry which allows sending notification via Telegram messenger.
Home-page: https://github.com/butorov/sentry-telegram
Author: Viacheslav Butorov
Author-email: butorovv@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Bug Tracking
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: System :: Monitoring
Description-Content-Type: text/x-rst

Sentry Telegram |travis| |codecov| |pypi|
=========================================

Plugin for Sentry which allows sending notification via `Telegram <https://telegram.org/>`_ messenger.

Presented plugin tested with Sentry from 8.9 to 9.1.

    **DISCLAIMER**: Sentry API is under development and `is not frozen <https://docs.sentry.io/server/plugins/>`_.


How will it look like
---------------------

.. image:: https://raw.githubusercontent.com/butorov/sentry-telegram/master/docs/images/telegram-window.png
   :target: https://github.com/butorov/sentry-telegram/blob/master/docs/images/telegram-window.png
   :alt: How will it look like

Installation
------------

1. Install this package

.. code-block:: bash

    pip install sentry-telegram

2. Add plugin to ``INSTALLED_APPS`` of Sentry, into ``sentry.conf.py`` file. It's usually in the directory like ``/var/www/sentry/``.
   For this purpose just add the following line into the file:

.. code-block:: python

    INSTALLED_APPS += ('sentry_telegram',)

3. Restart your Sentry instance.
4. Go to your Sentry web interface. Open ``Settings`` page of one of your projects.
5. On ``Integrations`` page find ``Telegram Notifications`` plugin and enable it.
6. Configure plugin on ``Configure plugin`` page.

   See `Telegram's documentation <https://core.telegram.org/bots#3-how-do-i-create-a-bot>`_ to know how to create ``BotAPI Token``.

7. Done!

.. |travis| image:: https://travis-ci.org/butorov/sentry-telegram.svg?branch=master
   :target: https://travis-ci.org/butorov/sentry-telegram
   :alt: Build Status

.. |codecov| image:: https://codecov.io/gh/butorov/sentry-telegram/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/butorov/sentry-telegram?branch=master
   :alt: Coverage Status

.. |pypi| image:: https://badge.fury.io/py/sentry-telegram.svg
   :target: https://pypi.python.org/pypi/sentry-telegram


