pykada 0.0.10__tar.gz

pykada-0.0.10/.gitignore

@@ -0,0 +1,2 @@
+/.env
+/.venv/

pykada-0.0.10/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,13 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="PyMissingOrEmptyDocstringInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="PyPep8NamingInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="ignoredErrors">
+        <list>
+          <option value="N806" />
+        </list>
+      </option>
+    </inspection_tool>
+  </profile>
+</component>

pykada-0.0.10/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

pykada-0.0.10/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/pykada.iml" filepath="$PROJECT_DIR$/.idea/pykada.iml" />
+    </modules>
+  </component>
+</project>

pykada-0.0.10/.idea/pykada.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

pykada-0.0.10/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

pykada-0.0.10/.idea/workspace.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="ca47c520-58fd-48ae-9dad-6c38aaead4d9" name="Changes" comment="" />
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="ProjectColorInfo"><![CDATA[{
+  "associatedIndex": 6
+}]]></component>
+  <component name="ProjectId" id="30COUriJjZiWE6Wt4yvZoKUdGTE" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "git-widget-placeholder": "master"
+  }
+}]]></component>
+  <component name="SharedIndexes">
+    <attachedChunks>
+      <set>
+        <option value="bundled-python-sdk-4c141bd692a7-e2d783800521-com.jetbrains.pycharm.community.sharedIndexes.bundled-PC-251.26927.90" />
+      </set>
+    </attachedChunks>
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="ca47c520-58fd-48ae-9dad-6c38aaead4d9" name="Changes" comment="" />
+      <created>1753128106858</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1753128106858</updated>
+    </task>
+    <servers />
+  </component>
+</project>

pykada-0.0.10/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ryan Malley
+
+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.

pykada-0.0.10/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: pykada
+Version: 0.0.10
+Summary: A handy library for interacting with Verkada APIs.
+Project-URL: Homepage, https://github.com/ryanmalley101/pykada
+Project-URL: Issues, https://github.com/ryanmalley101/pykada/issues
+Author-email: Ryan Malley <ryanmalley101@gmail.com>
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: numpy~=2.2.6
+Requires-Dist: pandas~=2.2.3
+Requires-Dist: pytest~=8.3.5
+Requires-Dist: python-dotenv~=1.1.0
+Requires-Dist: python-vlc~=3.0.21203
+Requires-Dist: requests~=2.32.3
+Requires-Dist: termcolor~=3.1.0
+Requires-Dist: typeguard~=4.4.2
+Requires-Dist: urllib3~=2.4.0
+Description-Content-Type: text/markdown
+
+# Pykada: A Python Client for the Verkada API
+## Introduction to Pykada
+Navigating the Verkada Public API directly can present certain complexities. Pykada was developed to serve as a dedicated Python library aimed at simplifying these interactions. The core objective is to provide developers with a Pythonic and intuitive interface, abstracting the lower-level details of direct API calls. This library is designed to enhance developer efficiency when integrating Verkada's physical security solutions into custom applications and workflows.
+
+## About Verkada
+Verkada is recognized as a leader in cloud-based physical security. Their mission is centered on protecting people and places while prioritizing privacy. They achieve this through a unified system accessible via their cloud platform, Verkada Command.
+
+Verkada offers a comprehensive suite of integrated product lines:
+
+* Video Security
+* Access Control
+* Environmental sensors
+* Alarms
+* Workplace (Guest and Mailroom)
+* Intercoms
+* Gateways (Cell and WiFi)
+
+Pykada is designed to interface with the APIs governing these systems, enabling programmatic access and management of data within the Verkada ecosystem.
+
+## Important Disclaimer:
+
+Please be aware that Pykada is not an official Verkada product. It is not affiliated with, endorsed by, or supported by Verkada Inc. This library is maintained independently.
+
+For the most accurate and current information regarding the Verkada API, developers should always refer to the official Verkada API documentation at apidocs.verkada.com. Any support requests or issues related to the Verkada platform itself should be directed to Verkada Support.
+
+## Key Features of Pykada
+Pykada offers several features designed to streamline the use of the Verkada API:
+
+**Simplified Authentication:** Manages the intricacies of API token generation and management, including the automatic refreshing of short-lived tokens.
+
+**Object-Oriented Interface:** Provides Python objects representing Verkada entities (e.g., Cameras, Doors, Alerts), offering a more intuitive approach compared to handling raw JSON responses.
+**Camera Management Capabilities:** Retrieve lists and detailed information for Verkada cameras.
+
+**Alert Analytics:** Access camera alerts, including motion, crowd, person of interest, online/offline status, and tamper events.
+
+**Ingest Analytics** Fetch camera analytics such as occupancy trends and License Plate Recognition (LPR) data.
+
+**Access Control Integration:** List Verkada access control doors and retrieve their details.
+
+**Control Doors**Programmatically unlock doors (requires specific configuration within Verkada Command).
+
+**Clear Error Handling:** Translates API error responses into descriptive Python exceptions for easier debugging.
+
+The primary value of Pykada lies in the abstraction and ease of use it provides. For example, the automatic handling of short-lived API token refreshing allows developers to concentrate on application logic rather than authentication management.
+
+## Requirements
+Python Version: Python 3.8 or higher is required.
+
+External Dependencies: Pykada relies on libraries such as requests for making HTTP API calls. These dependencies are typically installed automatically when Pykada is installed via pip.
+
+**Verkada Account & API Access:**
+
+A valid Verkada organization account is mandatory.
+
+API access must be enabled for the organization within Verkada Command.
+
+An API Key must be generated from the Verkada Command platform; this key serves as the primary credential for API interaction. 
+
+That API key must be placed in a `.env` file in the root directory of the project. The file should contain a line in the format:
+
+```
+VERKADA_API_KEY="YOUR_API_KEY_HERE"
+```
+
+## Example Usage
+This guide demonstrates how to use the library directly to perform some basic API calls without running the testbeds. These examples cover common operations such as retrieving data, creating resources, and updating configurations.
+
+Prerequisites
+Ensure your `.env` file has a valid API key "VERKADA_API_KEY". The library uses the `python-dotenv` package to load these variables.
+
+### Example 1: Retrieve All Cameras
+Retrieve a list of all cameras in the system
+
+```
+from cameras.cameras import get_all_cameras
+
+# Fetch all cameras
+cameras = get_all_cameras()
+print("Cameras:", cameras)
+```
+
+### Example 2: Create and Delete a POI (Person of Interest)
+Create a new POI and then delete it.
+
+```
+from cameras.cameras import create_poi, delete_poi
+
+# Create a new POI
+poi = create_poi(image_url="example.png", label="Test POI")
+print("Created POI:", poi)
+
+# Delete the POI
+delete_response = delete_poi(person_id=poi["person_id"])
+print("Deleted POI:", delete_response)
+```
+
+### Example 3: Retrieve Sensor Data
+Retrieve temperature and humidity data for a specific sensor.
+
+```
+import os
+from sensors.sensors import get_all_sensor_data
+from helpers import SENSOR_FIELD_ENUM
+import time
+
+sensor_id = "YOUR_SENSOR_ID_HERE"
+current_time = int(time.time())
+
+# Fetch sensor data
+sensor_data = get_all_sensor_data(
+    device_id=sensor_id,
+    start_time=current_time - 3600,
+    end_time=current_time,
+    fields=[SENSOR_FIELD_ENUM["TEMPERATURE"], SENSOR_FIELD_ENUM["HUMIDITY"]],
+    interval="5m"
+)
+print("Sensor Data:", sensor_data)
+```
+
+### Example 4: Get Camera Alerts
+Retrieve all alerts for a specific camera within a time range.
+
+```
+from cameras.cameras import get_all_camera_alerts
+import time
+
+current_time = int(time.time())
+
+# Fetch camera alerts
+alerts = get_all_camera_alerts(
+    start_time=current_time - 3600,
+    end_time=current_time,
+    include_image_url=True
+)
+print("Camera Alerts:", alerts)
+```
+
+### Example 5: Update Cloud Backup Settings
+Update and restore cloud backup settings for a camera.
+```
+from cameras.cameras import get_cloud_backup_settings, update_cloud_backup_settings
+import os
+
+camera_id = "YOUR_CAMERA_ID_HERE"
+
+# Get current settings
+current_settings = get_cloud_backup_settings(camera_id=camera_id)
+print("Current Settings:", current_settings)
+
+# Update settings
+new_settings = current_settings.copy()
+new_settings["enabled"] = not current_settings["enabled"]  # Toggle enabled state
+update_response = update_cloud_backup_settings(**new_settings)
+print("Updated Settings:", update_response)
+
+# Restore original settings
+restore_response = update_cloud_backup_settings(**current_settings)
+print("Restored Settings:", restore_response)
+```
+

pykada-0.0.10/README.md

@@ -0,0 +1,160 @@
+# Pykada: A Python Client for the Verkada API
+## Introduction to Pykada
+Navigating the Verkada Public API directly can present certain complexities. Pykada was developed to serve as a dedicated Python library aimed at simplifying these interactions. The core objective is to provide developers with a Pythonic and intuitive interface, abstracting the lower-level details of direct API calls. This library is designed to enhance developer efficiency when integrating Verkada's physical security solutions into custom applications and workflows.
+
+## About Verkada
+Verkada is recognized as a leader in cloud-based physical security. Their mission is centered on protecting people and places while prioritizing privacy. They achieve this through a unified system accessible via their cloud platform, Verkada Command.
+
+Verkada offers a comprehensive suite of integrated product lines:
+
+* Video Security
+* Access Control
+* Environmental sensors
+* Alarms
+* Workplace (Guest and Mailroom)
+* Intercoms
+* Gateways (Cell and WiFi)
+
+Pykada is designed to interface with the APIs governing these systems, enabling programmatic access and management of data within the Verkada ecosystem.
+
+## Important Disclaimer:
+
+Please be aware that Pykada is not an official Verkada product. It is not affiliated with, endorsed by, or supported by Verkada Inc. This library is maintained independently.
+
+For the most accurate and current information regarding the Verkada API, developers should always refer to the official Verkada API documentation at apidocs.verkada.com. Any support requests or issues related to the Verkada platform itself should be directed to Verkada Support.
+
+## Key Features of Pykada
+Pykada offers several features designed to streamline the use of the Verkada API:
+
+**Simplified Authentication:** Manages the intricacies of API token generation and management, including the automatic refreshing of short-lived tokens.
+
+**Object-Oriented Interface:** Provides Python objects representing Verkada entities (e.g., Cameras, Doors, Alerts), offering a more intuitive approach compared to handling raw JSON responses.
+**Camera Management Capabilities:** Retrieve lists and detailed information for Verkada cameras.
+
+**Alert Analytics:** Access camera alerts, including motion, crowd, person of interest, online/offline status, and tamper events.
+
+**Ingest Analytics** Fetch camera analytics such as occupancy trends and License Plate Recognition (LPR) data.
+
+**Access Control Integration:** List Verkada access control doors and retrieve their details.
+
+**Control Doors**Programmatically unlock doors (requires specific configuration within Verkada Command).
+
+**Clear Error Handling:** Translates API error responses into descriptive Python exceptions for easier debugging.
+
+The primary value of Pykada lies in the abstraction and ease of use it provides. For example, the automatic handling of short-lived API token refreshing allows developers to concentrate on application logic rather than authentication management.
+
+## Requirements
+Python Version: Python 3.8 or higher is required.
+
+External Dependencies: Pykada relies on libraries such as requests for making HTTP API calls. These dependencies are typically installed automatically when Pykada is installed via pip.
+
+**Verkada Account & API Access:**
+
+A valid Verkada organization account is mandatory.
+
+API access must be enabled for the organization within Verkada Command.
+
+An API Key must be generated from the Verkada Command platform; this key serves as the primary credential for API interaction. 
+
+That API key must be placed in a `.env` file in the root directory of the project. The file should contain a line in the format:
+
+```
+VERKADA_API_KEY="YOUR_API_KEY_HERE"
+```
+
+## Example Usage
+This guide demonstrates how to use the library directly to perform some basic API calls without running the testbeds. These examples cover common operations such as retrieving data, creating resources, and updating configurations.
+
+Prerequisites
+Ensure your `.env` file has a valid API key "VERKADA_API_KEY". The library uses the `python-dotenv` package to load these variables.
+
+### Example 1: Retrieve All Cameras
+Retrieve a list of all cameras in the system
+
+```
+from cameras.cameras import get_all_cameras
+
+# Fetch all cameras
+cameras = get_all_cameras()
+print("Cameras:", cameras)
+```
+
+### Example 2: Create and Delete a POI (Person of Interest)
+Create a new POI and then delete it.
+
+```
+from cameras.cameras import create_poi, delete_poi
+
+# Create a new POI
+poi = create_poi(image_url="example.png", label="Test POI")
+print("Created POI:", poi)
+
+# Delete the POI
+delete_response = delete_poi(person_id=poi["person_id"])
+print("Deleted POI:", delete_response)
+```
+
+### Example 3: Retrieve Sensor Data
+Retrieve temperature and humidity data for a specific sensor.
+
+```
+import os
+from sensors.sensors import get_all_sensor_data
+from helpers import SENSOR_FIELD_ENUM
+import time
+
+sensor_id = "YOUR_SENSOR_ID_HERE"
+current_time = int(time.time())
+
+# Fetch sensor data
+sensor_data = get_all_sensor_data(
+    device_id=sensor_id,
+    start_time=current_time - 3600,
+    end_time=current_time,
+    fields=[SENSOR_FIELD_ENUM["TEMPERATURE"], SENSOR_FIELD_ENUM["HUMIDITY"]],
+    interval="5m"
+)
+print("Sensor Data:", sensor_data)
+```
+
+### Example 4: Get Camera Alerts
+Retrieve all alerts for a specific camera within a time range.
+
+```
+from cameras.cameras import get_all_camera_alerts
+import time
+
+current_time = int(time.time())
+
+# Fetch camera alerts
+alerts = get_all_camera_alerts(
+    start_time=current_time - 3600,
+    end_time=current_time,
+    include_image_url=True
+)
+print("Camera Alerts:", alerts)
+```
+
+### Example 5: Update Cloud Backup Settings
+Update and restore cloud backup settings for a camera.
+```
+from cameras.cameras import get_cloud_backup_settings, update_cloud_backup_settings
+import os
+
+camera_id = "YOUR_CAMERA_ID_HERE"
+
+# Get current settings
+current_settings = get_cloud_backup_settings(camera_id=camera_id)
+print("Current Settings:", current_settings)
+
+# Update settings
+new_settings = current_settings.copy()
+new_settings["enabled"] = not current_settings["enabled"]  # Toggle enabled state
+update_response = update_cloud_backup_settings(**new_settings)
+print("Updated Settings:", update_response)
+
+# Restore original settings
+restore_response = update_cloud_backup_settings(**current_settings)
+print("Restored Settings:", restore_response)
+```
+

pykada-0.0.10/__init.py__

@@ -0,0 +1 @@
+