pytest-clarity


Namepytest-clarity JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/darrenburns/pytest-clarity
SummaryA plugin providing an alternative, colourful diff output for failing assertions.
upload_time2021-06-11 18:16:18
maintainerDarren Burns
docs_urlNone
authorDarren Burns
requires_python>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =================
pytest-clarity
=================

.. image:: https://img.shields.io/pypi/v/pytest-clarity.svg
    :target: https://pypi.org/project/pytest-clarity
    :alt: PyPI version
    
.. image:: https://img.shields.io/conda/vn/conda-forge/pytest-clarity.svg
    :target: https://anaconda.org/conda-forge/pytest-clarity
    :alt: conda-forge version    

.. image:: https://img.shields.io/pypi/pyversions/pytest-clarity.svg
    :target: https://pypi.org/project/pytest-clarity
    :alt: Python versions

.. image:: https://travis-ci.org/darrenburns/pytest-clarity.svg?branch=master
    :target: https://travis-ci.org/darrenburns/pytest-clarity
    :alt: See Build Status on Travis CI

A pytest plugin which brings the coloured diff output from the `Ward test framework <https://github.com/darrenburns/ward>`_ to pytest.

Before
------
.. image:: https://user-images.githubusercontent.com/5740731/121730571-c5387600-cae7-11eb-96eb-eaa6d4cfd09f.png
     :alt: Example output without pytest-clarity


After
-----
.. image:: https://user-images.githubusercontent.com/5740731/121730569-c4074900-cae7-11eb-9416-47f02ca4ff82.png
     :alt: Example output without pytest-clarity


Requirements
------------

Supports Python 3.6+.

Installation
------------

You can install "pytest-clarity" via ``pip``::

    $ pip install pytest-clarity


Usage
-----

Install the plugin as described above.

The plugin will only be activated when the :code:`-vv` option is supplied to :code:`pytest`.

You can configure the width of the output with the :code:`--diff-width` option:

::

    pytest -vv --diff-width=60


You can force `pytest-clarity` to show a symbolic diff with :code:`--diff-symbols`::

    pytest -vv --diff-symbols



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/darrenburns/pytest-clarity",
    "name": "pytest-clarity",
    "maintainer": "Darren Burns",
    "docs_url": null,
    "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
    "maintainer_email": "darrenb900@gmail.com",
    "keywords": "",
    "author": "Darren Burns",
    "author_email": "darrenb900@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/52/5c/cafa97944de55738a6a2c5a7cee00d073cb80495032d2b112c4546525eca/pytest-clarity-1.0.1.tar.gz",
    "platform": "",
    "description": "=================\npytest-clarity\n=================\n\n.. image:: https://img.shields.io/pypi/v/pytest-clarity.svg\n    :target: https://pypi.org/project/pytest-clarity\n    :alt: PyPI version\n    \n.. image:: https://img.shields.io/conda/vn/conda-forge/pytest-clarity.svg\n    :target: https://anaconda.org/conda-forge/pytest-clarity\n    :alt: conda-forge version    \n\n.. image:: https://img.shields.io/pypi/pyversions/pytest-clarity.svg\n    :target: https://pypi.org/project/pytest-clarity\n    :alt: Python versions\n\n.. image:: https://travis-ci.org/darrenburns/pytest-clarity.svg?branch=master\n    :target: https://travis-ci.org/darrenburns/pytest-clarity\n    :alt: See Build Status on Travis CI\n\nA pytest plugin which brings the coloured diff output from the `Ward test framework <https://github.com/darrenburns/ward>`_ to pytest.\n\nBefore\n------\n.. image:: https://user-images.githubusercontent.com/5740731/121730571-c5387600-cae7-11eb-96eb-eaa6d4cfd09f.png\n     :alt: Example output without pytest-clarity\n\n\nAfter\n-----\n.. image:: https://user-images.githubusercontent.com/5740731/121730569-c4074900-cae7-11eb-9416-47f02ca4ff82.png\n     :alt: Example output without pytest-clarity\n\n\nRequirements\n------------\n\nSupports Python 3.6+.\n\nInstallation\n------------\n\nYou can install \"pytest-clarity\" via ``pip``::\n\n    $ pip install pytest-clarity\n\n\nUsage\n-----\n\nInstall the plugin as described above.\n\nThe plugin will only be activated when the :code:`-vv` option is supplied to :code:`pytest`.\n\nYou can configure the width of the output with the :code:`--diff-width` option:\n\n::\n\n    pytest -vv --diff-width=60\n\n\nYou can force `pytest-clarity` to show a symbolic diff with :code:`--diff-symbols`::\n\n    pytest -vv --diff-symbols\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A plugin providing an alternative, colourful diff output for failing assertions.",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/darrenburns/pytest-clarity"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "525ccafa97944de55738a6a2c5a7cee00d073cb80495032d2b112c4546525eca",
                "md5": "66f07f48e101598f6bffdeb79fdb9304",
                "sha256": "505fe345fad4fe11c6a4187fe683f2c7c52c077caa1e135f3e483fe112db7772"
            },
            "downloads": -1,
            "filename": "pytest-clarity-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "66f07f48e101598f6bffdeb79fdb9304",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 4891,
            "upload_time": "2021-06-11T18:16:18",
            "upload_time_iso_8601": "2021-06-11T18:16:18.372752Z",
            "url": "https://files.pythonhosted.org/packages/52/5c/cafa97944de55738a6a2c5a7cee00d073cb80495032d2b112c4546525eca/pytest-clarity-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-11 18:16:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "darrenburns",
    "github_project": "pytest-clarity",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "pytest-clarity"
}
        
Elapsed time: 0.60749s