====================================
Python interface to coveralls.io API
====================================
.. image:: https://api.travis-ci.org/z4r/python-coveralls.png?branch=master
:target: http://travis-ci.org/z4r/python-coveralls
.. image:: https://coveralls.io/repos/z4r/python-coveralls/badge.png?branch=master
:target: https://coveralls.io/r/z4r/python-coveralls
.. image:: https://img.shields.io/pypi/v/python-coveralls.svg
:target: https://pypi.python.org/pypi/python-coveralls/
.. image:: https://img.shields.io/pypi/dm/python-coveralls.svg
:target: https://pypi.python.org/pypi/python-coveralls/
.. image:: https://img.shields.io/pypi/wheel/python-coveralls.svg
:target: https://pypi.python.org/pypi/python-coveralls/
:alt: Wheel Status
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:
.. code-block:: yaml
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 <https://pypi.python.org/pypi/coverage>`_,
`pytest-cov <https://pypi.python.org/pypi/pytest-cov>`_, or
`nosexcover <https://pypi.python.org/pypi/nosexcover>`_.
Then you can add in the **after_success** step::
coveralls
It should look like something like:
.. code-block:: yaml
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
.. image:: https://d2weczhvl823v0.cloudfront.net/z4r/python-coveralls/trend.png
:alt: Bitdeli badge
:target: https://bitdeli.com/free
Raw data
{
"_id": null,
"home_page": "http://github.com/z4r/python-coveralls",
"name": "python-coveralls",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "coveralls.io",
"author": "Andrea De Marco",
"author_email": "24erre@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a2/55/9db73eeecbb832252e763dc66aa60551fb4560deffda493b56e83602429c/python-coveralls-2.9.3.tar.gz",
"platform": "",
"description": "====================================\nPython interface to coveralls.io API\n====================================\n\n.. image:: https://api.travis-ci.org/z4r/python-coveralls.png?branch=master\n :target: http://travis-ci.org/z4r/python-coveralls\n.. image:: https://coveralls.io/repos/z4r/python-coveralls/badge.png?branch=master\n :target: https://coveralls.io/r/z4r/python-coveralls\n.. image:: https://img.shields.io/pypi/v/python-coveralls.svg\n :target: https://pypi.python.org/pypi/python-coveralls/\n.. image:: https://img.shields.io/pypi/dm/python-coveralls.svg\n :target: https://pypi.python.org/pypi/python-coveralls/\n.. image:: https://img.shields.io/pypi/wheel/python-coveralls.svg\n :target: https://pypi.python.org/pypi/python-coveralls/\n :alt: Wheel Status\n\nThis package provides a module to interface with the https://coveralls.io API.\n\nINSTALLING THE PKG\n==================\nUsing pip::\n\n $ pip install python-coveralls\n\n...Or simply add it to your requirements.\n\n\nCONFIGURATION\n=============\nIf you're not using Travis, Coveralls for Python uses a ``.coveralls.yml`` file at the root level of your repository to configure options.\nThe only required option is ``repo_token`` (found on your repository's page on Coveralls) to specify which project on Coveralls your project maps to.\nAnother 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.\nA ``.coveralls.yml`` file configured for Travis Pro:\n\n.. code-block:: yaml\n\n repo_token: abcdef1234569abdcef\n service_name: travis-pro\n parallel: true # if the CI is running your build in parallel\n\nif you don't want the ``repo_token`` under source control, set it in your ``coveralls`` command::\n\n COVERALLS_REPO_TOKEN=abcdef1234569abdcef coveralls\n\nTRAVIS.YML\n==========\nCreate a ``.coverage`` file and you can use `coverage <https://pypi.python.org/pypi/coverage>`_,\n`pytest-cov <https://pypi.python.org/pypi/pytest-cov>`_, or\n`nosexcover <https://pypi.python.org/pypi/nosexcover>`_.\nThen you can add in the **after_success** step::\n\n coveralls\n\nIt should look like something like:\n\n.. code-block:: yaml\n\n language: python\n python:\n - \"2.6\"\n - \"2.7\"\n install:\n - pip install -e . --use-mirrors\n before_script:\n - pip install -r test_requirements.txt --use-mirrors\n - git clone https://github.com/z4r/python-coveralls-example.git\n - cd python-coveralls-example\n - git checkout -qf 17b8119796516195527dcb4f454a2ebd41d60244\n - py.test example/tests.py --cov=example\n - cd -\n script:\n - py.test coveralls/tests.py --doctest-modules --pep8 coveralls -v --cov coveralls --cov-report term-missing\n after_success:\n - coveralls\n\nCOVERALLS OPTIONS\n=================\nYou probably don't need to configure anything, but if you customize some option of `coverage` you would add it to `coveralls` too::\n\n $ coveralls -h\n usage: coveralls [-h] [--coveralls_url COVERALLS_URL] [--base_dir BASE_DIR]\n [--data_file DATA_FILE] [--config_file CONFIG_FILE]\n [--coveralls_yaml COVERALLS_YAML] [--ignore-errors]\n [--merge_file MERGE_FILE] [--nogit]\n\n optional arguments:\n -h, --help show this help message and exit\n --coveralls_url COVERALLS_URL, -u COVERALLS_URL\n coveralls.io api url\n --base_dir BASE_DIR, -b BASE_DIR\n project root directory\n --data_file DATA_FILE, -d DATA_FILE\n coverage file name\n --config_file CONFIG_FILE, -c CONFIG_FILE\n coverage config file name\n --coveralls_yaml COVERALLS_YAML, -y COVERALLS_YAML\n coveralls yaml file name\n --ignore-errors, -i ignore errors while reading source files\n --merge_file MERGE_FILE, -m MERGE_FILE\n json file containing coverage data to be merged (for\n merging javascript coverage)\n --nogit do not gather git repo info\n\n\n\n\n.. image:: https://d2weczhvl823v0.cloudfront.net/z4r/python-coveralls/trend.png\n :alt: Bitdeli badge\n :target: https://bitdeli.com/free\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Python interface to coveralls.io API\n",
"version": "2.9.3",
"split_keywords": [
"coveralls.io"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "148c5358f5f9151706aa4a1acf9522c4",
"sha256": "fb0ff49bb1551dac10b06bd55e9790287d898a0f1e2c959802235cae08dd0bff"
},
"downloads": -1,
"filename": "python_coveralls-2.9.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "148c5358f5f9151706aa4a1acf9522c4",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 9878,
"upload_time": "2019-08-01T19:12:20",
"upload_time_iso_8601": "2019-08-01T19:12:20.159405Z",
"url": "https://files.pythonhosted.org/packages/3b/2d/8c4cefb1de18817d9e05552e29b3780a713122d6fff6c535461836c90186/python_coveralls-2.9.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "5334bf80c510a15f59e530210c6df367",
"sha256": "bfaf7811e7dc5628e83b6b162962a4e2485dbff184b30e49f380374ed1bcee55"
},
"downloads": -1,
"filename": "python-coveralls-2.9.3.tar.gz",
"has_sig": false,
"md5_digest": "5334bf80c510a15f59e530210c6df367",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9036,
"upload_time": "2019-08-01T19:12:17",
"upload_time_iso_8601": "2019-08-01T19:12:17.540957Z",
"url": "https://files.pythonhosted.org/packages/a2/55/9db73eeecbb832252e763dc66aa60551fb4560deffda493b56e83602429c/python-coveralls-2.9.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-08-01 19:12:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "z4r",
"github_project": "python-coveralls",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"appveyor": true,
"test_requirements": [
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-pep8",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "httpretty",
"specs": []
}
],
"lcname": "python-coveralls"
}
JSON
