Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 1.76 KB

README.md

File metadata and controls

37 lines (31 loc) · 1.76 KB
Raw

codecov codecov workflow

Automated Test Suite

We provide an automated tests suite for you to validate the package's core functionality. The modules being tested including:

from kalmus.barcodes.Barcode import *
from kalmus.barcodes.BarcodeGenerator import *
from kalmus.utils.artist import *
from kalmus.utils.measure_utils import *
from kalmus.utils.visualization_utils import *
from kalmus.tkinter_windows.gui_utils import *
from kalmus.command_line_generator import *

A GitHub Action will run on every push or pull-request to the master branch and upload the coverage report on Codecov.

Contributors

We kindly ask our contributors to include the automated tests of new functionality in this test suite. We wish you to make sure the existing and new tests pass locally before you open a pull-request. See our pull-request template for more details.

To run the test suite locally:

  • Clone the project to your local file system.
  • Make sure you are in the top directory of the cloned project
  • Make sure your python version is 3.7 or 3.8 $ python --version
  • Make sure you have the latest version of pip $ python -m pip install --upgrade pip
    $ pip install pytest
    $ pip install pytest-cov
    $ pip install .
    $ python -m pytest tests --cov=kalmus --cov-config=.coveragerc --cov-report term-missing