<commit_before>SimpleMMO
=========

[![Build Status](https://secure.travis-ci.org/cnelsonsic/SimpleMMO.png?branch=master)](http://travis-ci.org/cnelsonsic/SimpleMMO)

Quick Installation
------------------
You will need pip to install the requirements, you can do something like:

    sudo apt-get install python-setuptools python-dev build-essential
or

    sudo yum install python-setuptools python-devel gcc

followed by

    sudo easy_install -U pip

You'll need to use pip to install the required python packages:

    sudo pip install -r requirements.txt

SimpleMMO uses supervisor to control its server processes, so you will need to
start them by running `supervisord` while in the SimpleMMO checkout directory.
You can use `supervisorctl` to check up on the server processes.

Alternately, you can deploy without supervisord (not recommended) and manage
processes yourself.

Finally, you can start up the administrative client with

    python qtclient.py


Servers
-------<commit_msg>Update the readme to include notes about vagrant.<commit_after>SimpleMMO
=========

[![Build Status](https://secure.travis-ci.org/cnelsonsic/SimpleMMO.png?branch=master)](http://travis-ci.org/cnelsonsic/SimpleMMO)

Quick Installation
------------------
### Virtualbox/Vagrant Server Appliance
SimpleMMO ships with a virtualbox/vagrant appliance which you can spin up
for testing or development.
It provides a linux environment, and all the dependencies pre-configured for you.

#### Installing
You need [VirtualBox](https://www.virtualbox.org/) and [Vagrant](http://vagrantup.com/).

#### Running
When in the ``vagrant`` directory of the SimpleMMO checkout, run ``vagrant up``.
In 5-10 minutes, you should have a shiny new development/testing server.
You can access it via ``vagrant ssh``, which gives you a terminal inside your vagrant box.
Discussions on using vagrant are beyond the scope of this README, so ``vagrant -h`` is your friend.

#### Client
From inside the vagrant box (via ``vagrant ssh``), you can start up the command-line client with:

    ./client.py

The following commands are supported:

    register: Register a username and password combination.
    login: Log in as a user.
    update: Update the objects from the zone server.
    map: Show a map of the zone.
    detail: Show details about a given object by name or id.


### Native Server Install
You will need pip to install the requirements, you can do something like:

    sudo apt-get install python-pip
or

    sudo yum install python-pip

You'll need to use pip to install the required python packages:

    sudo pip install -r requirements.txt

SimpleMMO uses supervisor to control its server processes, so you will need to
start them by running `supervisord` while in the SimpleMMO checkout directory.
You can use `supervisorctl` to check up on the server processes.


Servers
-------
{'fraction_non_alphanumeric': 0.09259259259259259, 'fraction_numerical': 0.0010482180293501049, 'mean_word_length': 3.9108061749571186, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '34836', 'n_tokens_mistral': 813, 'n_tokens_neox': 771, 'n_words': 356}