Code Monkey home page Code Monkey logo

dissonance's Introduction

HEAVY IN WIP.

Dissonance

Dissonance is a simple, idiomatic python framework for building Discord bots of all shapes and sizes.

Status

In it's infancy

Installing Dissonance

You will need Python 2.7, 3.4 or 3.5 and setuptools. If you want, you can install Dissonance in a virtual environment.

Install dissonance (and his built in modules) with pip:

$ pip install dissonance dissonance-modules

This will install dissonance, and his dependencies. It will also give you the dissonance command which can be used to create an initial dissonance configuration, and run the bot. Let's create an instance of dissonance in the folder "mydissonance":

$ dissonance init mydissonance

If you want to use dissonance with heroku, or just have your Dissonance instance inside of a git repository, the newly created directory has everything you need: the configuration file, a few sample modules, a .gitignore file (so that you can safely add everything to git).

$ cd mydissonance
$ git init
$ git add .
$ git commit -m "Dissonance's initial commit."

Next, open up the config.py file and add your Discord credentials to dissonance_opts.

Now you can run Dissonance by simply calling:

$ dissonance run

License

The MIT License (MIT)

Copyright (c) 2016 Jake Heinz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dissonance's People

Contributors

jhgg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 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.