1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
# ci-info
[](https://badge.fury.io/py/ci-info)
[](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 |
| ------------------------------------------------------------------------------- | ---- |
| [AWS CodeBuild](https://aws.amazon.com/codebuild/) | 🚫 |
| [AppVeyor](http://www.appveyor.com) | ✅ |
| [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) | ✅ |
| [Appcircle](https://appcircle.io/) | 🚫 |
| [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) | ✅ |
| [Codefresh](https://codefresh.io/) | ✅ |
| [Codeship](https://codeship.com) | 🚫 |
| [Drone](https://drone.io) | ✅ |
| [dsari](https://github.com/rfinnie/dsari) | 🚫 |
| [Expo Application Services](https://expo.dev/eas) | 🚫 |
| [GitHub Actions](https://github.com/features/actions/) | ✅ |
| [GitLab CI](https://about.gitlab.com/gitlab-ci/) | ✅ |
| [GoCD](https://www.go.cd/) | 🚫 |
| [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/) | ✅ |
| [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/) | ✅ |
| [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) | ✅ |
| [Vercel](https://vercel.com/) | 🚫 |
| [Visual Studio App Center](https://appcenter.ms/) | 🚫 |
## 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)
|
