Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 4.19 KB

README.md

File metadata and controls

130 lines (93 loc) · 4.19 KB
Raw

Screenshot

made-with-python Code style: black License PyPI version shields.io PyPI pyversions PyPi downloads Downloads Docs

Pytest emoji output

A pytest plugin that helps to reflect tests output with emoji.

Tools

Production

  • python 3.7, 3.8, 3.9, 3.10
  • pytest

Development

Usage

Demo

Installation

Please run following script to obtain latest package from PYPI:

pip install pytest-emoji-output

Then please execute command below:

pytest --emoji-out/--eo <your-tests-directory>

Source code

To be able to use plugin from the source code please execute commands below:

git clone git@github.com:vyahello/pytest-emoji-output.git
pip install -e .

⬆ back to top

Development notes

Configuration

In order to enable plugin automatically within your pytest.ini configuration file, please set an appropriate flag:

[pytest]
addopts = --emoji-out

or a shorten version:

[pytest]
addopts = --eo

Testing

Generally, pytest tool is used to organize testing procedure.

Please follow next command to run unittests:

pytest

In addition, package unit tests are implemented with bats framework:

PACKAGE_NAME and PACKAGE_VERSION environment variables should be set to run tests.

bats --pretty test-package.bats

CI

Project has Travis CI integration using .travis.yml file thus code analysis (black, pylint, flake8) and unittests (pytest) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

./analyse-code.sh

Release notes

Please check changelog file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello

Distributed under the MIT license. See LICENSE for more information.

You can reach out me at:

Contributing

I would highly appreciate any contribution and support. If you are interested to add your ideas into project please follow next simple steps:

  1. Clone the repository
  2. Configure git for the first time after cloning with your name and email
  3. pip install -r requirements.txt to install all project dependencies
  4. pip install -r requirements-dev.txt to install all development project dependencies
  5. Create your feature branch (git checkout -b feature/fooBar)
  6. Commit your changes (git commit -am 'Add some fooBar')
  7. Push to the branch (git push origin feature/fooBar)
  8. Create a new Pull Request

What's next

All recent activities and ideas are described at project issues. If you have ideas you want to change/implement please do not hesitate and create an issue.

⬆ back to top