slackminion package

Subpackages

• slackminion.plugin package
  • Submodules
  • slackminion.plugin.base module
  • slackminion.plugin.manager module
  • Module contents
• slackminion.plugins package
  • Subpackages
    • slackminion.plugins.core package
      • Submodules
      • slackminion.plugins.core.acl module
      • slackminion.plugins.core.core module
      • slackminion.plugins.core.user module
      • Module contents
    • slackminion.plugins.debug package
      • Module contents
    • slackminion.plugins.state package
      • Submodules
      • slackminion.plugins.state.file module
      • Module contents
  • Submodules
  • slackminion.plugins.test module
  • Module contents
• slackminion.slack package
  • Subpackages
    • slackminion.slack.room package
      • Submodules
      • slackminion.slack.room.attributes module
      • slackminion.slack.room.base module
      • slackminion.slack.room.im module
      • slackminion.slack.room.room module
      • Module contents
  • Submodules
  • slackminion.slack.connection module
  • slackminion.slack.event module
  • slackminion.slack.user module
  • Module contents
• slackminion.utils package
  • Subpackages
    • slackminion.utils.test_helpers package
      • Submodules
      • slackminion.utils.test_helpers.bot module
      • slackminion.utils.test_helpers.plugin module
      • slackminion.utils.test_helpers.slack module
      • Module contents
  • Module contents

Submodules

slackminion.bot module

class slackminion.bot.Bot(config, test_mode=False, dev_mode=False)

Bases: object

always_send_dm = []

api_client = None

at_user(user, channel_id, text, **kwargs)

Appends @user Slack formatting to the beginning of a message.

• user - The SlackUser to send to.
• channel_id - The channel ID of the channel to send to
• text - String to send
• kwargs - add’l keyword arguments to pass to send_message()

bot_start_time = None

channels

get_channel(channel_id)

get_channel_by_name(channel_name)

get_my_conversations(*args, **kwargs)

graceful_shutdown()

is_setup = False

my_userid

my_username

rtm_client = None

run()

Connects to slack and enters the main loop.

runnable = True

sc

send_im(user, text, parse=None)

Sends a message to a user as an IM

• user - The user to send to. This can be a SlackUser object, a user id, or the username (without the @)
• text - String to send

send_message(channel, text, thread=None, reply_broadcast=None, attachments=None, parse=None, link_names=1)

Sends a message to the specified channel

• channel - The channel to send to. This can be a SlackConversation object, a channel id, or a channel name

(without the #) * text - String to send * thread - reply to the thread. See https://api.slack.com/docs/message-threading#threads_party * reply_broadcast - Set to true to indicate your reply is germane to all members of a channel * parse - Set to “full” for the slack api to linkify names and channels

shutting_down = False

start()

Initializes the bot, plugins, and everything.

stop()

Does cleanup of bot and plugins.

timers = []

update_channels()

webserver = None

slackminion.dispatcher module

class slackminion.dispatcher.BaseCommand(method)

Bases: object

execute(*args, **kwargs)

formatted_help

short_help

class slackminion.dispatcher.MessageDispatcher

Bases: object

ignore(channel)

push(event, dev_mode=False)

Takes a SlackEvent, parses it for a command, and runs against registered plugin

register_plugin(plugin)

Registers a plugin and commands with the dispatcher for push()

unignore(channel)

class slackminion.dispatcher.PluginCommand(method)

Bases: slackminion.dispatcher.BaseCommand

class slackminion.dispatcher.WebhookCommand(method, form_params)

Bases: slackminion.dispatcher.BaseCommand

execute()

slackminion.exceptions module

exception slackminion.exceptions.DuplicateCommandError(name)

Bases: Exception

exception slackminion.exceptions.DuplicatePluginError(name)

Bases: Exception

exception slackminion.exceptions.NotSetupError

Bases: Exception

slackminion.webserver module

class slackminion.webserver.Webserver(host, port)

Bases: object

start()

stop()

Module contents