karakeep-python-api 1.6.0__tar.gz → 1.7.0__tar.gz

{karakeep_python_api-1.6.0/karakeep_python_api.egg-info → karakeep_python_api-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karakeep_python_api
-Version: 1.6.0
+Version: 1.7.0
 Summary: Community python client for the Karakeep API.
 Home-page: https://github.com/thiswillbeyourgithub/karakeep_python_api/
 Keywords: rss,karakeep,hoarder,data-hoarding,python,api,feeds,openapi

{karakeep_python_api-1.6.0 → karakeep_python_api-1.7.0}/karakeep_python_api/datatypes.py

@@ -136,6 +136,10 @@ class PaginatedBookmarks(BaseModel):
     nextCursor: Optional[str] = ""
 
 
+class CheckUrlResponse(BaseModel):
+    bookmarkId: Optional[str]
+
+
 class ListModel(BaseModel):
     id: str
     name: str

{karakeep_python_api-1.6.0 → karakeep_python_api-1.7.0}/karakeep_python_api/karakeep_api.py

@@ -85,7 +85,7 @@ class KarakeepAPI:
     """
 
     # Version reflects the client library version, updated by bumpver
-    VERSION: str = "1.6.0"
+    VERSION: str = "1.7.0"
 
     def __init__(
         self,
@@ -930,6 +930,38 @@ class KarakeepAPI:
             # Response should match PaginatedBookmarks schema
             return datatypes.PaginatedBookmarks.model_validate(response_data)
 
+    @optional_typecheck
+    def check_url(
+        self,
+        url: str,
+    ) -> Union[datatypes.CheckUrlResponse, Dict[str, Any], List[Any]]:
+        """
+        Check if a URL is already bookmarked. Corresponds to GET /bookmarks/check-url.
+        Uses substring matching to find candidates, then normalizes URLs (ignoring hash fragments and trailing slashes) for exact comparison.
+
+        Args:
+            url: The URL to check.
+
+        Returns:
+            datatypes.CheckUrlResponse: Object indicating whether the URL is bookmarked. bookmarkId is null if not found.
+            If response validation is disabled, returns the raw API response (dict/list).
+
+        Raises:
+            APIError: If the API request fails.
+            pydantic.ValidationError: If response validation fails (and is not disabled).
+        """
+        params = {
+            "url": url,
+        }
+        response_data = self._call("GET", "bookmarks/check-url", params=params)
+
+        if self.disable_response_validation:
+            logger.debug("Skipping response validation as requested.")
+            return response_data
+        else:
+            # Response should match CheckUrlResponse schema
+            return datatypes.CheckUrlResponse.model_validate(response_data)
+
     @optional_typecheck
     def get_a_single_bookmark(
         self,
@@ -1048,6 +1080,7 @@ class KarakeepAPI:
         bookmark_id: str,
         tag_ids: Optional[List[str]] = None,
         tag_names: Optional[List[str]] = None,
+        attached_by: Optional[Literal["ai", "human"]] = "human",
     ) -> Dict[str, Any]:
         """
         Attach one or more tags to a bookmark. Corresponds to POST /bookmarks/{bookmarkId}/tags.
@@ -1056,6 +1089,7 @@ class KarakeepAPI:
             bookmark_id: The ID (string) of the bookmark.
             tag_ids: List of existing tag IDs to attach (optional).
             tag_names: List of tag names to attach (will create tags if they don't exist) (optional).
+            attached_by: Who attached the tag, either "ai" or "human" (default: "human").
 
         Returns:
             dict: A dictionary containing the list of attached tag IDs under the key "attached".
@@ -1097,11 +1131,17 @@ class KarakeepAPI:
 
         if tag_ids:
             for tag_id in tag_ids:
-                tags_list.append({"tagId": tag_id.strip()})
+                tag_entry: Dict[str, Any] = {"tagId": tag_id.strip()}
+                if attached_by is not None:
+                    tag_entry["attachedBy"] = attached_by
+                tags_list.append(tag_entry)
 
         if tag_names:
             for tag_name in tag_names:
-                tags_list.append({"tagName": tag_name.strip()})
+                tag_entry = {"tagName": tag_name.strip()}
+                if attached_by is not None:
+                    tag_entry["attachedBy"] = attached_by
+                tags_list.append(tag_entry)
 
         tags_data = {"tags": tags_list}
 
@@ -1123,6 +1163,7 @@ class KarakeepAPI:
         bookmark_id: str,
         tag_ids: Optional[List[str]] = None,
         tag_names: Optional[List[str]] = None,
+        attached_by: Optional[Literal["ai", "human"]] = "human",
     ) -> Dict[str, Any]:
         """
         Detach one or more tags from a bookmark. Corresponds to DELETE /bookmarks/{bookmarkId}/tags.
@@ -1131,6 +1172,7 @@ class KarakeepAPI:
             bookmark_id: The ID (string) of the bookmark.
             tag_ids: List of existing tag IDs to detach (optional).
             tag_names: List of tag names to detach (optional).
+            attached_by: Who attached the tag, either "ai" or "human" (default: "human").
 
         Returns:
             dict: A dictionary containing the list of detached tag IDs under the key "detached".
@@ -1172,11 +1214,17 @@ class KarakeepAPI:
 
         if tag_ids:
             for tag_id in tag_ids:
-                tags_list.append({"tagId": tag_id.strip()})
+                tag_entry: Dict[str, Any] = {"tagId": tag_id.strip()}
+                if attached_by is not None:
+                    tag_entry["attachedBy"] = attached_by
+                tags_list.append(tag_entry)
 
         if tag_names:
             for tag_name in tag_names:
-                tags_list.append({"tagName": tag_name.strip()})
+                tag_entry = {"tagName": tag_name.strip()}
+                if attached_by is not None:
+                    tag_entry["attachedBy"] = attached_by
+                tags_list.append(tag_entry)
 
         tags_data = {"tags": tags_list}
 

{karakeep_python_api-1.6.0 → karakeep_python_api-1.7.0}/karakeep_python_api/openapi_reference.json

@@ -983,6 +983,51 @@
         }
       }
     },
+    "/bookmarks/check-url": {
+      "get": {
+        "description": "Check if a URL is already bookmarked. Uses substring matching to find candidates, then normalizes URLs (ignoring hash fragments and trailing slashes) for exact comparison.",
+        "summary": "Check if a URL exists in bookmarks",
+        "tags": [
+          "Bookmarks"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "name": "url",
+            "in": "query"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Object indicating whether the URL is bookmarked. bookmarkId is null if not found.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "bookmarkId": {
+                      "type": "string",
+                      "nullable": true
+                    }
+                  },
+                  "required": [
+                    "bookmarkId"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/bookmarks/{bookmarkId}": {
       "get": {
         "description": "Get bookmark by its id",
@@ -1445,6 +1490,14 @@
                         },
                         "tagName": {
                           "type": "string"
+                        },
+                        "attachedBy": {
+                          "type": "string",
+                          "enum": [
+                            "ai",
+                            "human"
+                          ],
+                          "default": "human"
                         }
                       }
                     }
@@ -1536,6 +1589,14 @@
                         },
                         "tagName": {
                           "type": "string"
+                        },
+                        "attachedBy": {
+                          "type": "string",
+                          "enum": [
+                            "ai",
+                            "human"
+                          ],
+                          "default": "human"
                         }
                       }
                     }

{karakeep_python_api-1.6.0 → karakeep_python_api-1.7.0/karakeep_python_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karakeep_python_api
-Version: 1.6.0
+Version: 1.7.0
 Summary: Community python client for the Karakeep API.
 Home-page: https://github.com/thiswillbeyourgithub/karakeep_python_api/
 Keywords: rss,karakeep,hoarder,data-hoarding,python,api,feeds,openapi

{karakeep_python_api-1.6.0 → karakeep_python_api-1.7.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r") as readme:
 
 setup(
     name="karakeep_python_api",
-    version="1.6.0",
+    version="1.7.0",
     description="Community python client for the Karakeep API.",  # Simplified description
     long_description=long_description,
     long_description_content_type="text/markdown",