Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Teemu/pytest-sugar
a plugin for py.test that changes the default look and feel of py.test (e.g. progressbar, show tests that fail instantly)
https://github.com/Teemu/pytest-sugar
pytest pytest-plugin pytest-sugar python testing
Last synced: about 1 month ago
JSON representation
a plugin for py.test that changes the default look and feel of py.test (e.g. progressbar, show tests that fail instantly)
- Host: GitHub
- URL: https://github.com/Teemu/pytest-sugar
- Owner: Teemu
- License: other
- Created: 2013-06-25T21:09:27.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T19:34:14.000Z (6 months ago)
- Last Synced: 2024-10-29T11:13:05.411Z (about 1 month ago)
- Topics: pytest, pytest-plugin, pytest-sugar, python, testing
- Language: Python
- Homepage:
- Size: 317 KB
- Stars: 1,309
- Watchers: 19
- Forks: 73
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- best-of-python-dev - GitHub - 18% open · ⏱️ 12.02.2024): (Testing Tools)
README
# pytest-sugar ✨
[](https://github.com/Teemu/pytest-sugar/actions)
[](https://pypi.org/project/pytest-sugar/)
[](https://pypi.org/project/pytest-sugar/)
This plugin extends [pytest](http://pytest.org) by showing failures and errors instantly, adding a progress bar, improving the test results, and making the output look better.
## 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 👷♂️
[](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=10950375)
Make sure to read our [Code of Conduct](https://github.com/Teemu/pytest-sugar/blob/master/.github/CODE_OF_CONDUCT.md). 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 [email protected]: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:
```markdown
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]( https://github.com/Teemu/pytest-sugar/pull/49#issuecomment-146567670) for more details.
## Similar projects
- [pytest-rich](https://github.com/nicoddemus/pytest-rich)
- [pytest-pretty](https://github.com/samuelcolvin/pytest-pretty)