<commit_before># Checkers Test Framework

Checkers is a flexible test authoring framework for Python.

You may find Checkers useful if you want to do any of the following:

* Have more control over how tests are structured.
* Treat the components under test as external dependencies.
* Define tests as standalone functions rather than methods in test classes.
* Run data-driven (parameterized) tests.

Checkers is designed around the idea that tests are really composed of several
parts: test steps, test data, components under test, and test metadata. Checkers
allows the user to have control over all of these areas, so it is easy to
customize behavior. However, default behaviors are implemented so that writing
simple tests is still super simple.

## Requirements

Python 2.7

## Installation

TODO(barkimedes): Describe installation in more detail. This is just a general
recommendation for people who already know how to download code from GitHub.

* Download (or clone) the google/checkers repository.
* From the python folder, run `python setup.py install`
* ...
* ~~Profit!!~~ Test!!

## Quick Start

The following is a very simple Checkers test:

```python
import checkers
from checkers import asserts
from checkers.runners import pyunit

@checkers.test
def test_add_2_2_4():
  asserts.are_equal(2 + 2, 4)<commit_msg>Updated README to show build status.<commit_after># Checkers Test Framework

[![Build Status](https://api.travis-ci.org/google/checkers.png)](https://api.travis-ci.org/google/checkers)

Checkers is a flexible test authoring framework for Python.

You may find Checkers useful if you want to do any of the following:

* Have more control over how tests are structured.
* Treat the components under test as external dependencies.
* Define tests as standalone functions rather than methods in test classes.
* Run data-driven (parameterized) tests.

Checkers is designed around the idea that tests are really composed of several
parts: test steps, test data, components under test, and test metadata. Checkers
allows the user to have control over all of these areas, so it is easy to
customize behavior. However, default behaviors are implemented so that writing
simple tests is still super simple.


## Requirements

Python 2.7

## Installation

TODO(barkimedes): Describe installation in more detail. This is just a general
recommendation for people who already know how to download code from GitHub.

* Download (or clone) the google/checkers repository.
* From the python folder, run `python setup.py install`
* ...
* ~~Profit!!~~ Test!!

## Quick Start

The following is a very simple Checkers test:

```python
import checkers
from checkers import asserts
from checkers.runners import pyunit

@checkers.test
def test_add_2_2_4():
  asserts.are_equal(2 + 2, 4)
{'fraction_non_alphanumeric': 0.06422676713311805, 'fraction_numerical': 0.0057409400789379264, 'mean_word_length': 4.666666666666667, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '999522', 'n_tokens_mistral': 752, 'n_tokens_neox': 730, 'n_words': 376}