This is a Slack bot for the Wright State University Cybersecurity Club.
It is highly recommended to have a virtual environment set up with virtualenv. If you don't have virtualenv installed, you can get it using pip by running
pip install virtualenv
You can then set up a Python virtual environment with
virtualenv env
source env/bin/activate
or
virtualenv env
env/Scripts/activate
depending on your platform.
If you are running Arch (will probably work on other Linux platforms, too), you
can use the commands virtualenv2
and virtualenv3
to specify the version of
Python that you want to use in the virtual environment. Officially, this project
uses Python 2, so while it may work in Python 3, please use Python 2 for
development or check that you are using Python 2 before reporting that the bot
is not working.
After setting up the virtual environment, run pip install -r requirements.txt
.
Make sure to copy secrets.yml.sample
to secrets.yml
and get a testing API
key from here. You'll want to
put that key into the appropriate place in secrets.yml
. The bot won't really
work all that well without a Slack API key.
After all that, you can just run python2 run.py
, python3 run.py
, or
python run.py
to start the bot.
Please try to write code to remain compatible with Python 3 as best you can.
Make sure to add
from __future__ import unicode_literals
to all files and use parentheses around calls to the print
function.
Officially, this is based on Python 2, but if compatibility is possible, it should be embraced.
In commit messages, try to succinctly describe what the commit is doing in the
present tense. For example,
Implement <feature>
is better than
Implemented <feature>
or
Wrote code to implement <feature>
.
If you want to be added to this repository as an editor, please mention @zedx in #programming on Slack or direct message him.