Skip to content

Commit

Permalink
Merge 43f1ab9 into 7b7596d
Browse files Browse the repository at this point in the history
  • Loading branch information
Tony committed May 23, 2013
2 parents 7b7596d + 43f1ab9 commit ff03a31
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.rst
Expand Up @@ -7,30 +7,30 @@ Python interface to coveralls.io API
.. image:: https://coveralls.io/repos/z4r/python-coveralls/badge.png?branch=master
:target: https://coveralls.io/r/z4r/python-coveralls

This package provides a module to interface with the https://coveralls.io/ API.
This package provides a module to interface with the https://coveralls.io API.

INSTALLING THE PKG
==================
Using pip::

$ pip install python-coveralls

or simply adding it to your requirements
...Or simply add it to your requirements.


CONFIGURATION
=============
If you're not using Travis, Coveralls for Python uses a .coveralls.yml file at the root level of your repository to configure options.
The only required option is repo_token (found on your repository's page on Coveralls) to specify which project on Coveralls your project maps to.
Another important option is is service_name which allows you to specify where Coveralls should look to find additional information about your builds. This can be any string, but using travis-ci or travis-pro will allow Coveralls to fetch branch data, comment on pull requests, and more.
A .coveralls.yml file configured for Travis Pro::
If you're not using Travis, Coveralls for Python uses a ``.coveralls.yml`` file at the root level of your repository to configure options.
The only required option is ``repo_token`` (found on your repository's page on Coveralls) to specify which project on Coveralls your project maps to.
Another important option is is ``service_name`` which allows you to specify where Coveralls should look to find additional information about your builds. This can be any string, but using travis-ci or travis-pro will allow Coveralls to fetch branch data, comment on pull requests, and more.
A ``.coveralls.yml`` file configured for Travis Pro::

repo_token: abcdef1234569abdcef
service_name: travis-pro

TRAVIS.YML
==========
Create a .coverage file and you can use coverage, py-cov or nose.
Create a ``.coverage`` file and you can use ``coverage``, ``py-cov``, or ``nose``.
The you can add in the _after_success_ step::

coveralls
Expand Down

0 comments on commit ff03a31

Please sign in to comment.