Usage Within Tox

Running coveralls-python from within a tox environment (v2.0 and above) requires an additional step; since coveralls-python relies on environment variables to function, you’ll need to configure tox to capture those variables using the passenv configuration option in your tox.ini.

For example, on TravisCI:

[tox]
envlist = py27,py34,py35,py36

[testenv]
passenv = TRAVIS TRAVIS_*
deps =
    coveralls
commands =
    coverage run --source=yourpackagename setup.py test
    coveralls

If you are configuring coveralls-python with environment variables, you should also pass those. See Configuration for more details.

AppVeyor

passenv = APPVEYOR APPVEYOR_*

All variables:

  • APPVEYOR
  • APPVEYOR_BUILD_ID
  • APPVEYOR_REPO_BRANCH
  • APPVEYOR_PULL_REQUEST_NUMBER

BuildKite

passenv = BUILDKITE BUILDKITE_*

All variables:

  • BUILDKITE
  • BUILDKIT_JOB_ID
  • BUILDKITE_BRANCH

CircleCI

passenv = CIRCLECI CIRCLE_* CI_PULL_REQUEST

All variables:

  • CIRCLECI
  • CIRCLE_BUILD_NUM
  • CIRCLE_BRANCH
  • CI_PULL_REQUEST

Jenkins

passenv = JENKINS_HOME BUILD_NUMBER GIT_BRANCH CI_PULL_REQUEST

All variables:

  • JENKINS_HOME
  • BUILD_NUMBER
  • GIT_BRANCH
  • CI_PULL_REQUEST

TravisCI

passenv = TRAVIS TRAVIS_*

All variables:

  • TRAVIS
  • TRAVIS_JOB_ID
  • TRAVIS_BRANCH
  • TRAVIS_PULL_REQUEST

SemaphoreCI

passenv = SEMAPHORE SEMAPHORE_BUILD_NUMBER BRANCH_NAME PULL_REQUEST_NUMBER

All variables:

  • SEMAPHORE
  • SEMAPHORE_BUILD_NUMBER
  • BRANCH_NAME
  • PULL_REQUEST_NUMBER