Skip to main content

pytest-sugar is a plugin for pytest that changes the default look and feel of pytest (e.g. progressbar, show tests that fail instantly).

Project description

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 👷‍♂️

Open in GitHub Codespaces

Make sure to read our Code of Conduct. You can get started modifying the codebase with the following commands. Alternatively, you can try Github Codespaces (click the badge above). 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

When submitting a pull request, please add a RELEASE.md file in the root of the project that contains the release type (major, minor, patch) and a summary of the changes that will be used as the release changelog entry. For example:

Release type: patch

For long-running tests, display minutes and not only seconds.

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

Project details


Download files

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

Source Distribution

pytest-sugar-0.9.7.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

pytest_sugar-0.9.7-py2.py3-none-any.whl (10.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-sugar-0.9.7.tar.gz.

File metadata

  • Download URL: pytest-sugar-0.9.7.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for pytest-sugar-0.9.7.tar.gz
Algorithm Hash digest
SHA256 f1e74c1abfa55f7241cf7088032b6e378566f16b938f3f08905e2cf4494edd46
MD5 fb032173598df0a3d307c02cf549e4f5
BLAKE2b-256 5718fe569040c5796879288544b1cc98888fce1754138d54e8287ed21614491e

See more details on using hashes here.

File details

Details for the file pytest_sugar-0.9.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_sugar-0.9.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8cb5a4e5f8bbcd834622b0235db9e50432f4cbd71fef55b467fe44e43701e062
MD5 6f74f03f2901a35761ab6fdc2031092a
BLAKE2b-256 c7b28f5d346c86e690c58da3b21b7c14d656b4100606abed8e91a98e8b50f3bf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page