semvec/pypi-packages huggingface dataset:
readmetester 2.4.1
Parse, test, and assert RST code-blocks
License: MIT
Requires Python: >=3.8,<4.0
Keywords: assert,code,readme,rst,test

readmetester
============
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
    :alt: License
.. image:: https://img.shields.io/pypi/v/readmetester
    :target: https://pypi.org/project/readmetester/
    :alt: PyPI
.. image:: https://github.com/jshwi/readmetester/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/jshwi/readmetester/actions/workflows/ci.yml
    :alt: CI
.. image:: https://results.pre-commit.ci/badge/github/jshwi/readmetester/master.svg
   :target: https://results.pre-commit.ci/latest/github/jshwi/readmetester/master
   :alt: pre-commit.ci status
.. image:: https://github.com/jshwi/readmetester/actions/workflows/codeql-analysis.yml/badge.svg
    :target: https://github.com/jshwi/readmetester/actions/workflows/codeql-analysis.yml
    :alt: CodeQL
.. image:: https://codecov.io/gh/jshwi/readmetester/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/jshwi/readmetester
    :alt: codecov.io
.. image:: https://readthedocs.org/projects/readmetester/badge/?version=latest
    :target: https://readmetester.readthedocs.io/en/latest/?badge=latest
    :alt: readthedocs.org
.. image:: https://img.shields.io/badge/python-3.8-blue.svg
    :target: https://www.python.org/downloads/release/python-380
    :alt: python3.8
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Black
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
    :target: https://github.com/PyCQA/pylint
    :alt: pylint

Parse, test, and assert RST code-blocks
---------------------------------------

**Installation**

.. code-block:: console

    $ 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

.. code-block:: console

    $ readmetester README.rst
..

**Documenting**

Python code begins with ``">>> "``

Continuation lines begin with ``"... "``

.. note::

    The length of these strings is 4 including the whitespace at the end
..

Expected output can be quoted or unquoted

.. code-block:: RST

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

.. code-block:: toml

    [tool.readmetester]
    style = "monokai"