<commit_before>Scoring System
==============


Modules
-------

services/ - contains the service verifiers
            To run the tests cd to the services dir and run `nosetests tests/`

targets/ - contains json descriptions of the services

<commit_msg>documentation for services<commit_after>Scoring System
==============


Modules
-------

services/ - contains the service verifiers
            To run the tests cd to the services dir and run `nosetests tests/`

targets/ - contains json descriptions of the services


Service Verifiers
-----------------

Service verifers are modules that represent a particular service on an
arbitrary host. Service modules know how to verify that their service is
running, and in most cases can determine the owner of the team/player.

Place service verifiers in the services/ directory. They should subclass the
Service type (see services/__init__.py). They should implement the
`verify_up()` and `owner` methods.

Service modules are passed a configuration dictionary that will consist of
the settings dict specified in the target's json file, as well as a 'host'
value indicating the host/ip of the target on which the service resides.

TODO: ssh keys for authentication?
{'fraction_non_alphanumeric': 0.08656224237427865, 'fraction_numerical': 0.0, 'mean_word_length': 3.669230769230769, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '1127076', 'n_tokens_mistral': 293, 'n_tokens_neox': 280, 'n_words': 160}