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"
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/readmetester/",
"name": "readmetester",
"maintainer": "jshwi",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "stephen@jshwisolutions.com",
"keywords": "assert,code,readme,rst,test",
"author": "jshwi",
"author_email": "stephen@jshwisolutions.com",
"download_url": "https://files.pythonhosted.org/packages/ce/85/d2af71d065865050dea275908996cb6edd54b6fb2cdc82b4ca32aa3f2565/readmetester-2.4.1.tar.gz",
"platform": null,
"description": "readmetester\n============\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License\n.. image:: https://img.shields.io/pypi/v/readmetester\n :target: https://pypi.org/project/readmetester/\n :alt: PyPI\n.. image:: https://github.com/jshwi/readmetester/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/jshwi/readmetester/actions/workflows/ci.yml\n :alt: CI\n.. image:: https://results.pre-commit.ci/badge/github/jshwi/readmetester/master.svg\n :target: https://results.pre-commit.ci/latest/github/jshwi/readmetester/master\n :alt: pre-commit.ci status\n.. image:: https://github.com/jshwi/readmetester/actions/workflows/codeql-analysis.yml/badge.svg\n :target: https://github.com/jshwi/readmetester/actions/workflows/codeql-analysis.yml\n :alt: CodeQL\n.. image:: https://codecov.io/gh/jshwi/readmetester/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/jshwi/readmetester\n :alt: codecov.io\n.. image:: https://readthedocs.org/projects/readmetester/badge/?version=latest\n :target: https://readmetester.readthedocs.io/en/latest/?badge=latest\n :alt: readthedocs.org\n.. image:: https://img.shields.io/badge/python-3.8-blue.svg\n :target: https://www.python.org/downloads/release/python-380\n :alt: python3.8\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen\n :target: https://github.com/PyCQA/pylint\n :alt: pylint\n\nParse, test, and assert RST code-blocks\n---------------------------------------\n\n**Installation**\n\n.. code-block:: console\n\n $ pip install readmetester\n..\n\n**Usage**\n\n``readmetester [-h] [--version] [README.rst]``\n\nIf a README.rst file is present in the current working directory it will be used if no arguments are provided\n\n.. code-block:: console\n\n $ readmetester README.rst\n..\n\n**Documenting**\n\nPython code begins with ``\">>> \"``\n\nContinuation lines begin with ``\"... \"``\n\n.. note::\n\n The length of these strings is 4 including the whitespace at the end\n..\n\nExpected output can be quoted or unquoted\n\n.. code-block:: RST\n\n .. code-block:: python\n\n >>> n = [\n ... \"zero\",\n ... \"one\",\n ... \"two\",\n ... ]\n >>> for c, i in enumerate(n):\n ... print(c, i)\n 0 zero\n 1 one\n 2 two\n\n\nStyles can be configured in a pyproject.toml file\n\n.. code-block:: toml\n\n [tool.readmetester]\n style = \"monokai\"\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Parse, test, and assert RST code-blocks",
"version": "2.4.1",
"split_keywords": [
"assert",
"code",
"readme",
"rst",
"test"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e15720ead3c3ddff62eb79b466adeaf7014ccee5bf4c0001f2dac2ff33f2021",
"md5": "bea7e1e2352f7de26a54b7b73abca884",
"sha256": "f471b3180056171dd496e70ef64a63194b341c5eb33ee85c2d9121b885b80ea1"
},
"downloads": -1,
"filename": "readmetester-2.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bea7e1e2352f7de26a54b7b73abca884",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 11646,
"upload_time": "2023-01-07T01:43:52",
"upload_time_iso_8601": "2023-01-07T01:43:52.665950Z",
"url": "https://files.pythonhosted.org/packages/9e/15/720ead3c3ddff62eb79b466adeaf7014ccee5bf4c0001f2dac2ff33f2021/readmetester-2.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce85d2af71d065865050dea275908996cb6edd54b6fb2cdc82b4ca32aa3f2565",
"md5": "900861aeac7ea2ec86cae52eb58195f8",
"sha256": "10851e41908a4e1a28c2d1f09a74f8bc2e079529c506d5a5683bb9a189449382"
},
"downloads": -1,
"filename": "readmetester-2.4.1.tar.gz",
"has_sig": false,
"md5_digest": "900861aeac7ea2ec86cae52eb58195f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 11344,
"upload_time": "2023-01-07T01:43:54",
"upload_time_iso_8601": "2023-01-07T01:43:54.252830Z",
"url": "https://files.pythonhosted.org/packages/ce/85/d2af71d065865050dea275908996cb6edd54b6fb2cdc82b4ca32aa3f2565/readmetester-2.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-07 01:43:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "readmetester"
}
JSON