Code Monkey home page Code Monkey logo

nimbus's Introduction

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

nimbus's People

Contributors

plastix avatar bcbwilla avatar itsmartin avatar martinlbrook avatar brottweiler avatar electroid avatar andrgorr avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.