karakeep-python-api 1.2.1__tar.gz → 1.2.3__tar.gz

{karakeep_python_api-1.2.1/karakeep_python_api.egg-info → karakeep_python_api-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karakeep_python_api
-Version: 1.2.1
+Version: 1.2.3
 Summary: Community python client for the Karakeep API.
 Home-page: https://github.com/thiswillbeyourgithub/karakeep_python_api/
 License: GPLv3
@@ -12,7 +12,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.32.3
-Requires-Dist: loguru
+Requires-Dist: loguru>=0.7.3
 Requires-Dist: pydantic>=2.0
 Requires-Dist: click>=8.0
 Provides-Extra: dev

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3}/karakeep_python_api/__main__.py

@@ -184,12 +184,6 @@ def cli(
             "The URL must include the API path, e.g., 'https://your-instance.com/api/v1/'."
         )
 
-    # Handle verbose environment variable manually since Click's is_flag=True + envvar
-    # treats any non-empty value (including "false") as True
-    if not verbose:  # Only check env var if not already set via CLI flag
-        env_verbose = os.environ.get("KARAKEEP_PYTHON_API_VERBOSE", "").lower()
-        verbose = env_verbose in ("true", "1", "yes")
-
     # Store common API parameters in the context for commands to use
     ctx.obj["API_ENDPOINT"] = resolved_api_endpoint  # Store the resolved endpoint
     ctx.obj["API_KEY"] = resolved_api_key  # Store the resolved key
@@ -200,21 +194,6 @@ def cli(
     )
     ctx.obj["ENSURE_ASCII"] = ensure_ascii  # Store the ensure_ascii flag
 
-    # --- Configure Logger ---
-    log_level = "DEBUG" if verbose else "INFO"
-    logger.remove()  # Remove default handler
-    if verbose:
-        logger.add(
-            sys.stderr,
-            level=log_level,
-            format="<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>",
-        )
-        logger.debug("Verbose logging enabled with detailed format.")
-    else:
-        logger.add(sys.stderr, level=log_level)  # Default format for INFO
-    logger.debug("Logger configured for level: {}", log_level)
-    logger.debug("CLI context initialized.")
-
 
 def create_click_command(
     api_method_name: str, api_method: Callable

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3}/karakeep_python_api/datatypes.py

@@ -51,6 +51,7 @@ class ContentTypeLink(BaseModel):
     videoAssetId: Optional[str] = None
     favicon: Optional[str] = None
     htmlContent: Optional[str] = None
+    contentAssetId: Optional[str] = None
     crawledAt: Optional[str] = None
     author: Optional[str] = None
     publisher: Optional[str] = None
@@ -81,6 +82,7 @@ class ContentTypeAsset(BaseModel):
 class BookmarkAsset(BaseModel):
     id: str
     assetType: Literal[
+        "linkHtmlContent",
         "screenshot",
         "assetScreenshot",
         "bannerImage",

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3}/karakeep_python_api/karakeep_api.py

@@ -85,7 +85,7 @@ class KarakeepAPI:
     """
 
     # Version reflects the client library version, updated by bumpver
-    VERSION: str = "1.2.1"
+    VERSION: str = "1.2.3"
 
     def __init__(
         self,
@@ -93,7 +93,7 @@ class KarakeepAPI:
         api_endpoint: Optional[str] = None,
         openapi_spec_path: Optional[str] = None,  # Allow None, default handled below
         verify_ssl: bool = True,
-        verbose: bool = False,
+        verbose: Optional[bool] = None,
         disable_response_validation: Optional[bool] = None,
         rate_limit: Union[
             float, int
@@ -113,8 +113,8 @@ class KarakeepAPI:
                                The loaded spec is available via the `openapi_spec` attribute.
             verify_ssl: Whether to verify SSL certificates (default: True).
                         Can be overridden with KARAKEEP_PYTHON_API_VERIFY_SSL environment variable (true/false).
-            verbose: Enable verbose logging (default: False).
-                     Can be overridden with KARAKEEP_PYTHON_API_VERBOSE environment variable (true/false).
+            verbose: Enable verbose logging. If None (default), reads from KARAKEEP_PYTHON_API_VERBOSE environment variable.
+                     If True or False, uses the explicit value regardless of environment variable.
             disable_response_validation: If True, skip Pydantic validation of API responses and return raw data.
                                          Defaults to False. Can be overridden by setting the
                                          KARAKEEP_PYTHON_API_DISABLE_RESPONSE_VALIDATION environment variable to "true".
@@ -122,6 +122,32 @@ class KarakeepAPI:
                         Defaults to 0.0 (no explicit rate limiting).
                         Can be overridden with KARAKEEP_PYTHON_API_RATE_LIMIT environment variable.
         """
+        # --- Verbose Setting and Logger Configuration ---
+        # Handle verbose environment variable if not explicitly provided
+        if verbose is None:
+            env_verbose = os.environ.get("KARAKEEP_PYTHON_API_VERBOSE", "").lower()
+            self.verbose = env_verbose in ("true", "1", "yes")
+            verbose_mess = f"Verbose set to {self.verbose} from KARAKEEP_PYTHON_API_VERBOSE environment variable."
+        else:
+            self.verbose = verbose
+            verbose_mess = f"Verbose explicitly set to {self.verbose} via argument."
+
+        # Configure logger based on verbose setting
+        log_level = "DEBUG" if self.verbose else "INFO"
+        logger.remove()  # Remove default handler
+        if self.verbose:
+            logger.add(
+                sys.stderr,
+                level=log_level,
+                format="<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>",
+            )
+            logger.debug("Verbose logging enabled with detailed format.")
+        else:
+            logger.add(sys.stderr, level=log_level)  # Default format for INFO
+
+        logger.debug(verbose_mess)
+        logger.debug("Logger configured for level: {}", log_level)
+
         # --- API Key Validation ---
         resolved_api_key = api_key or os.environ.get("KARAKEEP_PYTHON_API_KEY")
         if not resolved_api_key:
@@ -210,7 +236,6 @@ class KarakeepAPI:
             # raise APIError(f"Failed to load OpenAPI spec: {openapi_spec_path}") from e
 
         self.verify_ssl = verify_ssl
-        self.verbose = verbose
 
         # --- Rate Limit Setting ---
         # Argument takes precedence over environment variable
@@ -253,10 +278,6 @@ class KarakeepAPI:
                 f"Response validation set to {not self.disable_response_validation} via environment variable (KARAKEEP_PYTHON_API_DISABLE_RESPONSE_VALIDATION={env_disable_validation})."
             )
 
-        # Logger configuration is now handled by the calling application (e.g., __main__.py)
-        # or defaults to loguru's standard setup if KarakeepAPI is used as a library.
-        # self.verbose is still used for conditional logging within the class methods.
-
         logger.debug("KarakeepAPI client initialized.")
         logger.debug(f"  Endpoint: {self.api_endpoint}")
         logger.debug(f"  Verify SSL: {self.verify_ssl}")

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3}/karakeep_python_api/openapi_reference.json

@@ -174,6 +174,10 @@
                     "type": "string",
                     "nullable": true
                   },
+                  "contentAssetId": {
+                    "type": "string",
+                    "nullable": true
+                  },
                   "crawledAt": {
                     "type": "string",
                     "nullable": true
@@ -291,6 +295,7 @@
                 "assetType": {
                   "type": "string",
                   "enum": [
+                    "linkHtmlContent",
                     "screenshot",
                     "assetScreenshot",
                     "bannerImage",
@@ -1551,6 +1556,7 @@
                   "assetType": {
                     "type": "string",
                     "enum": [
+                      "linkHtmlContent",
                       "screenshot",
                       "assetScreenshot",
                       "bannerImage",
@@ -1584,6 +1590,7 @@
                     "assetType": {
                       "type": "string",
                       "enum": [
+                        "linkHtmlContent",
                         "screenshot",
                         "assetScreenshot",
                         "bannerImage",
@@ -3038,6 +3045,145 @@
                     },
                     "numHighlights": {
                       "type": "number"
+                    },
+                    "bookmarksByType": {
+                      "type": "object",
+                      "properties": {
+                        "link": {
+                          "type": "number"
+                        },
+                        "text": {
+                          "type": "number"
+                        },
+                        "asset": {
+                          "type": "number"
+                        }
+                      },
+                      "required": [
+                        "link",
+                        "text",
+                        "asset"
+                      ]
+                    },
+                    "topDomains": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "domain": {
+                            "type": "string"
+                          },
+                          "count": {
+                            "type": "number"
+                          }
+                        },
+                        "required": [
+                          "domain",
+                          "count"
+                        ]
+                      },
+                      "maxItems": 10
+                    },
+                    "totalAssetSize": {
+                      "type": "number"
+                    },
+                    "assetsByType": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "type": "string"
+                          },
+                          "count": {
+                            "type": "number"
+                          },
+                          "totalSize": {
+                            "type": "number"
+                          }
+                        },
+                        "required": [
+                          "type",
+                          "count",
+                          "totalSize"
+                        ]
+                      }
+                    },
+                    "bookmarkingActivity": {
+                      "type": "object",
+                      "properties": {
+                        "thisWeek": {
+                          "type": "number"
+                        },
+                        "thisMonth": {
+                          "type": "number"
+                        },
+                        "thisYear": {
+                          "type": "number"
+                        },
+                        "byHour": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "hour": {
+                                "type": "number"
+                              },
+                              "count": {
+                                "type": "number"
+                              }
+                            },
+                            "required": [
+                              "hour",
+                              "count"
+                            ]
+                          }
+                        },
+                        "byDayOfWeek": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "day": {
+                                "type": "number"
+                              },
+                              "count": {
+                                "type": "number"
+                              }
+                            },
+                            "required": [
+                              "day",
+                              "count"
+                            ]
+                          }
+                        }
+                      },
+                      "required": [
+                        "thisWeek",
+                        "thisMonth",
+                        "thisYear",
+                        "byHour",
+                        "byDayOfWeek"
+                      ]
+                    },
+                    "tagUsage": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "name": {
+                            "type": "string"
+                          },
+                          "count": {
+                            "type": "number"
+                          }
+                        },
+                        "required": [
+                          "name",
+                          "count"
+                        ]
+                      },
+                      "maxItems": 10
                     }
                   },
                   "required": [
@@ -3046,7 +3192,13 @@
                     "numArchived",
                     "numTags",
                     "numLists",
-                    "numHighlights"
+                    "numHighlights",
+                    "bookmarksByType",
+                    "topDomains",
+                    "totalAssetSize",
+                    "assetsByType",
+                    "bookmarkingActivity",
+                    "tagUsage"
                   ]
                 }
               }

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3/karakeep_python_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karakeep_python_api
-Version: 1.2.1
+Version: 1.2.3
 Summary: Community python client for the Karakeep API.
 Home-page: https://github.com/thiswillbeyourgithub/karakeep_python_api/
 License: GPLv3
@@ -12,7 +12,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.32.3
-Requires-Dist: loguru
+Requires-Dist: loguru>=0.7.3
 Requires-Dist: pydantic>=2.0
 Requires-Dist: click>=8.0
 Provides-Extra: dev

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3}/karakeep_python_api.egg-info/requires.txt

@@ -1,5 +1,5 @@
 requests>=2.32.3
-loguru
+loguru>=0.7.3
 pydantic>=2.0
 click>=8.0
 

{karakeep_python_api-1.2.1 → karakeep_python_api-1.2.3}/setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r") as readme:
 
 setup(
     name="karakeep_python_api",
-    version="1.2.1",
+    version="1.2.3",
     description="Community python client for the Karakeep API.",  # Simplified description
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -33,7 +33,7 @@ setup(
     python_requires=">=3.9",
     install_requires=[
         "requests >= 2.32.3",
-        "loguru",
+        "loguru >= 0.7.3",
         "pydantic >= 2.0",  # For data validation and modeling based on datatypes.py
         "click >= 8.0",  # For the CLI
     ],