Steady Mark was created for python developers that love Github and markdown.
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.
- 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 itself
from sure import expect assert expect(u"Gabriel Falcao".lower()).equals(u"gabriel falcao")
assert (2 + 2) == 4, 'oops baby'
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 ```python assert "LOWERCaSe".lower() == "lowercase" ``` ## python can add numbers ```python assert (2 + 2) == 5, 'oops baby' ```
Just run with:
$ steadymark README.md
>>> from sure import expect >>> from steadymark import version >>> assert expect(version).should.equal("0.5.4")