Sparkbot
latest

Contents:

  • Quickstart
    • Get a token from Webex Teams
    • Dependencies
      • Ubuntu 16.04
    • Clone the source
    • Copy run.py.example
    • Set up a virtualenv
    • Use ngrok for a temporary reverse proxy
    • Run the bot
    • Next steps
  • Writing Commands
    • Introduction
    • Taking arguments
    • Replying early
    • Overriding behavior
      • “Help” command
        • Override
        • Remove
      • “Command not found”
    • List of recognized keywords
  • Deploy
    • Install required system packages
      • Ubuntu 16.04 / 18.04
    • Install Python packages in a virtualenv
    • Get your run.py script
    • Add nginx configuration
    • Auto-start with systemd
  • SparkBot API
    • Submodules
      • sparkbot.core module
      • sparkbot.receiver module
      • sparkbot.commandhelpers module
    • Module contents
Sparkbot
  • Docs »
  • Index
  • Edit on GitHub

Index

C | E | G | I | M | O | R | S

C

  • check_if_in_org() (in module sparkbot.commandhelpers)
  • check_if_in_team() (in module sparkbot.commandhelpers)
  • Command (class in sparkbot.core)
  • command() (sparkbot.core.SparkBot method)
  • commandworker() (sparkbot.core.SparkBot method)
  • create() (in module sparkbot.receiver)
  • create_callback() (sparkbot.core.Command class method)

E

  • execute() (sparkbot.core.Command method)

G

  • get_person_by_email() (in module sparkbot.commandhelpers)
  • get_person_by_spark_id() (in module sparkbot.commandhelpers)

I

  • is_group() (in module sparkbot.commandhelpers)

M

  • mention_person() (in module sparkbot.commandhelpers)
  • minargs() (in module sparkbot.commandhelpers)
  • my_help() (sparkbot.core.SparkBot method)
  • my_help_all() (sparkbot.core.SparkBot method)

O

  • on_post() (sparkbot.receiver.ReceiverResource method)

R

  • random_bytes() (in module sparkbot.receiver)
  • ReceiverResource (class in sparkbot.receiver)
  • remove_help() (sparkbot.core.SparkBot method)
  • respond() (sparkbot.core.SparkBot method)

S

  • SparkBot (class in sparkbot.core)
  • sparkbot (module)
  • sparkbot.commandhelpers (module)
  • sparkbot.receiver (module)

© Copyright 2018, Dalton Durst. Licensed under Creative Commons BY 4.0 (CC BY 4.0). Revision 2521ee49.

Built with Sphinx using a theme provided by Read the Docs.