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 = py310,py311,py312

    [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 :ref:`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``
- ``BUILDKITE_JOB_ID``
- ``BUILDKITE_BRANCH``

CircleCI
--------
::

    passenv = CIRCLECI , CIRCLE_* , CI_PULL_REQUEST

All variables:

- ``CIRCLECI``
- ``CIRCLE_WORKFLOW_ID``
- ``CIRCLE_BUILD_NUM``
- ``CIRCLE_BRANCH``
- ``CIRCLE_NODE_INDEX``
- ``CI_PULL_REQUEST``

Github Actions
--------------
::

    passenv = GITHUB_*

All variables:

- ``GITHUB_ACTIONS``
- ``GITHUB_REF``
- ``GITHUB_SHA``
- ``GITHUB_HEAD_REF``
- ``GITHUB_REPOSITORY``
- ``GITHUB_RUN_ID``
- ``GITHUB_TOKEN``

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
-----------

Classic
~~~~~~~

::

    passenv = SEMAPHORE , SEMAPHORE_EXECUTABLE_UUID , SEMAPHORE_JOB_UUID , SEMAPHORE_BRANCH_ID , BRANCH_NAME

All variables:

- ``SEMAPHORE``
- ``SEMAPHORE_EXECUTABLE_UUID``
- ``SEMAPHORE_JOB_UUID``
- ``SEMAPHORE_BRANCH_ID``
- ``BRANCH_NAME``

2.0
~~~

::

    passenv = SEMAPHORE , SEMAPHORE_WORKFLOW_ID , SEMAPHORE_JOB_ID , SEMAPHORE_GIT_PR_NUMBER , BRANCH_NAME

All variables:

- ``SEMAPHORE``
- ``SEMAPHORE_WORKFLOW_ID``
- ``SEMAPHORE_JOB_ID``
- ``SEMAPHORE_GIT_PR_NUMBER``
- ``BRANCH_NAME``

.. _tox: https://tox.readthedocs.io/en/latest/