readmetester

Parse, test, and assert RST code-blocks

Installation

$ pip install readmetester

Usage

readmetester [-h] [--version] [README.rst]

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

Python code begins with ">>> "

Continuation lines begin with "... "

Expected output can be quoted or unquoted

.. 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"

Metadata

Release files for readmetester 2.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for readmetester 2.4.1
File	Size	Uploaded
readmetester-2.4.1.tar.gz	11.3 kB	Jan 7, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for readmetester 2.4.1
File	Interpreter	ABI	Platform	Reset
readmetester-2.4.1-py3-none-any.whl 11.6 kB Jan 7, 2023	Python 3	none	any	Details

Total release size: 23.0 kB

Release files / readmetester-2.4.1.tar.gz

Download URL	readmetester-2.4.1.tar.gz
Size	11.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`10851e41908a4e1a28c2d1f09a74f8bc2e079529c506d5a5683bb9a189449382`
BLAKE2b-256 checksum How to use checksums	`ce85d2af71d065865050dea275908996cb6edd54b6fb2cdc82b4ca32aa3f2565`
Upload date	Jan 7, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.2.1 CPython/3.8.13 Darwin/22.2.0`

Release files / readmetester-2.4.1-py3-none-any.whl

Download URL	readmetester-2.4.1-py3-none-any.whl
Size	11.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f471b3180056171dd496e70ef64a63194b341c5eb33ee85c2d9121b885b80ea1`
BLAKE2b-256 checksum How to use checksums	`9e15720ead3c3ddff62eb79b466adeaf7014ccee5bf4c0001f2dac2ff33f2021`
Upload date	Jan 7, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.2.1 CPython/3.8.13 Darwin/22.2.0`