python-standard

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

python-standard

(★ 14)

Codecov coverage standard for Python

python-standard Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Python-Standard

[![Workflow for Python Standard Action](https://github.com/codecov/python-standard/actions/workflows/python-standard.yml/badge.svg)](https://github.com/codecov/python-standard/actions/workflows/python-standard.yml) [![codecov](https://codecov.io/gh/codecov/Python-Standard/branch/main/graph/badge.svg)](https://codecov.io/gh/codecov/Python-Standard)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fpython-standard.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fpython-standard?ref=badge_shield)

### Last Updated: 09/14/23 00:12:41

## 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:
```yaml
- name: Install dependencies
  run: |
    pip install pytest-cov
    pip install requests
- name: Run Script
  run: |
    pytest --cov=./ --cov-report=xml
- name: Upload to Codecov
  uses: codecov/codecov-action@v3    
```

## Usage

Run unit tests inside a Docker container
```bash
docker-compose up
```

Generate coverage reports via `pytest`
```bash
pytest --cov=./ --cov-report=xml
```

Uploading reports to Codecov
```bash
bash <(curl https://codecov.io/bash)

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](https://github.com/codecov/standards-scripts/blob/main/README.md#contributing).

## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fpython-standard.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fpython-standard?ref=badge_large)

python-standard

python-standard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

python-standard

python-standard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README