/testing-sugar

Primary LanguagePythonOtherNOASSERTION

pytest-sugar ✨

PyPI version

This plugin extends pytest by showing failures and errors instantly, adding a progress bar, improving the test results, and making the output look better.

render1667890332624-min

Installation

To install pytest-sugar:

python -m pip install pytest-sugar

Once installed, the plugin is activated automatically. Run your tests normally:

pytest

If you would like more detailed output (one test per line), then you may use the verbose option:

pytest --verbose

If you would like to run tests without pytest-sugar, use:

pytest -p no:sugar

How to contribute 👷‍♂️

Make sure to read our Code of Conduct. You can get started modifying the codebase with the following commands. Push the changes to your repository & create a pull request.

git clone git@github.com:Teemu/pytest-sugar.git
cd pytest-sugar
python -m venv .venv
source .venv/bin/activate
echo ".venv" >> .git/info/exclude
pip install -e ".[dev]"
pre-commit install

There are two ways of running tests. We have our proper tests:

pytest .

There are also fake tests that can be used to visualise the output:

pytest faketests

Requirements

You will need the following prerequisites in order to use pytest-sugar:

  • Python 3.8 or newer
  • pytest 6.2 or newer

Running on Windows

If you are seeing gibberish, you might want to try changing charset and fonts. See this comment for more details.

Similar projects