ci-info 0.4.0__py2.py3-none-any.whl

ci_info/__init__.py

@@ -0,0 +1,102 @@
+from builtins import str  # remove this once Py2 is dropped
+import json
+import os
+
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "0+unknown"
+
+_here = os.path.dirname(__file__)
+with open(os.path.join(_here, "vendors.json")) as fp:
+    vendors = json.load(fp)
+
+
+def _detect_env(env=None):
+    if env is None:
+        env = os.environ
+
+    for vendor in vendors:
+        vend = vendor.get("env")
+        if isinstance(vend, str) and vend in env:
+            return vendor
+        if isinstance(vend, list):
+            if all(ev in env for ev in vend):
+                return vendor
+        elif isinstance(vend, dict):
+            if "includes" in vend:
+                # Envvar needs to be present and include some value
+                if vend["env"] in env and vend["includes"] in env[vend["env"]]:
+                    return vendor
+            elif "any" in vend:
+                if any(ev in env for ev in vend["any"]):
+                    return vendor
+            else:
+                for ev, val in vend.items():
+                    if ev in env and env[ev] == val:
+                        return vendor
+    return {}
+
+
+def name(env=None):
+    """
+    Returns a string containing name of the CI server the code is running on.
+    If CI server is not detected, returns None.
+    """
+    return _detect_env(env).get("name")
+
+
+def is_ci(env=None):
+    """
+    Returns a boolean. Will be `True` if the code is running on a CI server,
+    otherwise `False`.
+    """
+    return bool(name(env))
+
+
+def is_pr(env=None):
+    """
+    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`.
+    """
+    if env is None:
+        env = os.environ
+    vendor = _detect_env(env)
+
+    vpr = vendor.get("pr")
+    if vpr is None:
+        return
+
+    if isinstance(vpr, str):
+        return bool(env.get(vpr))
+    if isinstance(vpr, dict):
+        if "env" in vpr:
+            # Envvar is not equal to
+            if "ne" in vpr:
+                return bool(env.get(vpr["env"])) and env.get(vpr["env"]) != vpr["ne"]
+            # Envvar is one of a set of values
+            elif "any" in vpr:
+                return env.get(vpr["env"]) in vpr["any"]
+        # Envvar is one of a set of values
+        elif "any" in vpr:
+            for k in vpr["any"]:
+                if env.get(k):
+                    return True
+            return False
+        # Specific value(s)
+        else:
+            for k, v in vpr.items():
+                if env.get(k) != v:
+                    return False
+            return True
+    return None
+
+
+def info(env=None):
+    """Return a dictionary with all info: name, is_ci, is_pr."""
+    return {
+        "name": name(env),
+        "is_ci": is_ci(env),
+        "is_pr": is_pr(env),
+    }

ci_info/vendors.json

@@ -0,0 +1,358 @@
+[
+  {
+    "name": "Agola CI",
+    "constant": "AGOLA",
+    "env": "AGOLA_GIT_REF",
+    "pr": "AGOLA_PULL_REQUEST_ID"
+  },
+  {
+    "name": "Appcircle",
+    "constant": "APPCIRCLE",
+    "env": "AC_APPCIRCLE",
+    "pr": {
+      "env": "AC_GIT_PR",
+      "ne": "false"
+    }
+  },
+  {
+    "name": "AppVeyor",
+    "constant": "APPVEYOR",
+    "env": "APPVEYOR",
+    "pr": "APPVEYOR_PULL_REQUEST_NUMBER"
+  },
+  {
+    "name": "AWS CodeBuild",
+    "constant": "CODEBUILD",
+    "env": "CODEBUILD_BUILD_ARN",
+    "pr": {
+      "env": "CODEBUILD_WEBHOOK_EVENT",
+      "any": [
+        "PULL_REQUEST_CREATED",
+        "PULL_REQUEST_UPDATED",
+        "PULL_REQUEST_REOPENED"
+      ]
+    }
+  },
+  {
+    "name": "Azure Pipelines",
+    "constant": "AZURE_PIPELINES",
+    "env": "TF_BUILD",
+    "pr": {
+      "BUILD_REASON": "PullRequest"
+    }
+  },
+  {
+    "name": "Bamboo",
+    "constant": "BAMBOO",
+    "env": "bamboo_planKey"
+  },
+  {
+    "name": "Bitbucket Pipelines",
+    "constant": "BITBUCKET",
+    "env": "BITBUCKET_COMMIT",
+    "pr": "BITBUCKET_PR_ID"
+  },
+  {
+    "name": "Bitrise",
+    "constant": "BITRISE",
+    "env": "BITRISE_IO",
+    "pr": "BITRISE_PULL_REQUEST"
+  },
+  {
+    "name": "Buddy",
+    "constant": "BUDDY",
+    "env": "BUDDY_WORKSPACE_ID",
+    "pr": "BUDDY_EXECUTION_PULL_REQUEST_ID"
+  },
+  {
+    "name": "Buildkite",
+    "constant": "BUILDKITE",
+    "env": "BUILDKITE",
+    "pr": {
+      "env": "BUILDKITE_PULL_REQUEST",
+      "ne": "false"
+    }
+  },
+  {
+    "name": "CircleCI",
+    "constant": "CIRCLE",
+    "env": "CIRCLECI",
+    "pr": "CIRCLE_PULL_REQUEST"
+  },
+  {
+    "name": "Cirrus CI",
+    "constant": "CIRRUS",
+    "env": "CIRRUS_CI",
+    "pr": "CIRRUS_PR"
+  },
+  {
+    "name": "Cloudflare Pages",
+    "constant": "CLOUDFLARE_PAGES",
+    "env": "CF_PAGES"
+  },
+  {
+    "name": "Cloudflare Workers",
+    "constant": "CLOUDFLARE_WORKERS",
+    "env": "WORKERS_CI"
+  },
+  {
+    "name": "Codefresh",
+    "constant": "CODEFRESH",
+    "env": "CF_BUILD_ID",
+    "pr": {
+      "any": [
+        "CF_PULL_REQUEST_NUMBER",
+        "CF_PULL_REQUEST_ID"
+      ]
+    }
+  },
+  {
+    "name": "Codemagic",
+    "constant": "CODEMAGIC",
+    "env": "CM_BUILD_ID",
+    "pr": "CM_PULL_REQUEST"
+  },
+  {
+    "name": "Codeship",
+    "constant": "CODESHIP",
+    "env": {
+      "CI_NAME": "codeship"
+    }
+  },
+  {
+    "name": "Drone",
+    "constant": "DRONE",
+    "env": "DRONE",
+    "pr": {
+      "DRONE_BUILD_EVENT": "pull_request"
+    }
+  },
+  {
+    "name": "dsari",
+    "constant": "DSARI",
+    "env": "DSARI"
+  },
+  {
+    "name": "Earthly",
+    "constant": "EARTHLY",
+    "env": "EARTHLY_CI"
+  },
+  {
+    "name": "Expo Application Services",
+    "constant": "EAS",
+    "env": "EAS_BUILD"
+  },
+  {
+    "name": "Gerrit",
+    "constant": "GERRIT",
+    "env": "GERRIT_PROJECT"
+  },
+  {
+    "name": "Gitea Actions",
+    "constant": "GITEA_ACTIONS",
+    "env": "GITEA_ACTIONS"
+  },
+  {
+    "name": "GitHub Actions",
+    "constant": "GITHUB_ACTIONS",
+    "env": "GITHUB_ACTIONS",
+    "pr": {
+      "GITHUB_EVENT_NAME": "pull_request"
+    }
+  },
+  {
+    "name": "GitLab CI",
+    "constant": "GITLAB",
+    "env": "GITLAB_CI",
+    "pr": "CI_MERGE_REQUEST_ID"
+  },
+  {
+    "name": "GoCD",
+    "constant": "GOCD",
+    "env": "GO_PIPELINE_LABEL"
+  },
+  {
+    "name": "Google Cloud Build",
+    "constant": "GOOGLE_CLOUD_BUILD",
+    "env": "BUILDER_OUTPUT"
+  },
+  {
+    "name": "Harness CI",
+    "constant": "HARNESS",
+    "env": "HARNESS_BUILD_ID"
+  },
+  {
+    "name": "Heroku",
+    "constant": "HEROKU",
+    "env": {
+      "env": "NODE",
+      "includes": "/app/.heroku/node/bin/node"
+    }
+  },
+  {
+    "name": "Hudson",
+    "constant": "HUDSON",
+    "env": "HUDSON_URL"
+  },
+  {
+    "name": "Jenkins",
+    "constant": "JENKINS",
+    "env": [
+      "JENKINS_URL",
+      "BUILD_ID"
+    ],
+    "pr": {
+      "any": [
+        "ghprbPullId",
+        "CHANGE_ID"
+      ]
+    }
+  },
+  {
+    "name": "LayerCI",
+    "constant": "LAYERCI",
+    "env": "LAYERCI",
+    "pr": "LAYERCI_PULL_REQUEST"
+  },
+  {
+    "name": "Magnum CI",
+    "constant": "MAGNUM",
+    "env": "MAGNUM"
+  },
+  {
+    "name": "Netlify CI",
+    "constant": "NETLIFY",
+    "env": "NETLIFY",
+    "pr": {
+      "env": "PULL_REQUEST",
+      "ne": "false"
+    }
+  },
+  {
+    "name": "Nevercode",
+    "constant": "NEVERCODE",
+    "env": "NEVERCODE",
+    "pr": {
+      "env": "NEVERCODE_PULL_REQUEST",
+      "ne": "false"
+    }
+  },
+  {
+    "name": "Prow",
+    "constant": "PROW",
+    "env": "PROW_JOB_ID"
+  },
+  {
+    "name": "ReleaseHub",
+    "constant": "RELEASEHUB",
+    "env": "RELEASE_BUILD_ID"
+  },
+  {
+    "name": "Render",
+    "constant": "RENDER",
+    "env": "RENDER",
+    "pr": {
+      "IS_PULL_REQUEST": "true"
+    }
+  },
+  {
+    "name": "Sail CI",
+    "constant": "SAIL",
+    "env": "SAILCI",
+    "pr": "SAIL_PULL_REQUEST_NUMBER"
+  },
+  {
+    "name": "Screwdriver",
+    "constant": "SCREWDRIVER",
+    "env": "SCREWDRIVER",
+    "pr": {
+      "env": "SD_PULL_REQUEST",
+      "ne": "false"
+    }
+  },
+  {
+    "name": "Semaphore",
+    "constant": "SEMAPHORE",
+    "env": "SEMAPHORE",
+    "pr": "PULL_REQUEST_NUMBER"
+  },
+  {
+    "name": "Sourcehut",
+    "constant": "SOURCEHUT",
+    "env": {
+      "CI_NAME": "sourcehut"
+    }
+  },
+  {
+    "name": "Strider CD",
+    "constant": "STRIDER",
+    "env": "STRIDER"
+  },
+  {
+    "name": "TaskCluster",
+    "constant": "TASKCLUSTER",
+    "env": [
+      "TASK_ID",
+      "RUN_ID"
+    ]
+  },
+  {
+    "name": "TeamCity",
+    "constant": "TEAMCITY",
+    "env": "TEAMCITY_VERSION"
+  },
+  {
+    "name": "Travis CI",
+    "constant": "TRAVIS",
+    "env": "TRAVIS",
+    "pr": {
+      "env": "TRAVIS_PULL_REQUEST",
+      "ne": "false"
+    }
+  },
+  {
+    "name": "Vela",
+    "constant": "VELA",
+    "env": "VELA",
+    "pr": {
+      "VELA_PULL_REQUEST": "1"
+    }
+  },
+  {
+    "name": "Vercel",
+    "constant": "VERCEL",
+    "env": {
+      "any": [
+        "NOW_BUILDER",
+        "VERCEL"
+      ]
+    },
+    "pr": "VERCEL_GIT_PULL_REQUEST_ID"
+  },
+  {
+    "name": "Visual Studio App Center",
+    "constant": "APPCENTER",
+    "env": "APPCENTER_BUILD_ID"
+  },
+  {
+    "name": "Woodpecker",
+    "constant": "WOODPECKER",
+    "env": {
+      "CI": "woodpecker"
+    },
+    "pr": {
+      "CI_BUILD_EVENT": "pull_request"
+    }
+  },
+  {
+    "name": "Xcode Cloud",
+    "constant": "XCODE_CLOUD",
+    "env": "CI_XCODE_PROJECT",
+    "pr": "CI_PULL_REQUEST_NUMBER"
+  },
+  {
+    "name": "Xcode Server",
+    "constant": "XCODE_SERVER",
+    "env": "XCS"
+  }
+]

ci_info-0.4.0.dist-info/METADATA

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: ci-info
+Version: 0.4.0
+Summary: Continuous Integration Information
+Project-URL: Homepage, https://github.com/mgxd/ci-info
+Author-email: Mathias Goncalves <mathiasg@stanford.edu>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Provides-Extra: all
+Requires-Dist: pytest; extra == 'all'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Provides-Extra: tests
+Requires-Dist: pytest; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# 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)

ci_info-0.4.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+ci_info/__init__.py,sha256=MVEmulWNwlr1-riN2BC8m0c1vKyUEkWCT1vxIoU7jnM,2913
+ci_info/vendors.json,sha256=AyhjPdAKVzd3zEfB1XkK1JS-zJ80Nu1yO9Gmb2UV4AM,6424
+ci_info-0.4.0.dist-info/METADATA,sha256=sfhnF7pqYKw7bfpYVy7NL_t_YdBgos8Kw91wVFlfTzg,7199
+ci_info-0.4.0.dist-info/WHEEL,sha256=aha0VrrYvgDJ3Xxl3db_g_MDIW-ZexDdrc_m-Hk8YY4,105
+ci_info-0.4.0.dist-info/licenses/LICENSE,sha256=cJMF2XeQUFeyljkMpbf7_VcD8asbNuI93u1MXi1dTcA,1083
+ci_info-0.4.0.dist-info/RECORD,,

ci_info-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

ci_info-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mathias Goncalves
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.