Show coverage stats online via coveralls.io
Project description
Coveralls.io is service to publish your coverage stats online with a lot of nice features. This package provides seamless integration with coverage.py in your python projects. For ruby projects, there is an official gem. Only projects hosted on Github are supported.
Works with python 2.6-2.7 and 3.3
Installation
First, log in via Github and add your repo on Coveralls website.
Second, install this package:
$ pip install coveralls
If you’re using Travis CI, no further configuration is required.
Configuration
If you’re not using Travis, you have to provide at least a repo_token option in .coveralls.yml at the root of your repo. This is your own secret token, which is available at the bottom of your repository’s page on Coveralls. Make sure it stays secret, do not put it in your public repo.
Example of .coveralls.yml:
# .coveralls.yml repo_token: TjkDuVpGjuQcRhNW8dots9c8SSnv7ReM5
Usage
$ coverage run your_test_suite_runner.py $ coveralls
This will publish your coverage results on coveralls.io for everyone to see (unless you’re using pro account).
How it works
It makes custom report for data generated by coverage.py package and sends it to json API of coveralls.io service. All python files in your coverage analysis are posted to this service along with coverage stats, so please make sure you’re not ruining your own security! For private projects there is Coveralls Pro.
Tests
$ python setup.py test
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
