kiosker-python-api 1.2.2__tar.gz → 1.2.4__tar.gz

kiosker_python_api-1.2.4/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

{kiosker_python_api-1.2.2 → kiosker_python_api-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiosker-python-api
-Version: 1.2.2
+Version: 1.2.4
 Summary: A python wrapper for the Kiosker API
 Project-URL: Homepage, https://kiosker.io
 Project-URL: Documentation, https://docs.kiosker.io
@@ -23,7 +23,7 @@ Python wrapper for Kiosker API-integration.
 ### Installation
 
 ```shell
-pip3 install kiosker-python
+pip install kiosker-python-api
 ```
 
 ---
@@ -31,7 +31,12 @@ pip3 install kiosker-python
 ### Setup
 
 ```python
-from kiosker.api import KioskerAPI
+KioskerAPI(host, token, port = 8081, ssl = False)
+```
+
+```python
+from kiosker import KioskerAPI
+from kiosker import Status, Result, Blackout, ScreensaverState
 api = KioskerAPI('10.0.1.100', 'token')
 ```
 
@@ -51,6 +56,8 @@ print(f'Battery level: {status.battery_level}%')
 print(f'Battery state: {status.battery_state}')
 print(f'Last interaction: {status.last_interaction}')
 print(f'Last motion: {status.last_motion}')
+print(f'App name: {status.app_name}')
+print(f'App version: {status.app_version}')
 print(f'Last status update: {status.last_update}')
 ```
 **Description**: Retrieves the current status of the kiosk.
@@ -141,7 +148,7 @@ print(f"Screensaver state: {state}")
 
 #### Set Blackout
 ```python
-from kiosker.data import Blackout
+from kiosker import Blackout
 
 blackout = Blackout(
     visible=True,                   # Required: show blackout screen
@@ -250,7 +257,7 @@ HOST="0.0.0.0" TOKEN="" pytest -s
 
 6. Build the library
 ```shell
-python -m build --wheel
+python -m build
 ```
 
 7. Upload to test
@@ -258,6 +265,11 @@ python -m build --wheel
 twine upload --repository testpypi dist/*
 ```
 
+7. Upload to prod
+```shell
+twine upload dist/*
+```
+
 ---
 
 ### API Documentation

{kiosker_python_api-1.2.2 → kiosker_python_api-1.2.4}/README.md

@@ -6,7 +6,7 @@ Python wrapper for Kiosker API-integration.
 ### Installation
 
 ```shell
-pip3 install kiosker-python
+pip install kiosker-python-api
 ```
 
 ---
@@ -14,7 +14,12 @@ pip3 install kiosker-python
 ### Setup
 
 ```python
-from kiosker.api import KioskerAPI
+KioskerAPI(host, token, port = 8081, ssl = False)
+```
+
+```python
+from kiosker import KioskerAPI
+from kiosker import Status, Result, Blackout, ScreensaverState
 api = KioskerAPI('10.0.1.100', 'token')
 ```
 
@@ -34,6 +39,8 @@ print(f'Battery level: {status.battery_level}%')
 print(f'Battery state: {status.battery_state}')
 print(f'Last interaction: {status.last_interaction}')
 print(f'Last motion: {status.last_motion}')
+print(f'App name: {status.app_name}')
+print(f'App version: {status.app_version}')
 print(f'Last status update: {status.last_update}')
 ```
 **Description**: Retrieves the current status of the kiosk.
@@ -124,7 +131,7 @@ print(f"Screensaver state: {state}")
 
 #### Set Blackout
 ```python
-from kiosker.data import Blackout
+from kiosker import Blackout
 
 blackout = Blackout(
     visible=True,                   # Required: show blackout screen
@@ -233,7 +240,7 @@ HOST="0.0.0.0" TOKEN="" pytest -s
 
 6. Build the library
 ```shell
-python -m build --wheel
+python -m build
 ```
 
 7. Upload to test
@@ -241,6 +248,11 @@ python -m build --wheel
 twine upload --repository testpypi dist/*
 ```
 
+7. Upload to prod
+```shell
+twine upload dist/*
+```
+
 ---
 
 ### API Documentation

{kiosker_python_api-1.2.2 → kiosker_python_api-1.2.4}/kiosker/data.py

@@ -8,15 +8,16 @@ class Status:
     battery_state: str
     model: str
     os_version: str
+    app_name: str
+    app_version: str
     last_interaction: datetime
     last_update: datetime
     device_id: str
     last_motion: Optional[datetime]
-    screensaver_pause: Optional[bool]
     
     @classmethod
     def from_dict(cls, status_data):
-        return cls(battery_level=status_data['batteryLevel'], battery_state=status_data['batteryState'], model=status_data['model'], os_version=status_data['osVersion'], last_interaction=datetime.fromisoformat(status_data['lastInteraction']), last_motion=datetime.fromisoformat(status_data['lastMotion']) if status_data.get('lastMotion') else None, last_update=datetime.fromisoformat(status_data['date']), device_id=status_data['deviceId'], screensaver_pause=status_data['screensaverPause'] if status_data.get('screensaverPause') else None)
+        return cls(battery_level=status_data['batteryLevel'], battery_state=status_data['batteryState'], model=status_data['model'], os_version=status_data['osVersion'], app_name=status_data['appName'], app_version=status_data['appVersion'], last_interaction=datetime.fromisoformat(status_data['lastInteraction']), last_motion=datetime.fromisoformat(status_data['lastMotion']) if status_data.get('lastMotion') else None, last_update=datetime.fromisoformat(status_data['date']), device_id=status_data['deviceId'])
 
 @dataclass
 class Result:

{kiosker_python_api-1.2.2 → kiosker_python_api-1.2.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "kiosker-python-api"
 readme = "README.md"
-version = "1.2.2"
+version = "1.2.4"
 license = "MIT"
 description = "A python wrapper for the Kiosker API"
 keywords = ["kiosk", "kiosker", "api", "kiosker pro"]

{kiosker_python_api-1.2.2 → kiosker_python_api-1.2.4}/tests/test_api.py

@@ -29,7 +29,8 @@ def test_status():
     print(f'Last interaction: {status.last_interaction}')
     print(f'Last motion: {status.last_motion}')
     print(f'Last status update: {status.last_update}')
-    print(f'Screensaver pause: {status.screensaver_pause}')
+    print(f'App name: {status.app_name}')
+    print(f'App version: {status.app_version}')
 
     assert api.ping() == True