ci-info 0.3.0__tar.gz → 0.4.0__tar.gz

ci_info-0.4.0/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2.1
+
+jobs:
+  test:
+    docker:
+    - image: cimg/python:3.14
+    steps:
+    - checkout
+    - run:
+        name: Install ci-info (+ pytest)
+        command: |
+          uv sync --all-extras --dev
+    - run:
+        name: Run test
+        command: |
+          uv run pytest tests/
+
+workflows:
+  version: 2
+  test:
+    jobs:
+    - test

ci_info-0.4.0/.github/dependabot.yml

@@ -0,0 +1,9 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    # Check for updates to GitHub Actions every week
+    interval: "weekly"

ci_info-0.4.0/.github/workflows/test.yml

@@ -0,0 +1,84 @@
+name: Build Test and Publish
+
+on:
+  push:
+    branches:
+    - master
+    tags:
+    - '*'
+  pull_request:
+    branches:
+    - master
+  workflow_dispatch:
+
+
+defaults:
+  run:
+    shell: bash
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+    - name: Install the latest version of uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        python-version: 3
+    - name: Build
+      run: uv build
+    - name: Upload sdist and wheel artifacts
+      uses: actions/upload-artifact@v6
+      with:
+        name: dist
+        path: dist/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python:
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        - "3.13"
+        - "3.14"
+        - "3.15"
+    steps:
+    - uses: actions/checkout@v6
+    - name: Install the latest version of uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        python-version: ${{ matrix.python }}
+    - name: Install ci-info
+      run: uv sync --all-extras --dev
+    - name: Test ci-info
+      run: uv run pytest tests/
+
+  publish:
+    needs: [ build, test ]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ci-info/
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+    - uses: actions/checkout@v6
+    - uses: actions/download-artifact@v7
+      with:
+        name: dist
+        path: dist/
+    - name: Distribute to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

ci_info-0.4.0/.gitignore

@@ -0,0 +1,8 @@
+*.pyc
+.vscode/
+.pytest_cache/
+*egg-info
+__pycache__
+.venv
+.ruff_cache
+uv.lock

ci_info-0.4.0/.travis.yml

@@ -0,0 +1,13 @@
+# vim ft=yaml
+language: python
+python:
+  - 3.5
+  - 3.6
+  - 3.7
+  - 3.8
+
+install:
+  - pip install -e .[test]
+
+script:
+  - pytest -v --doctest-modules ci_info/tests/test_travis.py

ci_info-0.4.0/CHANGES.md

@@ -0,0 +1,29 @@
+0.4.0 (February 2, 2026)
+========================
+- Enable is_pr detection for AWS CodeBuild, Appcircle, and Vercel
+- Add new CI providers:
+    Agola CI, Cloudflare Pages, Cloudflare Workers, Earthly CI,
+    Gerrit CI, Gitea Actions, Google Cloud Build, Harness CI,
+    Heroku, Prow, ReleaseHub, Sourcehut, Vela, and Woodpecker
+
+0.3.0 (July 27, 2022)
+=====================
+Adds CI detection for:
+
+-Appcircle
+-Codefresh
+-Expo Application Services
+-Github Actions
+-LayerCI
+-Render
+-Screwdriver
+-Vercel
+-Visual Studio App Center
+
+Additionally, drops support for Python 3.5 and 3.6, as they are now EOL.
+
+0.2.0 (April 16, 2020)
+======================
+
+- Renamed package import to `ci_info`
+- Added tests for Circle CI.

{ci-info-0.3.0/ci_info.egg-info → ci_info-0.4.0}/PKG-INFO

@@ -1,25 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ci-info
-Version: 0.3.0
+Version: 0.4.0
 Summary: Continuous Integration Information
-Home-page: https://github.com/mgxd/ci-info
-Author: Mathias Goncalves
-Author-email: mathiasg@mit.edu
+Project-URL: Homepage, https://github.com/mgxd/ci-info
+Author-email: Mathias Goncalves <mathiasg@stanford.edu>
 License: MIT
-Classifier: Development Status :: 3 - Alpha
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Provides: ci_info
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+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
-Provides-Extra: all
-License-File: LICENSE
+Requires-Dist: pytest; extra == 'tests'
+Description-Content-Type: text/markdown
 
 # ci-info
 
@@ -39,10 +36,11 @@ Officially supported CI servers:
 
 | Name                                                                            | isPR |
 | ------------------------------------------------------------------------------- | ---- |
-| [AWS CodeBuild](https://aws.amazon.com/codebuild/)                              | 🚫   |
+| [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/) | ✅   |
-| [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/)                                              | ✅   |
@@ -50,32 +48,45 @@ Officially supported CI servers:
 | [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)                                               | ✅   |
-| [Vercel](https://vercel.com/)                                                   | 🚫   |
+| [Vela](https://go-vela.github.io/docs/)                                         | ✅   |
+| [Vercel](https://vercel.com/)                                                   | ✅   |
 | [Visual Studio App Center](https://appcenter.ms/)                               | 🚫   |
+| [Woodpecker](https://woodpecker-ci.org/)                                        | ✅   |
 
 
 ## Installation

{ci-info-0.3.0 → ci_info-0.4.0}/README.md

@@ -16,10 +16,11 @@ Officially supported CI servers:
 
 | Name                                                                            | isPR |
 | ------------------------------------------------------------------------------- | ---- |
-| [AWS CodeBuild](https://aws.amazon.com/codebuild/)                              | 🚫   |
+| [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/) | ✅   |
-| [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/)                                              | ✅   |
@@ -27,32 +28,45 @@ Officially supported CI servers:
 | [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)                                               | ✅   |
-| [Vercel](https://vercel.com/)                                                   | 🚫   |
+| [Vela](https://go-vela.github.io/docs/)                                         | ✅   |
+| [Vercel](https://vercel.com/)                                                   | ✅   |
 | [Visual Studio App Center](https://appcenter.ms/)                               | 🚫   |
+| [Woodpecker](https://woodpecker-ci.org/)                                        | ✅   |
 
 
 ## Installation

ci_info-0.4.0/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),
+    }