snap-python 0.0.2__tar.gz → 0.0.3__tar.gz

{snap_python-0.0.2 → snap_python-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snap-python
-Version: 0.0.2
+Version: 0.0.3
 Summary: An api to interact with snapd and snap stores
 Home-page: https://github.com/alexlukens/snap-python
 License: MIT

{snap_python-0.0.2 → snap_python-0.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snap-python"
-version = "0.0.2"
+version = "0.0.3"
 description = "An api to interact with snapd and snap stores"
 authors = ["Alexander Lukens <alexdlukens@gmail.com>"]
 license = "MIT"
@@ -21,6 +21,8 @@ ruff = "^0.7.4"
 pre-commit = "^4.0.1"
 ipykernel = "^6.29.5"
 pytest-cov = "^6.0.0"
+sphinx = "^8.1.3"
+sphinx-rtd-theme = "^3.0.2"
 
 [build-system]
 requires = ["poetry-core"]

snap_python-0.0.3/src/snap_python/__init__.py

@@ -0,0 +1,7 @@
+import logging
+import os
+
+log_level = os.getenv("SNAP_PYTHON_LOG_LEVEL", "DEBUG").upper()
+numeric_level = getattr(logging, log_level, logging.DEBUG)
+logger = logging.getLogger("snap_python")
+logger.setLevel(numeric_level)

{snap_python-0.0.2 → snap_python-0.0.3}/src/snap_python/client.py

@@ -18,6 +18,8 @@ logger.setLevel(logging.DEBUG)
 
 
 class SnapClient(AbstractSnapsClient):
+    """Core class for interacting with the Snap Store and Snapd."""
+
     def __init__(
         self,
         version: str = "v2",
@@ -56,6 +58,18 @@ class SnapClient(AbstractSnapsClient):
 
     @retry(httpx.HTTPError, tries=3, delay=1, backoff=1)
     async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """
+        Sends an HTTP request to the specified endpoint using the given method and parameters.
+        Args:
+            method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
+            endpoint (str): The API endpoint to send the request to.
+            **kwargs: Additional keyword arguments to pass to the request.
+        Returns:
+            httpx.Response: The response object from the HTTP request.
+        Raises:
+            httpx.HTTPStatusError: If the response contains an HTTP status code indicating an error.
+        """
+
         response = await self.snapd_client.request(
             method, f"{self._base_url}/{self.version}/{endpoint}", **kwargs
         )
@@ -64,6 +78,18 @@ class SnapClient(AbstractSnapsClient):
 
     @retry(httpx.HTTPError, tries=3, delay=1, backoff=1)
     async def request_raw(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """
+        Sends an HTTP request using the specified method and endpoint.
+        Args:
+            method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
+            endpoint (str): The endpoint URL to send the request to.
+            **kwargs: Additional keyword arguments to pass to the request.
+        Returns:
+            httpx.Response: The response object resulting from the HTTP request.
+        Raises:
+            httpx.HTTPStatusError: If the response contains an HTTP status code indicating an error.
+        """
+
         response = await self.snapd_client.request(method, endpoint, **kwargs)
 
         response.raise_for_status()

snap_python-0.0.2/src/snap_python/__init__.py

@@ -1,18 +0,0 @@
-import logging
-import os
-
-log_level = os.getenv("SNAP_PYTHON_LOG_LEVEL", "DEBUG").upper()
-numeric_level = getattr(logging, log_level, logging.DEBUG)
-logger = logging.getLogger("snap_python")
-logger.setLevel(numeric_level)
-
-ch = logging.StreamHandler()
-ch.setLevel(numeric_level)
-formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-ch.setFormatter(formatter)
-logger.addHandler(ch)
-
-fh = logging.FileHandler("snap_python.log")
-fh.setLevel(numeric_level)
-fh.setFormatter(formatter)
-logger.addHandler(fh)