ci-info 0.4.0
Continuous Integration Information
License: MIT

# ci-info

[![PyPI version](https://badge.fury.io/py/ci-info.svg)](https://badge.fury.io/py/ci-info)
[![Build Status](https://travis-ci.org/mgxd/ci-info.svg?branch=master)](https://travis-ci.org/mgxd/ci-info)

A Python implementation of [watson/ci-info](https://github.com/watson/ci-info).
Get details about the current Continuous Integration environment.

Please [open an issue](https://github.com/mgxd/ci-info/issues/new)
if your CI server isn't properly detected :)


## Supported CI tools

Officially supported CI servers:

| Name                                                                            | isPR |
| ------------------------------------------------------------------------------- | ---- |
| [Agola CI](https://agola.io/)                                                   | ✅   |
| [Appcircle](https://appcircle.io/)                                              | ✅   |
| [AppVeyor](http://www.appveyor.com)                                             | ✅   |
| [AWS CodeBuild](https://aws.amazon.com/codebuild/)                              | ✅   |
| [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) | ✅   |
| [Bamboo](https://www.atlassian.com/software/bamboo) by Atlassian                | 🚫   |
| [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines)         | ✅   |
| [Bitrise](https://www.bitrise.io/)                                              | ✅   |
| [Buddy](https://buddy.works/)                                                   | ✅   |
| [Buildkite](https://buildkite.com)                                              | ✅   |
| [CircleCI](http://circleci.com)                                                 | ✅   |
| [Cirrus CI](https://cirrus-ci.org)                                              | ✅   |
| [Cloudflare Pages](https://pages.cloudflare.com/)                               | 🚫   |
| [Cloudflare Workers](https://pages.cloudflare.com/)                             | 🚫   |
| [Codefresh](https://codefresh.io/)                                              | ✅   |
| [Codeship](https://codeship.com)                                                | 🚫   |
| [Drone](https://drone.io)                                                       | ✅   |
| [dsari](https://github.com/rfinnie/dsari)                                       | 🚫   |
| [Earthly CI](https://earthly.dev/)                                              | 🚫   |
| [Expo Application Services](https://expo.dev/eas)                               | 🚫   |
| [Gerrit CI](https://www.gerritcodereview.com)                                   | 🚫   |
| [GitHub Actions](https://github.com/features/actions/)                          | ✅   |
| [GitLab CI](https://about.gitlab.com/gitlab-ci/)                                | ✅   |
| [Gitea Actions](https://about.gitea.com/)                                       | 🚫   |
| [GoCD](https://www.go.cd/)                                                      | 🚫   |
| [Google Cloud Build](https://cloud.google.com/build)                            | 🚫   |
| [Harness CI](https://www.harness.io/products/continuous-integration)            | 🚫   |
| [Heroku](https://www.heroku.com)                                                | 🚫   |
| [Hudson](http://hudson-ci.org)                                                  | 🚫   |
| [Jenkins CI](https://jenkins-ci.org)                                            | ✅   |
| [LayerCI](https://layerci.com/)                                                 | ✅   |
| [Magnum CI](https://magnum-ci.com)                                              | 🚫   |
| [Netlify CI](https://www.netlify.com/)                                          | ✅   |
| [Nevercode](http://nevercode.io/)                                               | ✅   |
| [Prow](https://docs.prow.k8s.io/)                                               | 🚫   |
| [ReleaseHub](https://releasehub.com/)                                           | 🚫   |
| [Render](https://render.com/)                                                   | ✅   |
| [Sail CI](https://sail.ci/)                                                     | ✅   |
| [Screwdriver](https://screwdriver.cd/)                                          | ✅   |
| [Semaphore](https://semaphoreci.com)                                            | ✅   |
| [Shippable](https://www.shippable.com/)                                         | ✅   |
| [Solano CI](https://www.solanolabs.com/)                                        | ✅   |
| [Sourcehut](https://sourcehut.org/)                                             | 🚫   |
| [Strider CD](https://strider-cd.github.io/)                                     | 🚫   |
| [TaskCluster](http://docs.taskcluster.net)                                      | 🚫   |
| [TeamCity](https://www.jetbrains.com/teamcity/) by JetBrains                    | 🚫   |
| [Travis CI](http://travis-ci.org)                                               | ✅   |
| [Vela](https://go-vela.github.io/docs/)                                         | ✅   |
| [Vercel](https://vercel.com/)                                                   | ✅   |
| [Visual Studio App Center](https://appcenter.ms/)                               | 🚫   |
| [Woodpecker](https://woodpecker-ci.org/)                                        | ✅   |


## Installation

```
pip install ci-info
```

## Usage

```python
import ci_info
if ci_info.is_ci():
    print(ci_info.name())

"My CI Name"
```


## API

### `ci_info.name()`

Returns a string containing name of the CI server the code is running on.
If CI server is not detected, it returns `None`.

Don't depend on the value of this string not to change for a specific
vendor.

### `ci_info.is_ci()`

Returns a boolean. Will be `True` if the code is running on a CI server,
otherwise `False`.

Some CI servers not listed here might still trigger the `ci_info.is_ci()`
boolean to be set to `True` if they use certain vendor neutral
environment variables. In those cases `ci_info.name()` will be `None` and no
vendor specific boolean will be set to `True`.

### `ci_info.is_pr()`

Returns a boolean if PR detection is supported for the current CI server. Will
be `True` if a PR is being tested, otherwise `False`. If PR detection is
not supported for the current CI server, the value will be `None`.

### `ci_info.info()`

Returns a dictionary of all above values in key/value pairs.

## License

[MIT](LICENSE)