1 line
1.9 KiB
JSON
1 line
1.9 KiB
JSON
{"tagline":"use your python snippets from your README.md as regression tests","name":"Steadymark","google":"","body":"# Steady Mark\r\nTurning your github readme files into python test suites since 2012\r\n\r\nSteady Mark was created for python developers that love Github and\r\nmarkdown.\r\n\r\n## How it works:\r\n\r\nWrite your documentation using [github-flavored markdown](http://github.github.com/github-flavored-markdown/), surround your\r\nsnippets with python code blocks and steadymark will automatically\r\nfind and run them, if there is a header preceeding your python snippet\r\nit will be used as title for your test.\r\n\r\n# Advantages:\r\n\r\n* Add test coverage to your app/library while documenting it\r\n* Never have old malfunctional examples on your project's main page in github\r\n* It uses [misaka](http://misaka.61924.nl/) which is a python-binding of [sundown](https://github.com/tanoku/sundown), the markdown engine that github uses in itself\r\n\r\n# Start using steady mark now!\r\n\r\nThis is the code for the example above, copy and paste in you python\r\nproject right now and start keeping your documentation up-to-date with\r\nthe code.\r\n\r\n # My project name\r\n `version 0.1`\r\n\r\n ## unicode.lower transforms string into lowercase\r\n\r\n ```python\r\n assert \"LOWERCaSe\".lower() == \"lowercase\"\r\n ```\r\n\r\n ## python can add numbers\r\n\r\n ```python\r\n assert (2 + 2) == 5, 'oops baby'\r\n ```\r\n\r\nJust run with:\r\n\r\n```bash\r\n$ steadymark README.md\r\n```\r\n\r\n# Integrate with TravisCI!\r\n\r\ncreate a `.travis.yml` file in you repo with the contents:\r\n\r\n```yml\r\nlanguage: python\r\npython:\r\n - \"2.6\"\r\n - \"2.7\"\r\n# command to install dependencies\r\ninstall:\r\n - pip install steadymark>=0.1.4\r\n# command to run tests\r\nscript: steadymark README.md\r\n```","note":"Don't delete this file! It's used internally to help with page regeneration."} |