Skip to content

Commit e02bded

Browse files
author
Steve Peak
committed
Add more docs close #12
1 parent 810e2a5 commit e02bded

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,33 @@ test:
6262
> Note: No need to include a repository token for **public** repos on CircleCI
6363

6464

65+
## How to generate coverage reports
66+
67+
The use of [coverage.py](https://bitbucket.org/ned/coveragepy) is required. 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.
68+
69+
> You may need to configure a `.coveragerc` file. Learn more here: http://coverage.readthedocs.org/en/latest/config.html. Start with this [generic `.coveragerc`](https://gist.github.com/codecov-io/bf15bde2c7db1a011b6e) for example.
70+
71+
#### Default
72+
73+
```py
74+
pip install coverage
75+
coverage run tests.py
76+
```
77+
78+
#### Using pytest
79+
80+
```py
81+
pip install pytest-cov
82+
py.test --cov=./
83+
```
84+
85+
#### Using nosetests
86+
> http://nose.readthedocs.org/en/latest/plugins/cover.html
87+
88+
```py
89+
nosetest --with-coverage
90+
```
91+
6592

6693

6794
[1]: https://codecov.io/

0 commit comments

Comments
 (0)