pipelight

Name	pipelight JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	✨ Change smart lights based on CI pipeline status
upload_time	2025-01-25 05:52:52
maintainer	None
docs_url	None
author	Brie Carranza
requires_python	>=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 🚀 ✨ 🤖 💡 Pipelight

> Visualize CI pipeline status with smart lights

## 🗺️ Overview

With `pipelight`, your smart lights are automatically updated to reflect the status of the latest pipeline.

## 🛠️ Installation

```bash
pip install pipelight
```

## 📋 Configuration

Set these environment variables in `.env`:

```bash
GOVEE_API_KEY=goveetokenwouldgohere
GOVEE_DEVICE_ID=77:00:00:00:00:00:00:00
GOVEE_DEVICE_MODEL=HXXXX
GITLAB_API_TOKEN=glpatWOULDGOHERE
GITLAB_PROJECT_ID=0123456
```

## ✨ Features

### 🌈 Pipeline Status Colors

- 💛 Yellow (`#9F9110`): Created, Preparing, Pending
- 💗 Pink (`#DC6BAD`): Waiting for Resources
- 💙 Blue (`#3974C6`): Running
- 💚 Green (`#309508`): Success
- 💔 Red (`#FF0000`): Failed
- 🖤 Dark Gray (`#212121`): Canceled, Skipped

### 🌞 Adaptive Brightness

The brightness of the light changes based on how recently the pipeline was updated. More recent pipelines have a brighter color. The brightness progressively fades as the pipeline's `updated_at` value is less recent.

### 🦊 GitLab

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

## 🚀 Usage

Run the main command:

```bash
pipelight change-the-lights
```

Customize GitLab instance:

```bash
pipelight change-the-lights --gitlab-url https://gitlab.example.com
```

Use `uv`:

```bash
uv run --with emoji,python-dotenv,python-gitlab python -m pipelight change_the_lights
```

Run in a loop to continuously monitor a project's pipelines as you work:

```bash
while true ; do date ; uv run --with emoji,python-dotenv,python-gitlab python -m pipelight change_the_lights ; sleep 15 ; done
```

## 🚀 Publishing

```toml
[[tool.uv.index]]
name = "testpypi"
url = "https://test.pypi.org/simple/"
publish-url = "https://test.pypi.org/legacy/"
```

## 📄 License

MIT License

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pipelight",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Brie Carranza",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/3c/cc/3ffc5adfecc6c19f7675aa1867cd134f65534c50e432e01ab9e5c48ba0e5/pipelight-0.1.0.tar.gz",
    "platform": null,
    "description": "# \ud83d\ude80 \u2728 \ud83e\udd16 \ud83d\udca1 Pipelight\n\n> Visualize CI pipeline status with smart lights\n\n## \ud83d\uddfa\ufe0f Overview\n\nWith `pipelight`, your smart lights are automatically updated to reflect the status of the latest pipeline.\n\n## \ud83d\udee0\ufe0f Installation\n\n```bash\npip install pipelight\n```\n\n## \ud83d\udccb Configuration\n\nSet these environment variables in `.env`:\n\n```bash\nGOVEE_API_KEY=goveetokenwouldgohere\nGOVEE_DEVICE_ID=77:00:00:00:00:00:00:00\nGOVEE_DEVICE_MODEL=HXXXX\nGITLAB_API_TOKEN=glpatWOULDGOHERE\nGITLAB_PROJECT_ID=0123456\n```\n\n## \u2728 Features\n\n### \ud83c\udf08 Pipeline Status Colors\n\n- \ud83d\udc9b Yellow (`#9F9110`): Created, Preparing, Pending\n- \ud83d\udc97 Pink (`#DC6BAD`): Waiting for Resources\n- \ud83d\udc99 Blue (`#3974C6`): Running\n- \ud83d\udc9a Green (`#309508`): Success\n- \ud83d\udc94 Red (`#FF0000`): Failed\n- \ud83d\udda4 Dark Gray (`#212121`): Canceled, Skipped\n\n### \ud83c\udf1e Adaptive Brightness\n\nThe brightness of the light changes based on how recently the pipeline was updated. More recent pipelines have a brighter color. The brightness progressively fades as the pipeline's `updated_at` value is less recent.\n\n### \ud83e\udd8a GitLab\n\nThere is support for checking any GitLab instance (`.com`, self-managed or GitLab Dedicated). By default, `pipelight` assumes `gitlab.com`.\n\n## \ud83d\ude80 Usage\n\nRun the main command:\n\n```bash\npipelight change-the-lights\n```\n\nCustomize GitLab instance:\n\n```bash\npipelight change-the-lights --gitlab-url https://gitlab.example.com\n```\n\nUse `uv`:\n\n```bash\nuv run --with emoji,python-dotenv,python-gitlab python -m pipelight change_the_lights\n```\n\nRun in a loop to continuously monitor a project's pipelines as you work:\n\n```bash\nwhile true ; do date ; uv run --with emoji,python-dotenv,python-gitlab python -m pipelight change_the_lights ; sleep 15 ; done\n```\n\n## \ud83d\ude80 Publishing\n\n```toml\n[[tool.uv.index]]\nname = \"testpypi\"\nurl = \"https://test.pypi.org/simple/\"\npublish-url = \"https://test.pypi.org/legacy/\"\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.1.0",
    "project_urls": {
        "Changelog": "https://gitlab.com/brie/pipelight/releases",
        "Homepage": "https://pipelight.brie.dev",
        "Issues": "https://github.com/bbbbbrie/pipelight/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "caf5aa81f23a03293c77458ff3bf4aa6de9269c321e6c36cacf28539bbe96245",
                "md5": "c340bb82966af6542ed3e5d53d111746",
                "sha256": "ba90b61edb590bed1586ea666151bdad4d9cfd159d0eb441046b7074a646c6e6"
            },
            "downloads": -1,
            "filename": "pipelight-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c340bb82966af6542ed3e5d53d111746",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7185,
            "upload_time": "2025-01-25T05:52:51",
            "upload_time_iso_8601": "2025-01-25T05:52:51.481613Z",
            "url": "https://files.pythonhosted.org/packages/ca/f5/aa81f23a03293c77458ff3bf4aa6de9269c321e6c36cacf28539bbe96245/pipelight-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3ccc3ffc5adfecc6c19f7675aa1867cd134f65534c50e432e01ab9e5c48ba0e5",
                "md5": "dc14c8133c014480dc48e0cb1d2259ed",
                "sha256": "2b57e69072d4bcb9282c7fabf37c1f50ba01476c214aaad6c57f1f0176fd0dff"
            },
            "downloads": -1,
            "filename": "pipelight-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "dc14c8133c014480dc48e0cb1d2259ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6760,
            "upload_time": "2025-01-25T05:52:52",
            "upload_time_iso_8601": "2025-01-25T05:52:52.676883Z",
            "url": "https://files.pythonhosted.org/packages/3c/cc/3ffc5adfecc6c19f7675aa1867cd134f65534c50e432e01ab9e5c48ba0e5/pipelight-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-25 05:52:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bbbbbrie",
    "github_project": "pipelight",
    "github_not_found": true,
    "lcname": "pipelight"
}