Skip to content

andrgorr/nimbus

 
 

Repository files navigation

Nimbus

Little Slack bot for Overcast Network's slack channel

Running

  1. git clone https://github.com/bcbwilla/nimbus
  2. cd nimbus/
  3. pip install -r requirements.txt (preferably in a virtual environment)
  4. Put your authentication token in the config file (an example config is example_config.yaml)
  5. python nimbus.py config.yaml

Contributing

  • Feel free to add functionality that you think would be useful!
  • Follow PEP8 style guidelines (most importantly, underscore_names for things that aren't classes)

Plugins & Commands

  • To add a new plugin, create a new python module in /plugins/ and include a top level class that extends either Plugin or CommandPlugin. The bot will automatically load the plugin when it starts up
  • Read the documentation in Plugin.py to learn about the structure of Nimbus plugins
  • Echo.py is a simple example plugin

Suggestions & Bugs

  • Create an issue on Github

License

MIT License

About

Little Slack bot for Overcast Network's slack channel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%