Skip to main content
License PyPI CI pre-commit.ci status CodeQL codecov.io readthedocs.org python3.8 Black pylint

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"

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readmetester-2.4.1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

readmetester-2.4.1-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file readmetester-2.4.1.tar.gz.

File metadata

  • Download URL: readmetester-2.4.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.8.13 Darwin/22.2.0

File hashes

Hashes for readmetester-2.4.1.tar.gz
Algorithm Hash digest
SHA256 10851e41908a4e1a28c2d1f09a74f8bc2e079529c506d5a5683bb9a189449382
MD5 900861aeac7ea2ec86cae52eb58195f8
BLAKE2b-256 ce85d2af71d065865050dea275908996cb6edd54b6fb2cdc82b4ca32aa3f2565

See more details on using hashes here.

File details

Details for the file readmetester-2.4.1-py3-none-any.whl.

File metadata

  • Download URL: readmetester-2.4.1-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.8.13 Darwin/22.2.0

File hashes

Hashes for readmetester-2.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f471b3180056171dd496e70ef64a63194b341c5eb33ee85c2d9121b885b80ea1
MD5 bea7e1e2352f7de26a54b7b73abca884
BLAKE2b-256 9e15720ead3c3ddff62eb79b466adeaf7014ccee5bf4c0001f2dac2ff33f2021

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.4.1 This release

2 files

2.4.0

2 files

2.3.0

2 files

2.2.0

2 files

2.1.0

2 files

2.0.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page