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 ✨

Build Status PyPI Version Downloads License

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-1.0.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

pytest_sugar-1.0.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pytest-sugar-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6422e83258f5b0c04ce7c632176c7732cab5fdb909cb39cca5c9139f81276c0a
MD5 f74f51203bffda323ff57a307fe821bd
BLAKE2b-256 f5ac5754f5edd6d508bc6493bc37d74b928f102a5fff82d9a80347e180998f08

See more details on using hashes here.

File details

Details for the file pytest_sugar-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_sugar-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70ebcd8fc5795dc457ff8b69d266a4e2e8a74ae0c3edc749381c64b5246c8dfd
MD5 2c378bc59496395b7ba9b4afb6597435
BLAKE2b-256 92fb889f1b69da2f13691de09a111c16c4766a433382d44aa0ecf221deded44a

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