gungui98 / python-standard

Codecov coverage standard for Python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python-Standard

Workflow for Python Standard Action codecov FOSSA Status

Last Updated: 08/21/21 00:05:57

What is this?

This is a Python application, with basic unit tests, for which coverage is uploaded to Codecov on a daily basis. It can also serve as an example for how to integrate Codecov into your Python project. If the build is passing for this project, then Codecov's Python report processing is functional and correct on codecov.io.

Configuration

This project is written in Python 3.9. Unit tests are written with the pytest framework and coverage reports are generated using the pytest-cov plugin.

Unit tests: /test_index.py

Inside .github/workflows/python-standard.yml file:

install:
  - pip install codecov
  - pip install pytest-cov
script:
  - pytest --cov=./ --cov-report=xml
  - codecov

Usage

Run unit tests inside a Docker container

docker-compose up

Generate coverage reports via pytest

pytest --cov=./ --cov-report=xml

Uploading reports to Codecov

bash <(curl https://codecov.io/bash)

OR

pip install codecov
codecov

Reporting Issues

If you've discovered an issue with this repository or with Python processing in general, it is recommended to email support@codecov.io rather than post an issue here. This repository will not be checked regularly for open issues.

Contributing

Contributions are welcome! If you'd like to contribute to this repository, feel free to open a pull request or flag an issue. If you would like to contribute a new lanaguage standard, you can get more information here.

License

FOSSA Status

About

Codecov coverage standard for Python


Languages

Language:Python 85.7%Language:Dockerfile 11.7%Language:Shell 2.6%