cheerlights-api 0.1.0__tar.gz

cheerlights_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hans Scharler
+
+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.

cheerlights_api-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: cheerlights-api
+Version: 0.1.0
+Summary: A Python package to interact with the CheerLights API.
+Home-page: https://github.com/cheerlights/cheerlights-python-package
+Author: Hans Scharler
+Author-email: hscharler@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.1
+
+# CheerLights Python Package
+
+A Python package to interact with the CheerLights API. It allows users to get the current CheerLights color, retrieve the color history, and perform various color-related utilities.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install cheerlights-api
+```
+
+## Usage Examples
+
+```python
+import cheerlights-api
+
+# Get the current color name and hex code
+current_color = cheerlights.get_current_color()
+print(current_color)  # Example: {'color': 'red', 'hex': '#FF0000'}
+
+# Get the current color name
+color_name = cheerlights.get_current_color_name()
+print(color_name)  # Example: 'red'
+
+# Get the current hex code
+hex_code = cheerlights.get_current_hex()
+print(hex_code)  # Example: '#FF0000'
+
+# Get the history of colors
+history = cheerlights.get_color_history(5)
+for entry in history:
+    print(f"{entry['timestamp']}: {entry['color']} ({entry['hex']})")
+
+# Convert a color name to hex
+hex_code = cheerlights.color_name_to_hex('green')
+print(hex_code)  # '#00FF00'
+
+# Convert hex code to RGB
+rgb = cheerlights.hex_to_rgb('#00FF00')
+print(rgb)  # (0, 255, 0)
+
+# Check if a color is valid
+is_valid = cheerlights.is_valid_color('purple')
+print(is_valid)  # True
+```

cheerlights_api-0.1.0/README.md

@@ -0,0 +1,46 @@
+# CheerLights Python Package
+
+A Python package to interact with the CheerLights API. It allows users to get the current CheerLights color, retrieve the color history, and perform various color-related utilities.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install cheerlights-api
+```
+
+## Usage Examples
+
+```python
+import cheerlights-api
+
+# Get the current color name and hex code
+current_color = cheerlights.get_current_color()
+print(current_color)  # Example: {'color': 'red', 'hex': '#FF0000'}
+
+# Get the current color name
+color_name = cheerlights.get_current_color_name()
+print(color_name)  # Example: 'red'
+
+# Get the current hex code
+hex_code = cheerlights.get_current_hex()
+print(hex_code)  # Example: '#FF0000'
+
+# Get the history of colors
+history = cheerlights.get_color_history(5)
+for entry in history:
+    print(f"{entry['timestamp']}: {entry['color']} ({entry['hex']})")
+
+# Convert a color name to hex
+hex_code = cheerlights.color_name_to_hex('green')
+print(hex_code)  # '#00FF00'
+
+# Convert hex code to RGB
+rgb = cheerlights.hex_to_rgb('#00FF00')
+print(rgb)  # (0, 255, 0)
+
+# Check if a color is valid
+is_valid = cheerlights.is_valid_color('purple')
+print(is_valid)  # True
+```

cheerlights_api-0.1.0/cheerlights_api/__init__.py

@@ -0,0 +1,21 @@
+# cheerlights/__init__.py
+
+from .cheerlights_api import (
+    get_current_color,
+    get_current_hex,
+    get_current_color_name,
+    get_color_history,
+    color_name_to_hex,
+    hex_to_rgb,
+    is_valid_color,
+)
+
+__all__ = [
+    'get_current_color',
+    'get_current_hex',
+    'get_current_color_name',
+    'get_color_history',
+    'color_name_to_hex',
+    'hex_to_rgb',
+    'is_valid_color',
+]

cheerlights_api-0.1.0/cheerlights_api/cheerlights_api.py

@@ -0,0 +1,120 @@
+# cheerlights/cheerlights_api.py
+
+import requests
+
+CHEERLIGHTS_FEED_URL = "https://api.thingspeak.com/channels/1417/feed.json"
+
+def get_current_color():
+    """
+    Get the current CheerLights color name and hex code.
+
+    Returns:
+        dict: A dictionary with 'color' and 'hex' keys.
+    """
+    response = requests.get(CHEERLIGHTS_FEED_URL)
+    response.raise_for_status()
+    data = response.json()
+    color_name = data['feeds'][0]['field1']
+    hex_code = data['feeds'][0]['field2']
+
+    return {
+        'color': color_name,
+        'hex': hex_code
+    }
+
+def get_current_hex():
+    """
+    Get the current CheerLights hex color code.
+
+    Returns:
+        str: The hex code of the current CheerLights color.
+    """
+    return get_current_color()['hex']
+
+def get_current_color_name():
+    """
+    Get the current CheerLights color name.
+
+    Returns:
+        str: The name of the current CheerLights color.
+    """
+    return get_current_color()['color']
+
+def get_color_history(count=10):
+    """
+    Get the history of CheerLights colors.
+
+    Args:
+        count (int): The number of recent colors to retrieve.
+
+    Returns:
+        list: A list of dictionaries with 'color', 'hex', and 'timestamp'.
+    """
+    url = f"{CHEERLIGHTS_FEED_URL}?results={count}"
+    response = requests.get(url)
+    response.raise_for_status()
+    data = response.json()
+    feeds = data['feeds']
+    history = []
+    for entry in feeds:
+        history.append({
+            'color': entry['field1'],
+            'hex': entry['field2'],
+            'timestamp': entry['created_at']
+        })
+    return history
+
+def color_name_to_hex(color_name):
+    """
+    Convert a CheerLights color name to its hex code.
+
+    Args:
+        color_name (str): The name of the color.
+
+    Returns:
+        str or None: The hex code of the color or None if invalid.
+    """
+    color_map = {
+        'red': '#FF0000',
+        'green': '#00FF00',
+        'blue': '#0000FF',
+        'cyan': '#00FFFF',
+        'white': '#FFFFFF',
+        'warmwhite': '#FDF5E6',
+        'purple': '#800080',
+        'magenta': '#FF00FF',
+        'yellow': '#FFFF00',
+        'orange': '#FFA500',
+        'pink': '#FFC0CB',
+        'oldlace': '#FDF5E6',
+    }
+    return color_map.get(color_name.lower())
+
+def hex_to_rgb(hex_code):
+    """
+    Convert a hex color code to an RGB tuple.
+
+    Args:
+        hex_code (str): The hex color code.
+
+    Returns:
+        tuple: A tuple with (red, green, blue) values.
+    """
+    hex_code = hex_code.lstrip('#')
+    return tuple(int(hex_code[i:i+2], 16) for i in (0, 2 ,4))
+
+def is_valid_color(color_name):
+    """
+    Check if a color name is a valid CheerLights color.
+
+    Args:
+        color_name (str): The name of the color.
+
+    Returns:
+        bool: True if valid, False otherwise.
+    """
+    valid_colors = [
+        'red', 'green', 'blue', 'cyan', 'white', 'warmwhite',
+        'purple', 'magenta', 'yellow', 'orange', 'pink', 'oldlace'
+    ]
+    return color_name.lower() in valid_colors

cheerlights_api-0.1.0/cheerlights_api.egg-info/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: cheerlights-api
+Version: 0.1.0
+Summary: A Python package to interact with the CheerLights API.
+Home-page: https://github.com/cheerlights/cheerlights-python-package
+Author: Hans Scharler
+Author-email: hscharler@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.1
+
+# CheerLights Python Package
+
+A Python package to interact with the CheerLights API. It allows users to get the current CheerLights color, retrieve the color history, and perform various color-related utilities.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install cheerlights-api
+```
+
+## Usage Examples
+
+```python
+import cheerlights-api
+
+# Get the current color name and hex code
+current_color = cheerlights.get_current_color()
+print(current_color)  # Example: {'color': 'red', 'hex': '#FF0000'}
+
+# Get the current color name
+color_name = cheerlights.get_current_color_name()
+print(color_name)  # Example: 'red'
+
+# Get the current hex code
+hex_code = cheerlights.get_current_hex()
+print(hex_code)  # Example: '#FF0000'
+
+# Get the history of colors
+history = cheerlights.get_color_history(5)
+for entry in history:
+    print(f"{entry['timestamp']}: {entry['color']} ({entry['hex']})")
+
+# Convert a color name to hex
+hex_code = cheerlights.color_name_to_hex('green')
+print(hex_code)  # '#00FF00'
+
+# Convert hex code to RGB
+rgb = cheerlights.hex_to_rgb('#00FF00')
+print(rgb)  # (0, 255, 0)
+
+# Check if a color is valid
+is_valid = cheerlights.is_valid_color('purple')
+print(is_valid)  # True
+```

cheerlights_api-0.1.0/cheerlights_api.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+cheerlights_api/__init__.py
+cheerlights_api/cheerlights_api.py
+cheerlights_api.egg-info/PKG-INFO
+cheerlights_api.egg-info/SOURCES.txt
+cheerlights_api.egg-info/dependency_links.txt
+cheerlights_api.egg-info/requires.txt
+cheerlights_api.egg-info/top_level.txt
+tests/tests_cheerlights_api.py

cheerlights_api-0.1.0/cheerlights_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cheerlights_api-0.1.0/cheerlights_api.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.25.1

cheerlights_api-0.1.0/cheerlights_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+cheerlights_api

cheerlights_api-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"

cheerlights_api-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cheerlights_api-0.1.0/setup.py

@@ -0,0 +1,25 @@
+# setup.py
+
+from setuptools import setup, find_packages
+
+setup(
+    name='cheerlights-api',
+    version='0.1.0',
+    description='A Python package to interact with the CheerLights API.',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    author='Hans Scharler',
+    author_email='hscharler@gmail.com',
+    url='https://github.com/cheerlights/cheerlights-python-package',
+    license='MIT',
+    packages=find_packages(),
+    install_requires=[
+        'requests>=2.25.1',
+    ],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

cheerlights_api-0.1.0/tests/tests_cheerlights_api.py

@@ -0,0 +1,50 @@
+# tests/test_cheerlights_api.py
+
+import unittest
+from cheerlights_api import (
+    get_current_color,
+    get_current_hex,
+    get_current_color_name,
+    get_color_history,
+    color_name_to_hex,
+    hex_to_rgb,
+    is_valid_color,
+)
+
+class TestCheerLights(unittest.TestCase):
+
+    def test_get_current_color(self):
+        color_info = get_current_color()
+        self.assertIn('color', color_info)
+        self.assertIn('hex', color_info)
+
+    def test_get_current_hex(self):
+        hex_code = get_current_hex()
+        self.assertTrue(hex_code.startswith('#'))
+
+    def test_get_current_color_name(self):
+        color_name = get_current_color_name()
+        self.assertIsInstance(color_name, str)
+
+    def test_get_color_history(self):
+        history = get_color_history(5)
+        self.assertEqual(len(history), 5)
+        for entry in history:
+            self.assertIn('color', entry)
+            self.assertIn('hex', entry)
+            self.assertIn('timestamp', entry)
+
+    def test_color_name_to_hex(self):
+        hex_code = color_name_to_hex('red')
+        self.assertEqual(hex_code, '#FF0000')
+
+    def test_hex_to_rgb(self):
+        rgb = hex_to_rgb('#FF0000')
+        self.assertEqual(rgb, (255, 0, 0))
+
+    def test_is_valid_color(self):
+        self.assertTrue(is_valid_color('blue'))
+        self.assertFalse(is_valid_color('black'))
+
+if __name__ == '__main__':
+    unittest.main()