<commit_before>Test Steps functions for each assertion and automatic logging
===============================================================

.. image:: https://pypip.in/v/test_steps/badge.png
    :target: https://crate.io/packages/test_steps/

.. image:: https://pypip.in/d/test_steps/badge.png
    :target: https://crate.io/packages/test_steps/

The package test_steps is to implement a bunch of functions about test checks and logging.
The purpose is to simplify the assertion and automatically logging the checks,
which are not supported in most of the current python test frames.

All the checks and logging functions can be used independently, or be used in test frameworks
as py.test or nose


Install test_steps
------------------

::

    pip install test_steps


Lessons with examples
---------------------

lesson 1 - the basic auto-log boolean functions:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson1_autolog.py

lesson 2 - the check function with auto-log string:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson2_check.py

lesson 3 - the check functions with options:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson3_options.py

lesson 4 - the checks functions - another format for multiple check(s):
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson4_checks.py

lesson 5 - get return from check and checks function:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson5_return.py<commit_msg>README change: added the source code magic expanation.<commit_after>Test Steps functions for each assertion and automatic logging
=============================================================

The package test_steps is to implement a bunch of functions about test checks and logging.
The purpose is to simplify the assertion and automatically logging the checks,
which are not supported in most of the current python test frames.

All the checks and logging functions can be used independently, or be used in test frameworks
as py.test or nose


Magics in source code
---------------------

To make is extensible and more flexible, meta-programming and functional programming technologies
are used in this package. It makes the source is thus likely not something for Python beginners.
However, you are welcome if you want to study meta-programming or functional programming, and
your comments are always appreciated


Install test_steps
------------------

::

    pip install test_steps


Lessons with examples
---------------------

lesson 1 - the basic auto-log boolean functions:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson1_autolog.py

lesson 2 - the check function with auto-log string:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson2_check.py

lesson 3 - the check functions with options:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson3_options.py

lesson 4 - the checks functions - another format for multiple check(s):
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson4_checks.py

lesson 5 - get return from check and checks function:
https://github.com/steven004/TestSteps/blob/master/test_examples/test_lesson5_return.py
{'fraction_non_alphanumeric': 0.13159490600363857, 'fraction_numerical': 0.015160703456640388, 'mean_word_length': 4.187106918238993, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, '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': '4382764', 'n_tokens_mistral': 940, 'n_tokens_neox': 875, 'n_words': 310}