<commit_before>===========================================================
challongebot - an IRC tournament bot for Challonge brackets
===========================================================


Requirements
============

* `pychallonge <http://github.com/russ-/pychallonge>`_
* `willie <http://willie.dftba.net/>`_
* A Challonge API key

Note that depending on ``willie`` requires Python 2.7 or higher to be used, as well. ``pychallonge`` also requires `dateutil <http://labix.org/python-dateutil>`_ be installed, as well.


Installation
============

``challongebot`` is a ``willie`` module, so copy it to your ``willie`` module directory, which will typically be located in ``C:\Python27\Libs\site-packages\willie\modules`` on Windows, or ``/usr/local/lib/python2.7/dist-packages/willie/`` on Linux. See the willie documentation for more info on how to install modules like challongebot.

Be sure to modify the ``CHALLONGE_USERNAME``, ``TOURNAMENT_NAME``, and ``API_KEY`` variables in ``challongebot.py`` before installing it.


Running challongebot
====================

* Start up ``willie as per normal. See the ``willie`` documentation for more on this.
* Type ``.setup`` to initialize ``challongebot``.
* Use the ``.update`` command to have ``challongebot`` update the brackets.


Commands
========

**.setup**

Initializes ``challongebot``. The command must be issued by the ``willie`` instance's owner to work.

**.pending**

Lists all matches which are waiting for results.

**.update MATCH_CODE PLAYER1_SCORE PLAYER2_SCORE**

Updates the results of an individual match. ``MATCH_CODE`` is the name of the match on Challonge, and PLAYER1_SCORE and PLAYER2_SCORE represent the scores of the two players - ``challongebot`` automatically detects the match winner based on these scores.
<commit_msg>Accidentally forgot to commit the README changes<commit_after>===========================================================
challongebot - an IRC tournament bot for Challonge brackets
===========================================================


Requirements
============

* `pychallonge <http://github.com/russ-/pychallonge>`_
* `willie <http://willie.dftba.net/>`_
* A Challonge API key

Note that depending on ``willie`` requires Python 2.7 or higher. ``pychallonge`` also requires `dateutil <http://labix.org/python-dateutil>`_ be installed, as well.


Installation
============

``challongebot`` is a ``willie`` module, so copy it to your ``willie`` module directory, which will typically be located in ``C:\Python27\Libs\site-packages\willie\modules`` on Windows, or ``/usr/local/lib/python2.7/dist-packages/willie/`` on Linux. See the willie documentation for more info on how to install modules like challongebot.

Be sure to modify the ``CHALLONGE_USERNAME``, ``TOURNAMENT_NAME``, and ``API_KEY`` variables in ``challongebot.py`` before installing it.


Running challongebot
====================

* Start up ``willie`` as per normal. See the ``willie`` documentation for more on this.
* Type ``.setup`` to initialize ``challongebot``.
* Use the ``.update`` command to have ``challongebot`` update the brackets.


Commands
========

**.setup**

Initializes ``challongebot``. The command must be issued by the ``willie`` instance's owner to work.

**.pending**

Lists all matches which are waiting for results.

**.update MATCH_CODE PLAYER1_SCORE PLAYER2_SCORE**

Updates the results of an individual match. ``MATCH_CODE`` is the name of the match on Challonge, and PLAYER1_SCORE and PLAYER2_SCORE represent the scores of the two players - ``challongebot`` automatically detects the match winner based on these scores.

{'fraction_non_alphanumeric': 0.19416138804736988, 'fraction_numerical': 0.00550812448361333, 'mean_word_length': 5.439716312056738, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '40143', 'n_tokens_mistral': 1091, 'n_tokens_neox': 1007, 'n_words': 391}