pipeglow

Name	pipeglow JSON
Version	0.0.975 JSON
	download
home_page	None
Summary	✨ Change smart lights based on CI pipeline status
upload_time	2025-02-03 02:48:05
maintainer	None
docs_url	None
author	Brie Carranza
requires_python	>=3.9
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 🚀 pipeglow
> Visualize CI pipeline status with smart lights

## 🗺️ Overview

`pipeglow` updates your smart lights to provide real-time visual feedback about your CI pipeline status. By automatically changing light colors based on pipeline states, you get immediate visual notifications about how your builds and deployments are going.

## 🛠️ Installation

```bash
pip install pipeglow
```

## 📋 Configuration

Create a `.env` file with the following environment variables:

```bash
GOVEE_API_KEY=your_api_key_here
GOVEE_DEVICE_ID=your_device_id
GOVEE_DEVICE_MODEL=your_device_model
GITLAB_API_TOKEN=your_gitlab_token
GITLAB_PROJECT_ID=your_project_id
```

## ✨ Features

### 🌈 Pipeline Status Colors

Each pipeline state is represented by a distinct color:
- 💛 Preparing/Pending: Yellow (`#9F9110`)
- 💗 Waiting: Pink (`#DC6BAD`)
- 💙 Running: Blue (`#3974C6`)
- 💚 Success: Green (`#309508`)
- ❌ Failed: Red (`#FF0000`)
- ⚫ Canceled/Skipped: Dark Gray (`#212121`)

### 🌞 Dynamic Brightness

Light brightness automatically adjusts based on pipeline update recency:
- Recent updates appear brighter
- Brightness gradually dims as updates age
- Provides intuitive temporal feedback

### 🦊 GitLab Integration

There is support for checking any GitLab instance (`.com`, self-managed or GitLab Dedicated). By default, `pipeglow` assumes `gitlab.com`.

### 💡 Lighting Integration

Today, `pipeglow` works with Govee lights. You will need a [Govee API key](https://developer.govee.com/reference/apply-you-govee-api-key) in order to use `pipeglow`. You will need to run `pipeglow` on a machine with access to the Internet so that it can communicate with the Govee API.

## 🚀 Usage

This will cause `pipeglow` to check the project you specified in `.env` and update the light specified in `.env` accordingly. (Alternately, you can set the items specified in `.env` as environment variables.)

```bash
pipeglow change_the_lights
```

Specify a different GitLab URL:

```bash
pipeglow change_the_lights --gitlab-url https://gitlab.example.com
```

```bash
uvx pipeglow change_the_lights
```

Run a command like this in a loop to check and update the lights once every 15 seconds:

```bash
while true; do
    uvx pipeglow change_the_lights
    sleep 15
done
```

Alternately, you can use `set_the_lights` to set the lights based on a pipeline status. This is useful if you have a webhook trigger `pipeglow`.

```
uvx pipeglow set_the_lights success
```

``` 
# pipeglow set_the_lights  --light-status running
🚀 Just set the lights to running please!
🏆 The light has been updated!
```


## 📄 License

MIT License

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pipeglow",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Brie Carranza",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/f2/57/6c6cba108d2a3e73fc8f141b75cf32a2a1405b22a6d53c24a7e5343468d9/pipeglow-0.0.975.tar.gz",
    "platform": null,
    "description": "# \ud83d\ude80 pipeglow\n> Visualize CI pipeline status with smart lights\n\n## \ud83d\uddfa\ufe0f Overview\n\n`pipeglow` updates your smart lights to provide real-time visual feedback about your CI pipeline status. By automatically changing light colors based on pipeline states, you get immediate visual notifications about how your builds and deployments are going.\n\n## \ud83d\udee0\ufe0f Installation\n\n```bash\npip install pipeglow\n```\n\n## \ud83d\udccb Configuration\n\nCreate a `.env` file with the following environment variables:\n\n```bash\nGOVEE_API_KEY=your_api_key_here\nGOVEE_DEVICE_ID=your_device_id\nGOVEE_DEVICE_MODEL=your_device_model\nGITLAB_API_TOKEN=your_gitlab_token\nGITLAB_PROJECT_ID=your_project_id\n```\n\n## \u2728 Features\n\n### \ud83c\udf08 Pipeline Status Colors\n\nEach pipeline state is represented by a distinct color:\n- \ud83d\udc9b Preparing/Pending: Yellow (`#9F9110`)\n- \ud83d\udc97 Waiting: Pink (`#DC6BAD`)\n- \ud83d\udc99 Running: Blue (`#3974C6`)\n- \ud83d\udc9a Success: Green (`#309508`)\n- \u274c Failed: Red (`#FF0000`)\n- \u26ab Canceled/Skipped: Dark Gray (`#212121`)\n\n### \ud83c\udf1e Dynamic Brightness\n\nLight brightness automatically adjusts based on pipeline update recency:\n- Recent updates appear brighter\n- Brightness gradually dims as updates age\n- Provides intuitive temporal feedback\n\n### \ud83e\udd8a GitLab Integration\n\nThere is support for checking any GitLab instance (`.com`, self-managed or GitLab Dedicated). By default, `pipeglow` assumes `gitlab.com`.\n\n### \ud83d\udca1 Lighting Integration\n\nToday, `pipeglow` works with Govee lights. You will need a [Govee API key](https://developer.govee.com/reference/apply-you-govee-api-key) in order to use `pipeglow`. You will need to run `pipeglow` on a machine with access to the Internet so that it can communicate with the Govee API.\n\n## \ud83d\ude80 Usage\n\nThis will cause `pipeglow` to check the project you specified in `.env` and update the light specified in `.env` accordingly. (Alternately, you can set the items specified in `.env` as environment variables.)\n\n```bash\npipeglow change_the_lights\n```\n\nSpecify a different GitLab URL:\n\n```bash\npipeglow change_the_lights --gitlab-url https://gitlab.example.com\n```\n\n```bash\nuvx pipeglow change_the_lights\n```\n\nRun a command like this in a loop to check and update the lights once every 15 seconds:\n\n```bash\nwhile true; do\n    uvx pipeglow change_the_lights\n    sleep 15\ndone\n```\n\nAlternately, you can use `set_the_lights` to set the lights based on a pipeline status. This is useful if you have a webhook trigger `pipeglow`.\n\n```\nuvx pipeglow set_the_lights success\n```\n\n``` \n# pipeglow set_the_lights  --light-status running\n\ud83d\ude80 Just set the lights to running please!\n\ud83c\udfc6 The light has been updated!\n```\n\n\n## \ud83d\udcc4 License\n\nMIT License\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "\u2728 Change smart lights based on CI pipeline status",
    "version": "0.0.975",
    "project_urls": {
        "Homepage": "https://gitlab.com/brie/pipeglow"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "50c30bbe6c97f987095b1f62df4d4a36e0e95018a8f1d804b15e94602b39a7e5",
                "md5": "6385351360573581f0de6c5b43c41ac0",
                "sha256": "9e0ae1595418dd7d4f66190e36f8c8a7a01f09a6f322ea992be0dc943e735731"
            },
            "downloads": -1,
            "filename": "pipeglow-0.0.975-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6385351360573581f0de6c5b43c41ac0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 8310,
            "upload_time": "2025-02-03T02:48:04",
            "upload_time_iso_8601": "2025-02-03T02:48:04.793677Z",
            "url": "https://files.pythonhosted.org/packages/50/c3/0bbe6c97f987095b1f62df4d4a36e0e95018a8f1d804b15e94602b39a7e5/pipeglow-0.0.975-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f2576c6cba108d2a3e73fc8f141b75cf32a2a1405b22a6d53c24a7e5343468d9",
                "md5": "48a3545cf4ffff54c328febffe86f8d5",
                "sha256": "4bcad5aa5e00810ca7215d3c52f8068071e0c3f4ea6f274a6f5a2f7e8f807c09"
            },
            "downloads": -1,
            "filename": "pipeglow-0.0.975.tar.gz",
            "has_sig": false,
            "md5_digest": "48a3545cf4ffff54c328febffe86f8d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 8495,
            "upload_time": "2025-02-03T02:48:05",
            "upload_time_iso_8601": "2025-02-03T02:48:05.823486Z",
            "url": "https://files.pythonhosted.org/packages/f2/57/6c6cba108d2a3e73fc8f141b75cf32a2a1405b22a6d53c24a7e5343468d9/pipeglow-0.0.975.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-03 02:48:05",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "brie",
    "gitlab_project": "pipeglow",
    "lcname": "pipeglow"
}