SparkBot

SparkBot makes it easy to create your own chatbot for Cisco Spark.

It provides a low barrier to entry:

1. Install the package: pip install git+https://github.com/universalsuperbox/SparkBot.git
2. Use run.py.example to make a script that adds your commands and runs the bot.
3. Set up a reverse proxy that provides HTTPS (nginx and Let's Encrypt make it easy)
4. Start run.py

For more information, see the documentation.

Features

• Some Assembly Required: SparkBot doesn't handle HTTPS or proxying. Use what you want for that.
• Complete Flexibility: You can do whatever you want in your commands as long as you return a string as a reply to the user.

Warning

SparkBot currently does not provide a stable API. The way to run and develop SparkBot may change before it reaches a 1.0.0 release. The interface for writing commands is expected to be stable, but that is not guaranteed. See the SparkBot 1.0.0 milestone for the features and bugs that must be resolved before that release.

Build the documentation

To build the documentation, cd into the doc folder and run the following:

pip install -r requirements-dev.txt
make html

If you are on Windows, use make.bat rather than make.

The documentation will be located in the doc/_build/ directory.

Contribute

To develop on SparkBot, you can do the following:

pip install -r requirements-dev.txt
pip install -e .

When you're ready to commit, run the bot's tests first. You will need a copy of nodejs installed, then run the following:

pytest

Support

If you experience issues with SparkBot, please visit the issue tracker.

License

SparkBot is copyright Dalton Durst, 2018. It is licensed under the Apache license, version 2.0. See the LICENSE file for more details.