|
Project Information
Featured
|
Programming is more fun when you can keep score! PyRate automates the process of:
It generates a simple "scorecard.txt" text file (UTF-8 encoding), which displays in tabular form, the progress and quality of the programming project. There are just two files: "pyrate.py" and "pyrate.xml". Both should be placed in the source directory of your project. Paths are configurable in "pyrate.xml", but they default to checking the current directory for source modules and a subdirectory called "test" for unit tests. Assuming that each module has a corresponding unit test "test/test_*.py" (based on unittest) or "test/test_*.txt" based on doctest, these will be found and loaded. The modules themselves will also be searched for doctest examples in doc strings. All will be converted to PyUnit/unittest test suites and run. Rather than the usual anticlimactic report from unittest, however, PyRate will produce a friendlier score card which tells you how many tests succeeded (instead of how many failed) as a fraction of the total tests. It will also report subjective notations you can place in the module or test files as well as the overall score for each module reported by PyLint. A detailed explanation of its use is available from my Free Software Magazine article |