| Name | clifx JSON |
| Version |
1.1.0rc0
JSON |
| download |
| home_page | |
| Summary | Cross-platform CLI for LIFX devices |
| upload_time | 2023-03-10 16:25:50 |
| maintainer | |
| docs_url | None |
| author | DrTexx |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
lifx
iot
cli
smarthome
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CLIFX <!-- omit in toc -->
Cross-platform CLI for LIFX devices
## Table of Contents <!-- omit in toc -->
- [Installation](#installation)
- [Usage](#usage)
- [Interactive](#interactive)
- [Examples](#examples)
- [Options](#options)
- [Script Template](#script-template)
- [Windows](#windows)
- [Linux/Mac](#linuxmac)
- [Development](#development)
- [Installation](#installation-1)
- [Usage](#usage-1)
- [Build](#build)
- [Contributing](#contributing)
- [Links](#links)
## Installation
```bash
pip install clifx
```
## Usage
### Interactive
```bash
clifx # interactive prompt - specify device and new hue, saturation, brightness and colour temp
```
### Examples
```bash
# set the device labelled 'Strip' to...
clifx -l Strip -h 50 -s 50 -v 50 -k 6500 # soft cyan with a daylight colour temp
clifx -l Strip -h 0 -s 100 -v 100 -k 6500 # pure red at 100% brightness
```
### Options
```bash
clifx --help # display help
```
## Script Template
### Windows
_Contents of `<your-preset>.ps1`_
```powershell
# TODO
```
### Linux/Mac
_Contents of `<your-preset>.sh`:_
```sh
#!/bin/bash
clifx -l <device-label> -h <hue> -s <saturation> -v <value> -k <kelvin>
```
## Development
### Installation
```bash
git clone https://gitlab.com/DrTexx/CLIFX/
cd CLIFX
poetry install
```
### Usage
Identical to typical usage except commands must be prefixed by `poetry run`.
For example, instead of writing the following:
```bash
clifx
```
You would write this:
```bash
poetry run clifx
```
### Build
```bash
./development-scripts/build.sh
```
## Contributing
[Issues](https://gitlab.com/DrTexx/CLIFX/-/issues) and [pull requests](https://gitlab.com/DrTexx/CLIFX/-/merge_requests/new) welcome!
## Links
<!-- TODO: add Website link -->
- Documentation: https://gitlab.com/DrTexx/CLIFX#clifx
- PyPI Releases: https://pypi.org/project/clifx
- Source Code: https://gitlab.com/DrTexx/CLIFX/
- Issue Tracker: https://gitlab.com/DrTexx/CLIFX/-/issues
- Twitter: [@DrTexx](https://twitter.com/DrTexx)
- Email: [denver.opensource@tutanota.com](mailto:denver.opensource@tutanota.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "clifx",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "lifx,iot,cli,smarthome",
"author": "DrTexx",
"author_email": "3269230-DrTexx@users.noreply.gitlab.com",
"download_url": "https://files.pythonhosted.org/packages/a3/8f/f0e615cac5f3e2c3c75bf723f7faab55d542cb17234f383d26bcb359f4e6/clifx-1.1.0rc0.tar.gz",
"platform": null,
"description": "# CLIFX <!-- omit in toc -->\n\nCross-platform CLI for LIFX devices\n\n\n\n## Table of Contents <!-- omit in toc -->\n- [Installation](#installation)\n- [Usage](#usage)\n - [Interactive](#interactive)\n - [Examples](#examples)\n - [Options](#options)\n- [Script Template](#script-template)\n - [Windows](#windows)\n - [Linux/Mac](#linuxmac)\n- [Development](#development)\n - [Installation](#installation-1)\n - [Usage](#usage-1)\n - [Build](#build)\n- [Contributing](#contributing)\n- [Links](#links)\n\n## Installation\n\n```bash\npip install clifx\n```\n\n## Usage\n\n### Interactive\n\n```bash\nclifx # interactive prompt - specify device and new hue, saturation, brightness and colour temp\n```\n\n### Examples\n\n```bash\n# set the device labelled 'Strip' to...\nclifx -l Strip -h 50 -s 50 -v 50 -k 6500 # soft cyan with a daylight colour temp\nclifx -l Strip -h 0 -s 100 -v 100 -k 6500 # pure red at 100% brightness\n```\n\n### Options\n```bash\nclifx --help # display help\n```\n\n## Script Template\n\n### Windows\n\n_Contents of `<your-preset>.ps1`_\n\n```powershell\n# TODO\n```\n\n### Linux/Mac\n\n_Contents of `<your-preset>.sh`:_\n\n```sh\n#!/bin/bash\nclifx -l <device-label> -h <hue> -s <saturation> -v <value> -k <kelvin>\n```\n\n## Development\n\n### Installation\n\n```bash\ngit clone https://gitlab.com/DrTexx/CLIFX/\ncd CLIFX\npoetry install\n```\n\n### Usage\n\nIdentical to typical usage except commands must be prefixed by `poetry run`.\n\nFor example, instead of writing the following:\n\n```bash\nclifx\n```\n\nYou would write this:\n\n```bash\npoetry run clifx\n```\n\n### Build\n\n```bash\n./development-scripts/build.sh\n```\n\n## Contributing\n\n[Issues](https://gitlab.com/DrTexx/CLIFX/-/issues) and [pull requests](https://gitlab.com/DrTexx/CLIFX/-/merge_requests/new) welcome!\n\n## Links\n\n<!-- TODO: add Website link -->\n- Documentation: https://gitlab.com/DrTexx/CLIFX#clifx\n- PyPI Releases: https://pypi.org/project/clifx\n- Source Code: https://gitlab.com/DrTexx/CLIFX/\n- Issue Tracker: https://gitlab.com/DrTexx/CLIFX/-/issues\n- Twitter: [@DrTexx](https://twitter.com/DrTexx)\n- Email: [denver.opensource@tutanota.com](mailto:denver.opensource@tutanota.com)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cross-platform CLI for LIFX devices",
"version": "1.1.0rc0",
"split_keywords": [
"lifx",
"iot",
"cli",
"smarthome"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db72f467d7e5bfd531dbb6283dc1efd4a4ed10114058d06f28c8bb3ef1d82792",
"md5": "d4fe19b3507265a4a85ad270cac827b8",
"sha256": "fdecec53c1d9365add7fae3fe6e27829f686835bc77487fe3a70203d69eae3d9"
},
"downloads": -1,
"filename": "clifx-1.1.0rc0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4fe19b3507265a4a85ad270cac827b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 5314,
"upload_time": "2023-03-10T16:25:48",
"upload_time_iso_8601": "2023-03-10T16:25:48.704147Z",
"url": "https://files.pythonhosted.org/packages/db/72/f467d7e5bfd531dbb6283dc1efd4a4ed10114058d06f28c8bb3ef1d82792/clifx-1.1.0rc0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a38ff0e615cac5f3e2c3c75bf723f7faab55d542cb17234f383d26bcb359f4e6",
"md5": "9d377f90196c84e33e42e82af894358c",
"sha256": "91579c95d173f678f23d458649bae7e7f90393d2bcd75f53c76e614db45a771e"
},
"downloads": -1,
"filename": "clifx-1.1.0rc0.tar.gz",
"has_sig": false,
"md5_digest": "9d377f90196c84e33e42e82af894358c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4202,
"upload_time": "2023-03-10T16:25:50",
"upload_time_iso_8601": "2023-03-10T16:25:50.956783Z",
"url": "https://files.pythonhosted.org/packages/a3/8f/f0e615cac5f3e2c3c75bf723f7faab55d542cb17234f383d26bcb359f4e6/clifx-1.1.0rc0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-10 16:25:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "clifx"
}
