pihole6api 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

pihole6api/client_management.py

@@ -47,6 +47,12 @@ class PiHole6ClientManagement:
         :param client: Client identifier (IP, MAC, hostname, or interface).
         """
         return self.connection.get(f"clients/{client}")
+    
+    def get_clients(self):
+        """
+        Retrieve information about all clients.
+        """
+        return self.connection.get(f"clients")
 
     def update_client(self, client, comment=None, groups=None):
         """

pihole6api/list_management.py

@@ -36,8 +36,8 @@ class PiHole6ListManagement:
         """
         Delete multiple lists.
 
-        :param lists: List of dictionaries with keys "address" and "type".
-                      Example: [{"address": "https://example.com/blocklist.txt", "type": "block"}]
+        :param lists: List of dictionaries with keys "item" and "type".
+                      Example: [{"item": "https://example.com/blocklist.txt", "type": "block"}]
         """
         if not isinstance(lists, list):
             raise ValueError("lists must be a list of dictionaries.")

pihole6api/metrics.py

@@ -1,3 +1,5 @@
+import warnings
+
 class PiHole6Metrics:
     def __init__(self, connection):
         """
@@ -41,11 +43,12 @@ class PiHole6Metrics:
         return self.connection.get("history/database/clients", params=params)
 
     # Query API Endpoints
-    def get_queries(self, n=100, from_ts=None, until_ts=None, upstream=None, domain=None, client=None, cursor=None):
+    def get_queries(self, length=100, from_ts=None, until_ts=None, upstream=None, domain=None, client=None, cursor=None, **kwargs):
         """
         Get query log with optional filtering parameters.
 
-        :param int n: Number of queries to retrieve (default: 100).
+        :param int length: Number of queries to retrieve (default: 100). 
+            (Note: The old parameter 'n' is deprecated and will be removed in a future version.)
         :param int from_ts: Unix timestamp to filter queries from this time onward (optional).
         :param int until_ts: Unix timestamp to filter queries up to this time (optional).
         :param str upstream: Filter queries sent to a specific upstream destination (optional).
@@ -53,19 +56,31 @@ class PiHole6Metrics:
         :param str client: Filter queries originating from a specific client (optional).
         :param str cursor: Cursor for pagination to fetch the next chunk of results (optional).
         """
+        # Check for deprecated "n" parameter
+        if "n" in kwargs:
+            warnings.warn(
+                "The 'n' parameter is deprecated; please use 'length' instead.",
+                DeprecationWarning,
+                stacklevel=2
+            )
+            length = kwargs.pop("n")
+        
+        if kwargs:
+            raise TypeError("Unexpected keyword arguments: " + ", ".join(kwargs.keys()))
+        
         params = {
-            "n": n,
+            "length": length,
             "from": from_ts,
             "until": until_ts,
             "upstream": upstream,
             "domain": domain,
             "client": client,
-            "cursor": cursor
+            "cursor": cursor,
         }
+        # Remove any parameters that are None
         params = {k: v for k, v in params.items() if v is not None}
         return self.connection.get("queries", params=params)
 
-
     def get_query_suggestions(self):
         """Get query filter suggestions"""
         return self.connection.get("queries/suggestions")

{pihole6api-0.1.6.dist-info → pihole6api-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: pihole6api
-Version: 0.1.6
+Version: 0.1.8
 Summary: Python API Client for Pi-hole 6
 Author-email: Shane Barbetta <shane@barbetta.me>
 License: MIT
@@ -22,6 +22,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.26.0
+Dynamic: license-file
 
 # 🍓 pihole6api
 

{pihole6api-0.1.6.dist-info → pihole6api-0.1.8.dist-info}/RECORD

@@ -1,7 +1,7 @@
 pihole6api/__init__.py,sha256=OKDAH2I6UjXcBmcj6rn5aNg5J60GCUBVFJ-_t83GiVQ,898
 pihole6api/actions.py,sha256=8CBkr8nYfT8yfdCO6F9M9nompaYcFdsaYGiEa1eVDCw,693
 pihole6api/client.py,sha256=HYdRh3CSZJ0srbkpjIVnLo-iy1avqKDUne5ji2Aq394,2013
-pihole6api/client_management.py,sha256=opPYGrjuW6SiwuxuvoOxnqjpmflU2znKHsqFbGSS3Gg,2439
+pihole6api/client_management.py,sha256=n8Ra_6pRL3Q9jlIK3kIK9bmh74MTfxgYnOHYaUwYGNs,2590
 pihole6api/config.py,sha256=NdBHOudz147oIs5YVR3U4WLvqk3hU3HlZHnshy1NK4g,4680
 pihole6api/conn.py,sha256=60Q9paDCD6Bwmdg_G9mOUr86Hzj9G-dhMwL7F3NvLB8,5837
 pihole6api/dhcp.py,sha256=1A3z-3q9x51-6MOC3JMl7yR_5pHmRxZtMWtPqzWxYm0,629
@@ -9,11 +9,11 @@ pihole6api/dns_control.py,sha256=mxV3AIuGCsx0-1ibpMXor9QUGd_fDFfeaUENPhIK_TY,853
 pihole6api/domain_management.py,sha256=vxhQSG5F8EFDGqtiNkF0H_KOWFMerXaAuJZT0nMa8ec,3492
 pihole6api/ftl_info.py,sha256=FINHFotI1sQgkL0OPaNqW-rk4h1ua6QHnRh5gFXXRIE,3210
 pihole6api/group_management.py,sha256=Iip2Na4pUYgC5K9cwOWv_OPD6qdXRzWCmlS-fJlBMjU,2372
-pihole6api/list_management.py,sha256=NbxEtYNsetF_qH3jL0hZH9xfM5qpb1CM1ADgmodN03Y,4176
-pihole6api/metrics.py,sha256=czNyx9tUf2yZi_HnUpqykrtW51c042Rxq3zFl2_GjLY,7379
+pihole6api/list_management.py,sha256=CooTeF4EmNPFwnzGoLbHFMhCePJ-ojvRGx7Sxzayy-U,4170
+pihole6api/metrics.py,sha256=QWqV_7SytMPGEBEZOxsIfxTa6lM9Ksrvlf2BXjDKZmA,7991
 pihole6api/network_info.py,sha256=E1qQ7DsCb7qplt0oQIyKhUY12ExNF6bv6thm9rbNqwY,1953
-pihole6api-0.1.6.dist-info/LICENSE,sha256=hpO6J6J9O1VZxZeHQTxKMTmuobaHbApiZxp279I4xNU,1062
-pihole6api-0.1.6.dist-info/METADATA,sha256=AWSjucKVbtSDbr12oR4L4zL_W0FrmHj8vJLXDIds6b0,3768
-pihole6api-0.1.6.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-pihole6api-0.1.6.dist-info/top_level.txt,sha256=Qrh46lxEC54rBR8T53em-tuZLWbmi1SDwL1rOhsgrME,11
-pihole6api-0.1.6.dist-info/RECORD,,
+pihole6api-0.1.8.dist-info/licenses/LICENSE,sha256=hpO6J6J9O1VZxZeHQTxKMTmuobaHbApiZxp279I4xNU,1062
+pihole6api-0.1.8.dist-info/METADATA,sha256=LqrKT8Vpxgqtithi4sPa80xMEIBWmpKGUrAYN7G3nyQ,3790
+pihole6api-0.1.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pihole6api-0.1.8.dist-info/top_level.txt,sha256=Qrh46lxEC54rBR8T53em-tuZLWbmi1SDwL1rOhsgrME,11
+pihole6api-0.1.8.dist-info/RECORD,,

{pihole6api-0.1.6.dist-info → pihole6api-0.1.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any