Skip to main content

Charlesbot Broadcast Message Plugin

Project description

===============================
Charlesbot Broadcast Message Plugin
===============================

.. image:: https://img.shields.io/travis/marvinpinto/charlesbot-broadcast-message/master.svg?style=flat-square
:target: https://travis-ci.org/marvinpinto/charlesbot-broadcast-message
:alt: Travis CI
.. image:: https://img.shields.io/coveralls/marvinpinto/charlesbot-broadcast-message/master.svg?style=flat-square
:target: https://coveralls.io/github/marvinpinto/charlesbot-broadcast-message?branch=master
:alt: Code Coverage
.. image:: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
:target: LICENSE.txt
:alt: Software License

A Charlesbot__ plugin that sends out a nifty broadcast message!

__ https://github.com/marvinpinto/charlesbot


How does this work
------------------

This plugin adds the following ``!help`` target:

.. code:: text

!wall <msg> - Broadcast a message to all channels I'm a part of

Whenever a person issues a ``!wall`` command, this plugin will broadcast that
message to all the channels that Charlesbot is currently in.

.. image:: https://raw.githubusercontent.com/marvinpinto/charlesbot-broadcast-message/master/images/wall.png


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

.. code:: bash

pip install charlesbot-broadcast-message

Instructions for how to run Charlesbot are over at https://github.com/marvinpinto/charlesbot!


Configuration
-------------

In your Charlesbot ``config.yaml``, enable this plugin by adding the following
entry to the ``main`` section:

.. code:: yaml

main:
enabled_plugins:
- 'charlesbot_broadcast_message.broadcastmessage.BroadcastMessage'

Sample config file
~~~~~~~~~~~~~~~~~~

.. code:: yaml

main:
slackbot_token: 'xoxb-1234'
enabled_plugins:
- 'charlesbot_broadcast_message.broadcastmessage.BroadcastMessage'


License
-------
See the LICENSE.txt__ file for license rights and limitations (MIT).

__ ./LICENSE.txt

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for charlesbot-broadcast-message, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size charlesbot-broadcast-message-0.2.0.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page