Metadata-Version: 1.1
Name: ci-diff-helper
Version: 0.2.0
Summary: Diff Helper for Continuous Integration (CI) Services
Home-page: https://github.com/dhermes/ci-diff-helper
Author: Danny Hermes
Author-email: daniel.j.hermes@gmail.com
License: Apache 2.0
Description: CI Diff Helper
        ==============
        
            Diff Helper for Continuous Integration (CI) Services
        
        |coverage| |docs|
        
        For an open source project, running unit tests, system tests, torture tests,
        fuzz tests, integration tests, code quality checks, etc. can quickly become
        a large task.
        
        In order to limit the amount of time and resources that these jobs require,
        this tool provides a way to determine which files have changed and provides
        a Python API for these changes. In addition, this library provides the
        corresponding commit SHA (or other artifact) that is used as the diffbase.
        
        The library supports (planned)
        
        * Continuous Integration Services
        
          * `Travis CI`_ |build-travis|
          * `AppVeyor`_ |build-appveyor|
          * `CircleCI`_ |build-circ|
        
        * Verson Control Systems
        
          * `git`_
        
        * Project Hosting Sites
        
          * `GitHub`_
        
        .. _Travis CI: https://travis-ci.com/
        .. _AppVeyor: https://www.appveyor.com/
        .. _CircleCI: https://circleci.com/
        .. _git: https://git-scm.com/
        .. _GitHub: https://github.com/
        
        Install
        -------
        
        .. code-block:: console
        
            $ pip install --upgrade ci-diff-helper
        
        See It In Action
        ----------------
        
        The ``test-app`` `branch`_ is set up to run every time a change is made.
        Check out the `latest Travis builds`_ in ``test-app``, the
        `latest CircleCI builds`_ and the `latest AppVeyor builds`_
        to see the computed values at work.
        
        For example, in a `Travis PR build`_::
        
            Config object: <Travis (active=True)>
            ----------------------------------------
                active: True
                  base: 'test-app'
                branch: 'test-app'
            event_type: <TravisEventType.pull_request: 'pull_request'>
                 in_pr: True
              is_merge: True
             merged_pr: None
                    pr: 10
                  slug: 'dhermes/ci-diff-helper'
                   tag: None
                   ...
        
        and in a `Travis push build`_::
        
            Config object: <Travis (active=True)>
            ----------------------------------------
                active: True
                  base: u'4a02445642735ba0d3ce5b944f4b2647b4c55813'
                branch: 'test-app'
            event_type: <TravisEventType.push: 'push'>
                 in_pr: False
              is_merge: True
             merged_pr: 10
                    pr: None
                  slug: 'dhermes/ci-diff-helper'
                   tag: None
                   ...
        
        A `CircleCI push build`_::
        
            Config object: <CircleCI (active=True)>
            ----------------------------------------
                active: True
                branch: 'test-app'
              is_merge: True
                   tag: None
                   ...
        
        An `AppVeyor push build`_::
        
            Config object: <AppVeyor (active=True)>
            ----------------------------------------
                active: True
                branch: 'test-app'
              is_merge: True
              provider: <AppVeyorRepoProvider.github: 'github'>
                   tag: None
                   ...
        
        .. _branch: https://github.com/dhermes/ci-diff-helper/tree/test-app
        .. _latest Travis builds: https://travis-ci.org/dhermes/ci-diff-helper/branches
        .. _latest CircleCI builds: https://circleci.com/gh/dhermes/ci-diff-helper/tree/test-app
        .. _latest AppVeyor builds: https://ci.appveyor.com/project/dhermes/ci-diff-helper/history?branch=test-app
        .. _Travis PR build: https://travis-ci.org/dhermes/ci-diff-helper/builds/174378302
        .. _Travis push build: https://travis-ci.org/dhermes/ci-diff-helper/builds/174378578
        .. _CircleCI push build: https://circleci.com/gh/dhermes/ci-diff-helper/49
        .. _AppVeyor push build: https://ci.appveyor.com/project/dhermes/ci-diff-helper/build/1.0.140.test-app
        
        License
        -------
        
        Apache 2.0 - See `LICENSE`_ for more information.
        
        .. _LICENSE: https://github.com/dhermes/ci-diff-helper/blob/master/LICENSE
        
        .. |build-travis| image:: https://travis-ci.org/dhermes/ci-diff-helper.svg?tag=0.2.0
           :target: https://travis-ci.org/dhermes/ci-diff-helper
        .. |build-circ| image:: https://circleci.com/gh/dhermes/ci-diff-helper.svg?style=shield
           :target: https://circleci.com/gh/dhermes/ci-diff-helper
           :alt: CirleCI Build
        .. |build-appveyor| image:: https://ci.appveyor.com/api/projects/status/github/dhermes/ci-diff-helper?tag=0.2.0&svg=true
           :target: https://ci.appveyor.com/project/dhermes/ci-diff-helper
        .. |coverage| image:: https://coveralls.io/repos/github/dhermes/ci-diff-helper/badge.svg?branch=0.2.0
           :target: https://coveralls.io/github/dhermes/ci-diff-helper?branch=0.2.0
        .. |docs| image:: https://readthedocs.org/projects/ci-diff-helper/badge/?version=0.2.0
           :target: http://ci-diff-helper.readthedocs.io/en/0.2.0/?badge=0.2.0
           :alt: Documentation Status
        
Platform: Posix; MacOS X; Windows
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet
