Python interface to coveralls.io API
Project description
This package provides a module to interface with the https://coveralls.io API.
INSTALLING THE PKG
Using pip:
$ pip install python-coveralls
…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:
repo_token: abcdef1234569abdcef
service_name: travis-pro
parallel: true # if the CI is running your build in parallel
if you don’t want the repo_token under source control, set it in your coveralls command:
COVERALLS_REPO_TOKEN=abcdef1234569abdcef coveralls
TRAVIS.YML
Create a .coverage file and you can use coverage, pytest-cov, or nosexcover. Then you can add in the after_success step:
coveralls
It should look like something like:
language: python
python:
- "2.6"
- "2.7"
install:
- pip install -e . --use-mirrors
before_script:
- pip install -r test_requirements.txt --use-mirrors
- git clone https://github.com/z4r/python-coveralls-example.git
- cd python-coveralls-example
- git checkout -qf 17b8119796516195527dcb4f454a2ebd41d60244
- py.test example/tests.py --cov=example
- cd -
script:
- py.test coveralls/tests.py --doctest-modules --pep8 coveralls -v --cov coveralls --cov-report term-missing
after_success:
- coveralls
COVERALLS OPTIONS
You probably don’t need to configure anything, but if you customize some option of coverage you would add it to coveralls too:
$ coveralls -h usage: coveralls [-h] [--coveralls_url COVERALLS_URL] [--base_dir BASE_DIR] [--data_file DATA_FILE] [--config_file CONFIG_FILE] [--coveralls_yaml COVERALLS_YAML] [--ignore-errors] [--merge_file MERGE_FILE] [--nogit] optional arguments: -h, --help show this help message and exit --coveralls_url COVERALLS_URL, -u COVERALLS_URL coveralls.io api url --base_dir BASE_DIR, -b BASE_DIR project root directory --data_file DATA_FILE, -d DATA_FILE coverage file name --config_file CONFIG_FILE, -c CONFIG_FILE coverage config file name --coveralls_yaml COVERALLS_YAML, -y COVERALLS_YAML coveralls yaml file name --ignore-errors, -i ignore errors while reading source files --merge_file MERGE_FILE, -m MERGE_FILE json file containing coverage data to be merged (for merging javascript coverage) --nogit do not gather git repo info
Project details
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.
Source Distribution
Built Distribution
File details
Details for the file python-coveralls-2.9.3.tar.gz
.
File metadata
- Download URL: python-coveralls-2.9.3.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/2.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfaf7811e7dc5628e83b6b162962a4e2485dbff184b30e49f380374ed1bcee55 |
|
MD5 | 5334bf80c510a15f59e530210c6df367 |
|
BLAKE2b-256 | a2559db73eeecbb832252e763dc66aa60551fb4560deffda493b56e83602429c |
File details
Details for the file python_coveralls-2.9.3-py2.py3-none-any.whl
.
File metadata
- Download URL: python_coveralls-2.9.3-py2.py3-none-any.whl
- Upload date:
- Size: 9.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/2.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb0ff49bb1551dac10b06bd55e9790287d898a0f1e2c959802235cae08dd0bff |
|
MD5 | 148c5358f5f9151706aa4a1acf9522c4 |
|
BLAKE2b-256 | 3b2d8c4cefb1de18817d9e05552e29b3780a713122d6fff6c535461836c90186 |