Go to file
Gabriel Falcao 7ccfa1c1dd first commit
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00
2012-07-30 12:16:05 -04:00

Steady Mark

Build Status

Markdown files + python snippets = regression tests

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.

Example

Given the following README.md:

# My project name
`version 0.1`

## usage

```python
from mylibrary import whatever

whatever.awesome()
```

Just run with:

$ steadymark README.md
Description
RETIRED, further work has moved to Debian project infrastructure
Readme 176 KiB
Languages
Python 98.3%
Makefile 1.7%