Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

use your python snippets from your README.md as regression tests

branch: master
README.md

Steady Mark

version 0.5.4 Build Status instanc.es Badge meme

Turning your github readme files into python test suites since 2012

Steady Mark was created for python developers that love Github and markdown.

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 itself

Example

unicode.lower transforms string into lowercase

from sure import expect
assert expect(u"Gabriel Falcao".lower()).equals(u"gabriel falcao")

python can add numbers

assert (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

```python
assert "LOWERCaSe".lower() == "lowercase"
```

## python can add numbers

```python
assert (2 + 2) == 5, 'oops baby'
```

Just run with:

$ steadymark README.md

loading a python file before running tests

you can tell steadymark to load a "boot" file before running the tests, it's very useful for hooking up sure or HTTPretty

Steadymark is on version 0.5.4

>>> from sure import expect
>>> from steadymark import version
>>> assert expect(version).should.equal("0.5.4")
Something went wrong with that request. Please try again.