How to integrate checking of readme in pytest

Question

I use pytest in my .travis.yml to check my code.

I would like to check the README.rst, too.

I found readme_renderer via this StackO answer

Now I ask myself how to integrate this into my current tests.

The docs of readme_renderer suggest this, but I have not clue how to integrate this into my setup:

python setup.py check -r -s

Answer 1

I think the simplest and most robust option is to write a pytest plugin that replicates what the distutils command you mentioned in you answer does.

That could be as simple as a conftest.py in your test dir. Or if you want a standalone plugin that's distributable for all of us to benefit from there's a nice cookiecutter template.

Ofc there's inherently nothing wrong with calling the check manually in your script section after the call to pytest.

Answer 2

I check it like this now:

# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, unicode_literals, print_function

import os
import subx
import unittest

class Test(unittest.TestCase):
    def test_readme_rst_valid(self):
        base_dir = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
subx.call(cmd=['python', os.path.join(base_dir, 'setup.py'), 'check', '--metadata', '--restructuredtext', '--strict'])

Source: https://github.com/guettli/reprec/blob/master/reprec/tests/test_setup.py