pihole6api 0.1.8__tar.gz → 0.2.0__tar.gz

{pihole6api-0.1.8/src/pihole6api.egg-info → pihole6api-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pihole6api
-Version: 0.1.8
+Version: 0.2.0
 Summary: Python API Client for Pi-hole 6
 Author-email: Shane Barbetta <shane@barbetta.me>
 License: MIT
@@ -132,6 +132,14 @@ client.actions.restart_dns()
 | `network_info`      | View network devices, interfaces, routes |
 | `actions`           | Flush logs, restart services |
 
+## Contributing
+
+Please check [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
+
 ## License
 
 This project is license under the [MIT license](LICENSE).

{pihole6api-0.1.8 → pihole6api-0.2.0}/README.md

@@ -106,6 +106,14 @@ client.actions.restart_dns()
 | `network_info`      | View network devices, interfaces, routes |
 | `actions`           | Flush logs, restart services |
 
+## Contributing
+
+Please check [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
+
 ## License
 
 This project is license under the [MIT license](LICENSE).

{pihole6api-0.1.8 → pihole6api-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pihole6api"
-version = "0.1.8"
+version = "0.2.0"
 description = "Python API Client for Pi-hole 6"
 authors = [{name = "Shane Barbetta", email = "shane@barbetta.me"}]
 license = {text = "MIT"}

{pihole6api-0.1.8 → pihole6api-0.2.0}/src/pihole6api/client.py

@@ -10,6 +10,7 @@ from .config import PiHole6Configuration
 from .network_info import PiHole6NetworkInfo
 from .actions import PiHole6Actions
 from .dhcp import PiHole6Dhcp
+import importlib.metadata
 
 class PiHole6Client:
     def __init__(self, base_url, password):
@@ -45,4 +46,18 @@ class PiHole6Client:
     
     def close_session(self):
         """Close the Pi-hole session by calling the exit method in the connection."""
-        return self.connection.exit()
+        return self.connection.exit()
+
+    def version(self):
+        """
+        Get the project information from package metadata.
+        
+        :return: Dictionary containing version, description, and project URL
+        """
+        metadata = importlib.metadata.metadata("pihole6api")
+        
+        return {
+            "version": metadata["Version"],
+            "description": metadata["Summary"],
+            "project_url": metadata["Project-URL"]
+        }

pihole6api-0.2.0/src/pihole6api/conn.py

@@ -0,0 +1,231 @@
+import requests
+import urllib3
+from urllib.parse import urljoin
+import warnings
+import time
+import json
+import logging
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
+
+# Suppress InsecureRequestWarning
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+warnings.simplefilter("ignore", category=urllib3.exceptions.InsecureRequestWarning)
+
+# Configure logging
+logger = logging.getLogger("pihole6api")
+
+class PiHole6Connection:
+    def __init__(self, base_url, password, max_retries=3, retry_delay=1, 
+                 connection_timeout=10, disable_connection_pooling=False):
+        """
+        Initialize the Pi-hole connection client.
+
+        :param base_url: The base URL of the Pi-hole API (e.g., "http://pi.hole/api/")
+        :param password: The password for authentication (or an application password)
+        :param max_retries: Maximum number of retry attempts for failed requests
+        :param retry_delay: Base delay in seconds between retries (will use exponential backoff)
+        :param connection_timeout: Connection timeout in seconds
+        :param disable_connection_pooling: If True, disable connection pooling to prevent connection reuse issues
+        """
+        self.base_url = base_url.rstrip("/") + "/api/"
+        self.password = password
+        self.session_id = None
+        self.csrf_token = None
+        self.validity = None
+        self.max_retries = max_retries
+        self.retry_delay = retry_delay
+        self.connection_timeout = connection_timeout
+        self.disable_connection_pooling = disable_connection_pooling
+        
+        # Create a session for connection reuse
+        self.session = requests.Session()
+        
+        # Configure retry strategy
+        retry_strategy = Retry(
+            total=max_retries,
+            backoff_factor=retry_delay,
+            status_forcelist=[429, 500, 502, 503, 504],
+            allowed_methods=["GET", "POST", "PUT", "DELETE", "PATCH"]
+        )
+        
+        # Configure adapter with retry strategy
+        adapter = HTTPAdapter(
+            max_retries=retry_strategy,
+            pool_connections=1 if disable_connection_pooling else 10,
+            pool_maxsize=1 if disable_connection_pooling else 10
+        )
+        
+        # Mount the adapter to both HTTP and HTTPS
+        self.session.mount("http://", adapter)
+        self.session.mount("https://", adapter)
+        
+        # Set timeout
+        self.session.timeout = connection_timeout
+        
+        # Authenticate upon initialization
+        self._authenticate()
+
+    def _authenticate(self):
+        """Authenticate with the Pi-hole API and store session ID and CSRF token.
+        
+        Retries up to max_retries times with exponential backoff before raising an exception.
+        """
+        auth_url = urljoin(self.base_url, "auth")
+        payload = {"password": self.password}
+        last_exception = None
+
+        for attempt in range(1, self.max_retries + 1):
+            try:
+                logger.debug(f"Authentication attempt {attempt}/{self.max_retries}")
+                response = self.session.post(auth_url, json=payload, verify=False, timeout=self.connection_timeout)
+                
+                if response.status_code == 200:
+                    data = response.json()
+                    if "session" in data and data["session"]["valid"] and data["session"]["validity"] > 0:
+                        self.session_id = data["session"]["sid"]
+                        self.csrf_token = data["session"]["csrf"]
+                        self.validity = data["session"]["validity"]
+                        logger.debug("Authentication successful")
+                        return  # Successful authentication
+                    else:
+                        if data.get("session"):
+                            logger.error(data["session"].get("message", "API failed without message"))
+                        last_exception = Exception("Authentication failed: Invalid session response")
+                else:
+                    # Try to extract an error message from the response
+                    try:
+                        error_msg = response.json().get("session", {}).get("message", "Unknown error")
+                    except (json.decoder.JSONDecodeError, ValueError):
+                        error_msg = f"HTTP {response.status_code}: {response.reason}"
+                    last_exception = Exception(f"Authentication failed: {error_msg}")
+            except Exception as e:
+                last_exception = e
+                logger.warning(f"Authentication attempt {attempt} failed: {str(e)}")
+
+            if attempt < self.max_retries:
+                # Calculate exponential backoff delay
+                current_delay = self.retry_delay * (2 ** (attempt - 1))
+                logger.debug(f"Retrying authentication in {current_delay} seconds...")
+                time.sleep(current_delay)
+
+        # All attempts failed; raise the last captured exception.
+        logger.error(f"All authentication attempts failed: {str(last_exception)}")
+        raise last_exception
+
+    def _get_headers(self):
+        """Return headers including the authentication SID and CSRF token."""
+        if not self.session_id or not self.csrf_token:
+            self._authenticate()
+
+        return {
+            "X-FTL-SID": self.session_id,
+            "X-FTL-CSRF": self.csrf_token
+        }
+
+    def _do_call(self, method, endpoint, params=None, data=None, files=None, is_binary=False):
+        """Internal method to send an authenticated request to the Pi-hole API."""
+        url = f"{self.base_url}{endpoint}"
+        headers = self._get_headers()
+
+        # Convert dictionary to form-encoded string if sending multipart
+        request_data = None if files else data
+        form_data = data if files else None  # Ensure correct encoding
+
+        try:
+            logger.debug(f"Sending {method} request to {url}")
+            response = self.session.request(
+                method,
+                url,
+                headers=headers,
+                params=params,
+                json=request_data,
+                files=files,
+                data=form_data,
+                verify=False,
+                timeout=self.connection_timeout
+            )
+
+            if response.status_code == 401:
+                logger.warning("Session expired, re-authenticating")
+                self._authenticate()
+                headers = self._get_headers()
+                response = self.session.request(
+                    method,
+                    url,
+                    headers=headers,
+                    params=params,
+                    json=request_data,
+                    files=files,
+                    data=form_data,
+                    verify=False,
+                    timeout=self.connection_timeout
+                )
+
+            # Handle 4xx responses gracefully
+            if 400 <= response.status_code < 500:
+                try:
+                    return response.json()
+                except requests.exceptions.JSONDecodeError:
+                    return {"error": f"HTTP {response.status_code}: {response.reason}"}
+
+            response.raise_for_status()
+
+            if is_binary:
+                return response.content  # Return raw binary content (e.g., for file exports)
+
+            if not response.content.strip():
+                return {}  # Handle empty response
+
+            try:
+                return response.json()  # Attempt to parse JSON
+            except requests.exceptions.JSONDecodeError:
+                return response.text  # Return raw text as fallback
+                
+        except requests.exceptions.ConnectionError as e:
+            logger.error(f"Connection error: {str(e)}")
+            raise Exception(f"Connection error: {str(e)}")
+        except requests.exceptions.Timeout as e:
+            logger.error(f"Request timed out: {str(e)}")
+            raise Exception(f"Request timed out: {str(e)}")
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Request error: {str(e)}")
+            raise Exception(f"Request error: {str(e)}")
+
+    def get(self, endpoint, params=None, is_binary=False):
+        """Send a GET request."""
+        return self._do_call("GET", endpoint, params=params, is_binary=is_binary)
+
+    def post(self, endpoint, data=None, files=None):
+        """Send a POST request."""
+        return self._do_call("POST", endpoint, data=data, files=files)
+
+    def put(self, endpoint, data=None):
+        """Send a PUT request."""
+        return self._do_call("PUT", endpoint, data=data)
+
+    def delete(self, endpoint, params=None, data=None):
+        """Send a DELETE request."""
+        return self._do_call("DELETE", endpoint, params=params, data=data)
+
+    def patch(self, endpoint, data=None):
+        """Send a PATCH request."""
+        return self._do_call("PATCH", endpoint, data=data)
+    
+    def exit(self):
+        """Delete the current session and close connections."""
+        try:
+            response = self.delete("auth")
+        except Exception as e:
+            logger.warning(f"Error during session exit: {str(e)}")
+            response = {"error": str(e)}
+        finally:
+            # Clear stored session info
+            self.session_id = None
+            self.csrf_token = None
+            self.validity = None
+            
+            # Close the session to release connections
+            self.session.close()
+
+        return response

{pihole6api-0.1.8 → pihole6api-0.2.0}/src/pihole6api/domain_management.py

@@ -85,3 +85,18 @@ class PiHole6DomainManagement:
         :param kind: Kind of domain ("exact" or "regex")
         """
         return self.connection.delete(f"domains/{domain_type}/{kind}/{domain}")
+
+    def get_all_domains(self):
+        """
+        Get all white and blacklisted domains
+        """
+        try:
+            # Get whiteliste domains
+            whitelist = self.connection.get("domains/allow/exact")
+            # Get blackliste domains
+            blacklist = self.connection.get("domains/deny/exact")
+
+            return {"whitelist": whitelist, "blacklist": blacklist}
+        except Exception as e:
+            print(f"Error fetching domains: {e}")
+            return None

{pihole6api-0.1.8 → pihole6api-0.2.0/src/pihole6api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pihole6api
-Version: 0.1.8
+Version: 0.2.0
 Summary: Python API Client for Pi-hole 6
 Author-email: Shane Barbetta <shane@barbetta.me>
 License: MIT
@@ -132,6 +132,14 @@ client.actions.restart_dns()
 | `network_info`      | View network devices, interfaces, routes |
 | `actions`           | Flush logs, restart services |
 
+## Contributing
+
+Please check [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
+
 ## License
 
 This project is license under the [MIT license](LICENSE).

pihole6api-0.1.8/src/pihole6api/conn.py

@@ -1,161 +0,0 @@
-import requests
-import urllib3
-from urllib.parse import urljoin
-import warnings
-import time
-import json
-
-# Suppress InsecureRequestWarning
-urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
-warnings.simplefilter("ignore", category=urllib3.exceptions.InsecureRequestWarning)
-
-class PiHole6Connection:
-    def __init__(self, base_url, password):
-        """
-        Initialize the Pi-hole connection client.
-
-        :param base_url: The base URL of the Pi-hole API (e.g., "http://pi.hole/api/")
-        :param password: The password for authentication (or an application password)
-        """
-        self.base_url = base_url.rstrip("/") + "/api/"
-        self.password = password
-        self.session_id = None
-        self.csrf_token = None
-        self.validity = None
-
-        # Authenticate upon initialization
-        self._authenticate()
-
-    def _authenticate(self):
-        """Authenticate with the Pi-hole API and store session ID and CSRF token.
-        
-        Retries up to three times (with a one-second pause between attempts)
-        before raising an exception.
-        """
-        auth_url = urljoin(self.base_url, "auth")
-        payload = {"password": self.password}
-        max_attempts = 3
-        last_exception = None
-
-        for attempt in range(1, max_attempts + 1):
-            response = requests.post(auth_url, json=payload, verify=False)
-            try:
-                if response.status_code == 200:
-                    data = response.json()
-                    if "session" in data and data["session"]["valid"]:
-                        self.session_id = data["session"]["sid"]
-                        self.csrf_token = data["session"]["csrf"]
-                        self.validity = data["session"]["validity"]
-                        return  # Successful authentication
-                    else:
-                        last_exception = Exception("Authentication failed: Invalid session response")
-                else:
-                    # Try to extract an error message from the response
-                    try:
-                        error_msg = response.json().get("error", {}).get("message", "Unknown error")
-                    except (json.decoder.JSONDecodeError, ValueError):
-                        error_msg = f"HTTP {response.status_code}: {response.reason}"
-                    last_exception = Exception(f"Authentication failed: {error_msg}")
-            except Exception as e:
-                last_exception = e
-
-            if attempt < max_attempts:
-                time.sleep(1)  # Pause before retrying
-
-        # All attempts failed; raise the last captured exception.
-        raise last_exception
-
-    def _get_headers(self):
-        """Return headers including the authentication SID and CSRF token."""
-        if not self.session_id or not self.csrf_token:
-            self._authenticate()
-
-        return {
-            "X-FTL-SID": self.session_id,
-            "X-FTL-CSRF": self.csrf_token
-        }
-
-    def _do_call(self, method, endpoint, params=None, data=None, files=None, is_binary=False):
-        """Internal method to send an authenticated request to the Pi-hole API."""
-        url = f"{self.base_url}{endpoint}"
-        headers = self._get_headers()
-
-        # Convert dictionary to form-encoded string if sending multipart
-        request_data = None if files else data
-        form_data = data if files else None  # Ensure correct encoding
-
-        response = requests.request(
-            method,
-            url,
-            headers=headers,
-            params=params,
-            json=request_data,
-            files=files,
-            data=form_data,
-            verify=False
-        )
-
-        if response.status_code == 401:
-            self._authenticate()
-            headers = self._get_headers()
-            response = requests.request(
-                method,
-                url,
-                headers=headers,
-                params=params,
-                json=request_data,
-                files=files,
-                data=form_data,
-                verify=False
-            )
-
-        # Handle 4xx responses gracefully
-        if 400 <= response.status_code < 500:
-            try:
-                return response.json()
-            except requests.exceptions.JSONDecodeError:
-                return {"error": f"HTTP {response.status_code}: {response.reason}"}
-
-        response.raise_for_status()
-
-        if is_binary:
-            return response.content  # Return raw binary content (e.g., for file exports)
-
-        if not response.content.strip():
-            return {}  # Handle empty response
-
-        try:
-            return response.json()  # Attempt to parse JSON
-        except requests.exceptions.JSONDecodeError:
-            return response.text  # Return raw text as fallback
-
-    def get(self, endpoint, params=None, is_binary=False):
-        """Send a GET request."""
-        return self._do_call("GET", endpoint, params=params, is_binary=is_binary)
-
-    def post(self, endpoint, data=None, files=None):
-        """Send a POST request."""
-        return self._do_call("POST", endpoint, data=data, files=files)
-
-    def put(self, endpoint, data=None):
-        """Send a PUT request."""
-        return self._do_call("PUT", endpoint, data=data)
-
-    def delete(self, endpoint, params=None, data=None):
-        """Send a DELETE request."""
-        return self._do_call("DELETE", endpoint, params=params, data=data)
-
-    def patch(self, endpoint, data=None):
-        """Send a PATCH request."""
-        return self._do_call("PATCH", endpoint, data=data)
-    
-    def exit(self):
-        """Delete the current session."""
-        response = self.delete("auth")
-
-        # Clear stored session info
-        self.session_id = None
-        self.csrf_token = None
-        self.validity = None
-
-        return response