120 lines
4.5 KiB
HTML
120 lines
4.5 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='utf-8'>
|
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
|
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<title>Steadymark by gabrielfalcao</title>
|
|
<script type="text/javascript">
|
|
|
|
var _gaq = _gaq || [];
|
|
_gaq.push(['_setAccount', 'UA-1277640-13']);
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
(function() {
|
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
|
})();
|
|
|
|
</script>
|
|
</head>
|
|
|
|
<body>
|
|
<div id="container">
|
|
<div class="inner">
|
|
|
|
<header>
|
|
<h1>Steadymark</h1>
|
|
<h2>use your python snippets from your README.md as regression tests</h2>
|
|
</header>
|
|
|
|
<section id="downloads" class="clearfix">
|
|
<a href="https://github.com/gabrielfalcao/steadymark/zipball/master" id="download-zip" class="button"><span>Download .zip</span></a>
|
|
<a href="https://github.com/gabrielfalcao/steadymark/tarball/master" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a>
|
|
<a href="https://github.com/gabrielfalcao/steadymark" id="view-on-github" class="button"><span>View on GitHub</span></a>
|
|
</section>
|
|
|
|
<hr>
|
|
|
|
<section id="main_content">
|
|
<h1>Steady Mark</h1>
|
|
|
|
<p>Turning your github readme files into python test suites since 2012</p>
|
|
|
|
<p>Steady Mark was created for python developers that love Github and
|
|
markdown.</p>
|
|
|
|
<h2>How it works:</h2>
|
|
|
|
<p>Write your documentation using <a href="http://github.github.com/github-flavored-markdown/">github-flavored markdown</a>, 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.</p>
|
|
|
|
<h1>Advantages:</h1>
|
|
|
|
<ul>
|
|
<li>Add test coverage to your app/library while documenting it</li>
|
|
<li>Never have old malfunctional examples on your project's main page in github</li>
|
|
<li>It uses <a href="http://misaka.61924.nl/">misaka</a> which is a python-binding of <a href="https://github.com/tanoku/sundown">sundown</a>, the markdown engine that github uses in itself</li>
|
|
</ul><h1>Start using steady mark now!</h1>
|
|
|
|
<p>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.</p>
|
|
|
|
<pre><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'
|
|
```
|
|
</code></pre>
|
|
|
|
<p>Just run with:</p>
|
|
|
|
<div class="highlight"><pre><span class="nv">$ </span>steadymark README.md
|
|
</pre></div>
|
|
|
|
<h1>Integrate with TravisCI!</h1>
|
|
|
|
<p>create a <code>.travis.yml</code> file in you repo with the contents:</p>
|
|
|
|
<div class="highlight"><pre><span class="l-Scalar-Plain">language</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">python</span>
|
|
<span class="l-Scalar-Plain">python</span><span class="p-Indicator">:</span>
|
|
<span class="p-Indicator">-</span> <span class="s">"2.6"</span>
|
|
<span class="p-Indicator">-</span> <span class="s">"2.7"</span>
|
|
<span class="c1"># command to install dependencies</span>
|
|
<span class="l-Scalar-Plain">install</span><span class="p-Indicator">:</span>
|
|
<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">pip install steadymark>=0.1.4</span>
|
|
<span class="c1"># command to run tests</span>
|
|
<span class="l-Scalar-Plain">script</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">steadymark README.md</span>
|
|
</pre></div>
|
|
</section>
|
|
|
|
<footer>
|
|
Steadymark is maintained by <a href="https://github.com/gabrielfalcao">gabrielfalcao</a><br>
|
|
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="http://twitter.com/jasonlong">Jason Long</a>.
|
|
</footer>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|