Welcome to Maya documentation!¶
What is Maya ?¶
Maya is a simple moderation bot for discord. It is used for small and medium discord servers. The bot is running using Discord.JS.
Get the bot¶
The source is available on Github. The core bot is build arround GuideBot. With more commands and features. Such a warns, logs, channel lock. But the Maya BOT itself is private.
Contents¶
Informations¶
Welcome to the Info page of Maya
Note
Kong is available on Pypi as django-kong
, but trunk is probably your
best best for the most up to date features.
First, obtain Python and virtualenv if you do not already have them. Using a virtual environment will make the installation easier, and will help to avoid clutter in your system-wide libraries. You will also need Git in order to clone the repository.
Once you have these, create a virtual environment somewhere on your disk, then activate it:
virtualenv kong
cd kong
source bin/activate
Kong ships with an example project that should get you up and running quickly. To actually get kong running, do the following:
git clone http://github.com/ericholscher/django-kong.git
cd django-kong
pip install -r requirements.txt
pip install . #Install Kong
cd example_project
./manage.py syncdb --noinput
./manage.py loaddata test_data
./manage.py runserver
This will give you a locally running instance with a couple of example sites and an example test.
Now that you have your tests in your database, you need to check that your tests run. You can run tests like:
#Check all sites
./manage.py check_sites
#Only run the front page test
./manage.py check_sites -t front-page
#Only check sites of type Mine
./manage.py check_sites -T mine
The first command is the default way of running kong, and will run the tests for all of your sites.
The second two different ways will run either a specific test, or a type of test. Both of these can run tests across multiple sites.
Commands¶
You can check all avaible commands of the bot. Some commands migh be reserved to moderators, admin or the Bot Onwer.
check_sites¶
By default, this runs tests for all your sites
This is the main command that is used to run kong tests. By default, it does nothing, but you can pass in arguments to it, to make it do what you want.
Arguments¶
-t, –test <test_slug>¶
Run the tests for a specific Test
. This might be run across multiple ``Site``s or ``Type``s, whatever the test defines.
-s, –site <site_slug>¶
Run all of the tests for a specific site. This will run the tests that explicitly point at the Site
, as well as the tests for the Type
that the site is.
-T, –type <type_slug>¶
Run the tests for a specific Type
. This will run the tests for all sites for that Type
.