Python: doctest my github-markdown files?

Question

I would like to run the doctrines from this file, and it is not clear to me how to do this:

README.md:

# WELCOME!

This library is helpful and will help you in _many_ ways!

For example:

```
>>> import library
>>> library.helps()
True
```

(aside: can someone help me get this to set aside as a markdown?)

Answer 1

As an alternative to doctest, I wrote mkcodes , a script that pulls blocks of code from markdown files so that they can be tested in a separate file.

Here is my actual test script using mkcodes:

mkcodes --github --output tests/docs/test_{name}.py docs
py.test tests
pyflakes tests
pep8 tests

Answer 2

You can run docteston READMEthe command line using:

python -m doctest -v README.md

-m Python script. script doctest doctest.testmod . , -v doctest ; , doctest , ( , ).