/example-python

Python coverage example

Primary LanguagePython

Codecov Python Example

# 1) install codecov
pip install codecov

# 2) next call "codecov" at end of CI build
# public repo using Travis, CircleCI or AppVeyor
codecov

# all other CI and private repositories
codecov --token=<repo token>

How to generate coverage reports

coverage.py is required to collect coverage metrics. Below are some examples on how to include coverage tracking during your tests. Codecov will call coverage xml -i automatically to generate the coverage xml output, which will be archived and processed server side.

You may need to configure a .coveragerc file. Learn more here: http://coverage.readthedocs.org/en/latest/config.html. Start with this generic .coveragerc for example.

unittests

pip install coverage
coverage run tests.py

pytest

pip install pytest-cov
py.test --cov=./

nosetests

http://nose.readthedocs.org/en/latest/plugins/cover.html

nosetest --with-coverage

Testing with tox

Codecov can be ran from inside your tox.ini please make sure you pass all the necessary environment variables through:

[testenv]
passenv = CI TRAVIS TRAVIS_*
deps = codecov
commands = codecov

See all the environment variable for other CI providers here.

Frequently Asked Questions

####❔Whats the different between the codecov-bash and codecov-python uploader?

As far as python is concerned, nothing. You may choose to use either uploader. Codecov recommends using the bash uploader when possible as it supports more unique repository setups.

Learn more at codecov/codecov-bash and codecov/codecov-python

####❔Why am I seeing No data to report. This output is written by running the command coverage xml and states that there were no .coverage files found.

  1. Make sure coverage is enabled. See Enabling Coverage
  2. You may need to run coverage combine before running Codecov
  3. Using Docker? Please follow this step: Testing with Docker: Codecov Inside Docker

####❔Can I upload my .coverage files?

No, these files contain coverage data but are not properly mapped back to the source code. We rely on coveragepy to handle this by calling coverage xml in the uploader.