karakeep-python-api 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

karakeep_python_api/karakeep_api.py

@@ -85,7 +85,7 @@ class KarakeepAPI:
     """
 
     # Version reflects the client library version, updated by bumpver
-    VERSION: str = "0.1.2"
+    VERSION: str = "0.1.3"
 
     def __init__(
         self,
@@ -1435,6 +1435,11 @@ class KarakeepAPI:
             logger.debug("Skipping response validation as requested.")
             return response_data
         else:
+            # As of version 0.24.1 of karakeep: we do not check the correct
+            # validation type because there is an error on the
+            # server side: https://github.com/karakeep-app/karakeep/issues/1365
+            return response_data
+
             # Response should match Tag1 schema
             return datatypes.Tag1.model_validate(response_data)
 

karakeep_python_api/openapi_reference.json

@@ -2898,4 +2898,4 @@
       }
     }
   }
-}
+}

{karakeep_python_api-0.1.2.dist-info → karakeep_python_api-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karakeep_python_api
-Version: 0.1.2
+Version: 0.1.3
 Summary: Community python client for the Karakeep API.
 Home-page: https://github.com/thiswillbeyourgithub/karakeep_python_api/
 License: GPLv3
@@ -72,43 +72,46 @@ The development process involved:
 
 ## API Method Coverage
 
-The following table lists the public methods available in the `KarakeepAPI` class and indicates whether they are currently covered by the automated test suite (`tests/test_karakeep_api.py`). Methods marked as "No" should be used with caution as their behavior has not been automatically verified.
-
-| Method Name                      | Tested | Remarks                                      |
-| -------------------------------- | :----: | -------------------------------------------- |
-| `get_all_bookmarks`              |   ✅   | Tested with pagination.                      |
-| `create_a_new_bookmark`          |   ✅   | Only tested for `type="link"`.               |
-| `search_bookmarks`               |   ✅   | Tested as part of create/delete flow.        |
-| `get_a_single_bookmark`          |   ✅   | Tested as part of create/delete flow.        |
-| `delete_a_bookmark`              |   ✅   | Tested as part of create/delete flow.        |
-| `update_a_bookmark`              |   ✅   | Tested for title updates.                    |
-| `summarize_a_bookmark`           |   ❌   |                                              |
-| `attach_tags_to_a_bookmark`      |   ❌   |                                              |
-| `detach_tags_from_a_bookmark`    |   ❌   |                                              |
-| `get_highlights_of_a_bookmark`   |   ❌   |                                              |
-| `attach_asset`                   |   ❌   |                                              |
-| `replace_asset`                  |   ❌   |                                              |
-| `detach_asset`                   |   ❌   |                                              |
-| `get_all_lists`                  |   ✅   |                                              |
-| `create_a_new_list`              |   ✅   | Tested as part of create/delete flow.        |
-| `get_a_single_list`              |   ✅   | Tested as part of create/delete flow.        |
-| `delete_a_list`                  |   ✅   | Tested as part of create/delete flow.        |
-| `update_a_list`                  |   ❌   |                                              |
-| `get_a_bookmarks_in_a_list`      |   ❌   |                                              |
-| `add_a_bookmark_to_a_list`       |   ❌   |                                              |
-| `remove_a_bookmark_from_a_list`  |   ❌   |                                              |
-| `get_all_tags`                   |   ✅   |                                              |
-| `get_a_single_tag`               |   ❌   |                                              |
-| `delete_a_tag`                   |   ❌   |                                              |
-| `update_a_tag`                   |   ❌   |                                              |
-| `get_a_bookmarks_with_the_tag`   |   ❌   |                                              |
-| `get_all_highlights`             |   ✅   | Tested with pagination.                      |
-| `create_a_new_highlight`         |   ❌   |                                              |
-| `get_a_single_highlight`         |   ❌   |                                              |
-| `delete_a_highlight`             |   ❌   |                                              |
-| `update_a_highlight`             |   ❌   |                                              |
-| `get_current_user_info`          |   ✅   | Tested indirectly during client initialization. |
-| `get_current_user_stats`         |   ✅   |                                              |
+The following table lists the public methods available in the `KarakeepAPI` class.
+*   The "Pytest" column indicates whether the Python library method is covered by the automated test suite (`tests/test_karakeep_api.py`).
+*   The "CLI" column indicates whether the corresponding CLI command for that method is tested within the Pytest suite (typically via `subprocess`).
+Methods or CLI commands marked with ❌ should be used with caution as their behavior has not been automatically verified within the test suite.
+
+| Method Name                      | Pytest | CLI  | Remarks                                      |
+| -------------------------------- | :----: | :--: | -------------------------------------------- |
+| `get_all_bookmarks`              |   ✅   |  ✅  | Tested with pagination.                      |
+| `create_a_new_bookmark`          |   ✅   |  ❌  | Pytest for `type="link"` via fixture. CLI not directly tested. |
+| `search_bookmarks`               |   ✅   |  ✅  | Seems to be nondeterministic and fails if using more than 3 words        |
+| `get_a_single_bookmark`          |   ✅   |  ❌  |  |
+| `delete_a_bookmark`              |   ✅   |  ❌  |  |
+| `update_a_bookmark`              |   ✅   |  ✅  | Tested for title updates.                    |
+| `summarize_a_bookmark`           |   ❌   |  ❌  |                                              |
+| `attach_tags_to_a_bookmark`      |   ✅   |  ❌  |  |
+| `detach_tags_from_a_bookmark`    |   ✅   |  ❌  |  |
+| `get_highlights_of_a_bookmark`   |   ❌   |  ❌  | Works from the CLI; not yet added to Pytest. |
+| `attach_asset`                   |   ❌   |  ❌  |                                              |
+| `replace_asset`                  |   ❌   |  ❌  |                                              |
+| `detach_asset`                   |   ❌   |  ❌  |                                              |
+| `get_all_lists`                  |   ✅   |  ✅  |                                              |
+| `create_a_new_list`              |   ✅   |  ❌  | |
+| `get_a_single_list`              |   ✅   |  ❌  | |
+| `delete_a_list`                  |   ✅   |  ❌  | |
+| `update_a_list`                  |   ❌   |  ❌  |                                              |
+| `get_a_bookmarks_in_a_list`      |   ❌   |  ❌  |                                              |
+| `add_a_bookmark_to_a_list`       |   ❌   |  ❌  |                                              |
+| `remove_a_bookmark_from_a_list`  |   ❌   |  ❌  |                                              |
+| `get_all_tags`                   |   ✅   |  ✅  |                                              |
+| `get_a_single_tag`               |   ✅   |  ❌  |  |
+| `delete_a_tag`                   |   ✅   |  ❌  |  |
+| `update_a_tag`                   |   ✅   |  ❌  |  No output validation due to [server bug](https://github.com/karakeep-app/karakeep/issues/1365). |
+| `get_a_bookmarks_with_the_tag`   |   ❌   |  ❌  |                                              |
+| `get_all_highlights`             |   ✅   |  ✅  | Tested with pagination.                      |
+| `create_a_new_highlight`         |   ❌   |  ❌  |                                              |
+| `get_a_single_highlight`         |   ❌   |  ❌  |                                              |
+| `delete_a_highlight`             |   ❌   |  ❌  | Works from the CLI; not yet added to Pytest. |
+| `update_a_highlight`             |   ❌   |  ❌  |                                              |
+| `get_current_user_info`          |   ✅   |  ❌  | Pytest: Tested indirectly during client init. CLI not directly tested. |
+| `get_current_user_stats`         |   ✅   |  ✅  |                                              |
 
 ## Installation
 

karakeep_python_api-0.1.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+karakeep_python_api/__init__.py,sha256=qk3MeIIvnCNAyYzJrv8dMKVXvA4ejLU3mhB3xFzdLDY,606
+karakeep_python_api/__main__.py,sha256=LWRNJpo9I0J-K-bNXPuQDCIR5s3YrePWmsONW2uz8fY,24272
+karakeep_python_api/datatypes.py,sha256=nVuaFB-BaNcTdzNqLvHBG0OlgoXdi0NxL0Rr_jqOPao,4189
+karakeep_python_api/karakeep_api.py,sha256=hljMNPoFsRvniRNEjj6jV6A9YupwYlVB74qgyx58CTM,73109
+karakeep_python_api/openapi_reference.json,sha256=SqhEHE526dmsw07b3YkRkfhiyO6-BjCvFHpR5-l6dyU,77103
+karakeep_python_api-0.1.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+karakeep_python_api-0.1.3.dist-info/METADATA,sha256=aqy5O2_7e79TzalE5uHTiIz2hz2FubGAE_NxRMwYXqc,12211
+karakeep_python_api-0.1.3.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+karakeep_python_api-0.1.3.dist-info/entry_points.txt,sha256=n0leQp_IX2NivoWuUcaR9ZHwAvl_6yt-NcHWuCJyxNo,62
+karakeep_python_api-0.1.3.dist-info/top_level.txt,sha256=X3VKqh9YAbPQp144db0Ko2C5Q2y6-nwpPgtnuCiSDmU,20
+karakeep_python_api-0.1.3.dist-info/RECORD,,

karakeep_python_api-0.1.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-karakeep_python_api/__init__.py,sha256=qk3MeIIvnCNAyYzJrv8dMKVXvA4ejLU3mhB3xFzdLDY,606
-karakeep_python_api/__main__.py,sha256=LWRNJpo9I0J-K-bNXPuQDCIR5s3YrePWmsONW2uz8fY,24272
-karakeep_python_api/datatypes.py,sha256=nVuaFB-BaNcTdzNqLvHBG0OlgoXdi0NxL0Rr_jqOPao,4189
-karakeep_python_api/karakeep_api.py,sha256=IJt6EUV5Owh1yO74WZsRs6lqbpOqZGuDfYHLc8azBXk,72856
-karakeep_python_api/openapi_reference.json,sha256=2sQRiQs8xwNFmsksqWGmqnsUMr8vqhHag9GNZDmnVUk,77104
-karakeep_python_api-0.1.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-karakeep_python_api-0.1.2.dist-info/METADATA,sha256=Ps-oGM6QWZCXGRS7-_EYIYcQ9OJwM4nCxCRIPW06IOk,11992
-karakeep_python_api-0.1.2.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-karakeep_python_api-0.1.2.dist-info/entry_points.txt,sha256=n0leQp_IX2NivoWuUcaR9ZHwAvl_6yt-NcHWuCJyxNo,62
-karakeep_python_api-0.1.2.dist-info/top_level.txt,sha256=X3VKqh9YAbPQp144db0Ko2C5Q2y6-nwpPgtnuCiSDmU,20
-karakeep_python_api-0.1.2.dist-info/RECORD,,