steadymark Markdown-based test runner for Python
Download

steadymark Ranking & Summary

steadymark Tags

Python library Python runner test test runner

steadymark Description

steadymark is a Python module that turns your github readme files into Python test suites.How it works:Write your documentation using github-flavored markdown, surround your snippets with python code blocks and steadymark will automatically find and run them, if there is a header preceeding your python snippet it will be used as title for your test.Advantages:- Add test coverage to your app/library while documenting it- Never have old malfunctional examples on your project's main page in github- It uses misaka which is a python-binding of sundown, the markdown engine that github uses in itselfExampleunicode.lower transforms string into lowercaseassert u"FOOBAR".lower() == "foobar"Python can add numbersassert (2 + 2) == 4, 'oops baby'Start using steady mark now!This is the code for the example above, copy and paste in you python project right now and start keeping your documentation up-to-date with the code.# My project name`version 0.1`## unicode.lower transforms string into lowercase```pythonassert u"FOOBAR".lower() == "foobar"```## python can add numbers```pythonassert (2 + 2) == 5, 'oops baby'```Just run with: steadymark README.mdSteadymark tests itself :+1:from steadymark import versionassert version == '0.1.3'Product's homepage

steadymark Related Software