README.rst

README for Alice

Alice is a bot specialised to do codebase supervising on your behalf to prevent chaos situation in any layer of SDLC cycle.

Install

Installing is simple via pip

pip install alice-core

How to use

1. Create your team specific input config file setup your config file
2. Start Alice (any 1 way):

modify the commands for particular config.yaml or config.json file path & port number

• run as flask app

  export FLASK_APP=alice config='config.yaml'; flask run --host 0.0.0.0 --port 5005

or

• run as uwsgi process (Install uwsgi>=2.0.14 on your machine for using this)

  export config="config.yaml"; uwsgi --socket 0.0.0.0:5005 --protocol=http -w alice --callable app

Note: default port number is '5000' if not specified

more details

3. Create web-hook in github set it to <IP_WHERE_ALICE_IS_LISTNING>:<PORT_NUMBER>/alice Example:

Wh questions

why, what & how about Alice

Who can use alice on the fly

Github & Slack users If you are using other projects, look at "how to contribute" section

Willing to contribute

Contributing guidelines

Bugs/Requests

Please use the GitHub issue tracker to submit bugs or request features.

Changelog

Consult the Changelog page for fixes and enhancements of each version.