readmetester 2.1.0

Parse, test, and assert RST code-blocks

Parse and test README.rst Python code-blocks

Installation

$ pip install readmetester

Code blocks need to begin with

.. code-block:: python

followed by a blank line

End a code block with another blank line

Usage

readmetester [-h] file

If a README.rst file is present in the current working directory it will be used if no arguments are provided

$ readmetester README.rst

Documenting

Documented code needs to be indented

Python code begins with ">>> "

Note

The length of the string is 4 including the whitespace at the end

Expected output can be single quoted or unquoted (no double quotes)

.. code-block:: python

    >>> print("Hello, world!")
    'Hello, world!'

Continuation lines begin with "... "

.. code-block:: python

    >>> n = [
    ...     "zero",
    ...     "one",
    ...     "two",
    ... ]
    >>> for c, i in enumerate(n):
    ...     print(c, i)
    0 zero
    1 one
    2 two

Styles can be configured in a pyproject.toml file

[tool.readmetester]
style = "monokai"