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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/LICENSE +67 -80
  2. {karakeep_python_api-1.4.1/karakeep_python_api.egg-info → karakeep_python_api-1.6.0}/PKG-INFO +8 -10
  3. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/README.md +7 -6
  4. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api/datatypes.py +20 -0
  5. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api/karakeep_api.py +197 -5
  6. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api/openapi_reference.json +445 -4
  7. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0/karakeep_python_api.egg-info}/PKG-INFO +8 -10
  8. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/setup.py +1 -3
  9. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/tests/test_karakeep_api.py +130 -0
  10. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/MANIFEST.in +0 -0
  11. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api/__init__.py +0 -0
  12. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api/__main__.py +0 -0
  13. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api.egg-info/SOURCES.txt +0 -0
  14. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api.egg-info/dependency_links.txt +0 -0
  15. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api.egg-info/entry_points.txt +0 -0
  16. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api.egg-info/requires.txt +0 -0
  17. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/karakeep_python_api.egg-info/top_level.txt +0 -0
  18. {karakeep_python_api-1.4.1 → karakeep_python_api-1.6.0}/setup.cfg +0 -0
@@ -1,5 +1,5 @@
1
- GNU GENERAL PUBLIC LICENSE
2
- Version 3, 29 June 2007
1
+ GNU AFFERO GENERAL PUBLIC LICENSE
2
+ Version 3, 19 November 2007
3
3
 
4
4
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
5
  Everyone is permitted to copy and distribute verbatim copies
@@ -7,17 +7,15 @@
7
7
 
8
8
  Preamble
9
9
 
10
- The GNU General Public License is a free, copyleft license for
11
- software and other kinds of works.
10
+ The GNU Affero General Public License is a free, copyleft license for
11
+ software and other kinds of works, specifically designed to ensure
12
+ cooperation with the community in the case of network server software.
12
13
 
13
14
  The licenses for most software and other practical works are designed
14
15
  to take away your freedom to share and change the works. By contrast,
15
- the GNU General Public License is intended to guarantee your freedom to
16
+ our General Public Licenses are intended to guarantee your freedom to
16
17
  share and change all versions of a program--to make sure it remains free
17
- software for all its users. We, the Free Software Foundation, use the
18
- GNU General Public License for most of our software; it applies also to
19
- any other work released this way by its authors. You can apply it to
20
- your programs, too.
18
+ software for all its users.
21
19
 
22
20
  When we speak of free software, we are referring to freedom, not
23
21
  price. Our General Public Licenses are designed to make sure that you
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
26
24
  want it, that you can change the software or use pieces of it in new
27
25
  free programs, and that you know you can do these things.
28
26
 
29
- To protect your rights, we need to prevent others from denying you
30
- these rights or asking you to surrender the rights. Therefore, you have
31
- certain responsibilities if you distribute copies of the software, or if
32
- you modify it: responsibilities to respect the freedom of others.
33
-
34
- For example, if you distribute copies of such a program, whether
35
- gratis or for a fee, you must pass on to the recipients the same
36
- freedoms that you received. You must make sure that they, too, receive
37
- or can get the source code. And you must show them these terms so they
38
- know their rights.
39
-
40
- Developers that use the GNU GPL protect your rights with two steps:
41
- (1) assert copyright on the software, and (2) offer you this License
42
- giving you legal permission to copy, distribute and/or modify it.
43
-
44
- For the developers' and authors' protection, the GPL clearly explains
45
- that there is no warranty for this free software. For both users' and
46
- authors' sake, the GPL requires that modified versions be marked as
47
- changed, so that their problems will not be attributed erroneously to
48
- authors of previous versions.
49
-
50
- Some devices are designed to deny users access to install or run
51
- modified versions of the software inside them, although the manufacturer
52
- can do so. This is fundamentally incompatible with the aim of
53
- protecting users' freedom to change the software. The systematic
54
- pattern of such abuse occurs in the area of products for individuals to
55
- use, which is precisely where it is most unacceptable. Therefore, we
56
- have designed this version of the GPL to prohibit the practice for those
57
- products. If such problems arise substantially in other domains, we
58
- stand ready to extend this provision to those domains in future versions
59
- of the GPL, as needed to protect the freedom of users.
60
-
61
- Finally, every program is threatened constantly by software patents.
62
- States should not allow patents to restrict development and use of
63
- software on general-purpose computers, but in those that do, we wish to
64
- avoid the special danger that patents applied to a free program could
65
- make it effectively proprietary. To prevent this, the GPL assures that
66
- patents cannot be used to render the program non-free.
27
+ Developers that use our General Public Licenses protect your rights
28
+ with two steps: (1) assert copyright on the software, and (2) offer
29
+ you this License which gives you legal permission to copy, distribute
30
+ and/or modify the software.
31
+
32
+ A secondary benefit of defending all users' freedom is that
33
+ improvements made in alternate versions of the program, if they
34
+ receive widespread use, become available for other developers to
35
+ incorporate. Many developers of free software are heartened and
36
+ encouraged by the resulting cooperation. However, in the case of
37
+ software used on network servers, this result may fail to come about.
38
+ The GNU General Public License permits making a modified version and
39
+ letting the public access it on a server without ever releasing its
40
+ source code to the public.
41
+
42
+ The GNU Affero General Public License is designed specifically to
43
+ ensure that, in such cases, the modified source code becomes available
44
+ to the community. It requires the operator of a network server to
45
+ provide the source code of the modified version running there to the
46
+ users of that server. Therefore, public use of a modified version, on
47
+ a publicly accessible server, gives the public access to the source
48
+ code of the modified version.
49
+
50
+ An older license, called the Affero General Public License and
51
+ published by Affero, was designed to accomplish similar goals. This is
52
+ a different license, not a version of the Affero GPL, but Affero has
53
+ released a new version of the Affero GPL which permits relicensing under
54
+ this license.
67
55
 
68
56
  The precise terms and conditions for copying, distribution and
69
57
  modification follow.
@@ -72,7 +60,7 @@ modification follow.
72
60
 
73
61
  0. Definitions.
74
62
 
75
- "This License" refers to version 3 of the GNU General Public License.
63
+ "This License" refers to version 3 of the GNU Affero General Public License.
76
64
 
77
65
  "Copyright" also means copyright-like laws that apply to other kinds of
78
66
  works, such as semiconductor masks.
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
549
537
  the Program, the only way you could satisfy both those terms and this
550
538
  License would be to refrain entirely from conveying the Program.
551
539
 
552
- 13. Use with the GNU Affero General Public License.
540
+ 13. Remote Network Interaction; Use with the GNU General Public License.
541
+
542
+ Notwithstanding any other provision of this License, if you modify the
543
+ Program, your modified version must prominently offer all users
544
+ interacting with it remotely through a computer network (if your version
545
+ supports such interaction) an opportunity to receive the Corresponding
546
+ Source of your version by providing access to the Corresponding Source
547
+ from a network server at no charge, through some standard or customary
548
+ means of facilitating copying of software. This Corresponding Source
549
+ shall include the Corresponding Source for any work covered by version 3
550
+ of the GNU General Public License that is incorporated pursuant to the
551
+ following paragraph.
553
552
 
554
553
  Notwithstanding any other provision of this License, you have
555
554
  permission to link or combine any covered work with a work licensed
556
- under version 3 of the GNU Affero General Public License into a single
555
+ under version 3 of the GNU General Public License into a single
557
556
  combined work, and to convey the resulting work. The terms of this
558
557
  License will continue to apply to the part which is the covered work,
559
- but the special requirements of the GNU Affero General Public License,
560
- section 13, concerning interaction through a network will apply to the
561
- combination as such.
558
+ but the work with which it is combined will remain governed by version
559
+ 3 of the GNU General Public License.
562
560
 
563
561
  14. Revised Versions of this License.
564
562
 
565
563
  The Free Software Foundation may publish revised and/or new versions of
566
- the GNU General Public License from time to time. Such new versions will
567
- be similar in spirit to the present version, but may differ in detail to
564
+ the GNU Affero General Public License from time to time. Such new versions
565
+ will be similar in spirit to the present version, but may differ in detail to
568
566
  address new problems or concerns.
569
567
 
570
568
  Each version is given a distinguishing version number. If the
571
- Program specifies that a certain numbered version of the GNU General
569
+ Program specifies that a certain numbered version of the GNU Affero General
572
570
  Public License "or any later version" applies to it, you have the
573
571
  option of following the terms and conditions either of that numbered
574
572
  version or of any later version published by the Free Software
575
573
  Foundation. If the Program does not specify a version number of the
576
- GNU General Public License, you may choose any version ever published
574
+ GNU Affero General Public License, you may choose any version ever published
577
575
  by the Free Software Foundation.
578
576
 
579
577
  If the Program specifies that a proxy can decide which future
580
- versions of the GNU General Public License can be used, that proxy's
578
+ versions of the GNU Affero General Public License can be used, that proxy's
581
579
  public statement of acceptance of a version permanently authorizes you
582
580
  to choose that version for the Program.
583
581
 
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
635
633
  Copyright (C) <year> <name of author>
636
634
 
637
635
  This program is free software: you can redistribute it and/or modify
638
- it under the terms of the GNU General Public License as published by
636
+ it under the terms of the GNU Affero General Public License as published by
639
637
  the Free Software Foundation, either version 3 of the License, or
640
638
  (at your option) any later version.
641
639
 
642
640
  This program is distributed in the hope that it will be useful,
643
641
  but WITHOUT ANY WARRANTY; without even the implied warranty of
644
642
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645
- GNU General Public License for more details.
643
+ GNU Affero General Public License for more details.
646
644
 
647
- You should have received a copy of the GNU General Public License
645
+ You should have received a copy of the GNU Affero General Public License
648
646
  along with this program. If not, see <https://www.gnu.org/licenses/>.
649
647
 
650
648
  Also add information on how to contact you by electronic and paper mail.
651
649
 
652
- If the program does terminal interaction, make it output a short
653
- notice like this when it starts in an interactive mode:
654
-
655
- <program> Copyright (C) <year> <name of author>
656
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
- This is free software, and you are welcome to redistribute it
658
- under certain conditions; type `show c' for details.
659
-
660
- The hypothetical commands `show w' and `show c' should show the appropriate
661
- parts of the General Public License. Of course, your program's commands
662
- might be different; for a GUI interface, you would use an "about box".
650
+ If your software can interact with users remotely through a computer
651
+ network, you should also make sure that it provides a way for users to
652
+ get its source. For example, if your program is a web application, its
653
+ interface could display a "Source" link that leads users to an archive
654
+ of the code. There are many ways you could offer source, and different
655
+ solutions will be better for different programs; see section 13 for the
656
+ specific requirements.
663
657
 
664
658
  You should also get your employer (if you work as a programmer) or school,
665
659
  if any, to sign a "copyright disclaimer" for the program, if necessary.
666
- For more information on this, and how to apply and follow the GNU GPL, see
660
+ For more information on this, and how to apply and follow the GNU AGPL, see
667
661
  <https://www.gnu.org/licenses/>.
668
-
669
- The GNU General Public License does not permit incorporating your program
670
- into proprietary programs. If your program is a subroutine library, you
671
- may consider it more useful to permit linking proprietary applications with
672
- the library. If this is what you want to do, use the GNU Lesser General
673
- Public License instead of this License. But first, please read
674
- <https://www.gnu.org/licenses/why-not-lgpl.html>.
@@ -1,12 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: karakeep_python_api
3
- Version: 1.4.1
3
+ Version: 1.6.0
4
4
  Summary: Community python client for the Karakeep API.
5
5
  Home-page: https://github.com/thiswillbeyourgithub/karakeep_python_api/
6
- License: GPLv3
7
6
  Keywords: rss,karakeep,hoarder,data-hoarding,python,api,feeds,openapi
8
7
  Classifier: Programming Language :: Python :: 3
9
- Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
10
8
  Classifier: Operating System :: OS Independent
11
9
  Requires-Python: >=3.9
12
10
  Description-Content-Type: text/markdown
@@ -26,7 +24,6 @@ Dynamic: description
26
24
  Dynamic: description-content-type
27
25
  Dynamic: home-page
28
26
  Dynamic: keywords
29
- Dynamic: license
30
27
  Dynamic: license-file
31
28
  Dynamic: provides-extra
32
29
  Dynamic: requires-dist
@@ -35,7 +32,6 @@ Dynamic: summary
35
32
 
36
33
  # Karakeep Python API Client
37
34
 
38
- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
39
35
  [![PyPI version](https://badge.fury.io/py/karakeep-python-api.svg)](https://badge.fury.io/py/karakeep-python-api)
40
36
 
41
37
  A community-developed Python client for the [Karakeep](https://karakeep.app/) API.
@@ -54,7 +50,6 @@ A community-developed Python client for the [Karakeep](https://karakeep.app/) AP
54
50
  - [Python Library](#python-library)
55
51
  - [Community Scripts](#community-scripts)
56
52
  - [Development](#development)
57
- - [License](#license)
58
53
 
59
54
  ## Overview
60
55
 
@@ -70,6 +65,7 @@ The development process involved:
70
65
 
71
66
  * **Experimental Methods:** The included Pytest suite currently only covers a subset of the available API methods (primarily 'get all' endpoints and client initialization). Methods *not* explicitly tested should be considered **experimental**.
72
67
  * **Ongoing Development:** The author intends to improve and validate methods as they are needed for personal use cases. Contributions and bug reports are welcome!
68
+ * **Updating process**: I have local scripts that downloads the latest OpenAPI specs from karakeep's repo. I then visually inspect the diff, stage a few changes into git, then run `aider --read karakeep_python_api/openapi_reference.json karakeep_python_api/karakeep_api.py karakeep_python_api/datatypes.py --message "As you can see from the git diff output, there was a small update to the openapi reference json file. Please update the python code to match this new update. Here is the git output: $(git --no-pager diff --staged) "`.
73
69
 
74
70
  ## API Method Coverage
75
71
 
@@ -116,7 +112,12 @@ Methods or CLI commands marked with ❌ should be used with caution as their beh
116
112
  | `get_a_single_asset` | ✅ | ❌ | Tested in PDF asset lifecycle test. |
117
113
  | `get_current_user_info` | ✅ | ❌ | Pytest: Tested indirectly during client init. CLI not directly tested. |
118
114
  | `get_current_user_stats` | ✅ | ✅ | |
119
- | `update_user` | ❌ | ❌ | |
115
+ | `update_user` | ❌ | ❌ | |
116
+ | `get_all_backups` | ✅ | ✅ | Tested in backup lifecycle test. |
117
+ | `trigger_a_new_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
118
+ | `get_a_single_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
119
+ | `delete_a_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
120
+ | `download_a_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
120
121
 
121
122
  ## Installation
122
123
 
@@ -277,9 +278,6 @@ They can be found in the [./community_scripts](https://github.com/thiswillbeyour
277
278
  pytest
278
279
  ```
279
280
 
280
- ## License
281
-
282
- This project is licensed under the **GNU General Public License v3 (GPLv3)**. See the [LICENSE](LICENSE) file for details.
283
281
 
284
282
  ---
285
283
 
@@ -1,6 +1,5 @@
1
1
  # Karakeep Python API Client
2
2
 
3
- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
4
3
  [![PyPI version](https://badge.fury.io/py/karakeep-python-api.svg)](https://badge.fury.io/py/karakeep-python-api)
5
4
 
6
5
  A community-developed Python client for the [Karakeep](https://karakeep.app/) API.
@@ -19,7 +18,6 @@ A community-developed Python client for the [Karakeep](https://karakeep.app/) AP
19
18
  - [Python Library](#python-library)
20
19
  - [Community Scripts](#community-scripts)
21
20
  - [Development](#development)
22
- - [License](#license)
23
21
 
24
22
  ## Overview
25
23
 
@@ -35,6 +33,7 @@ The development process involved:
35
33
 
36
34
  * **Experimental Methods:** The included Pytest suite currently only covers a subset of the available API methods (primarily 'get all' endpoints and client initialization). Methods *not* explicitly tested should be considered **experimental**.
37
35
  * **Ongoing Development:** The author intends to improve and validate methods as they are needed for personal use cases. Contributions and bug reports are welcome!
36
+ * **Updating process**: I have local scripts that downloads the latest OpenAPI specs from karakeep's repo. I then visually inspect the diff, stage a few changes into git, then run `aider --read karakeep_python_api/openapi_reference.json karakeep_python_api/karakeep_api.py karakeep_python_api/datatypes.py --message "As you can see from the git diff output, there was a small update to the openapi reference json file. Please update the python code to match this new update. Here is the git output: $(git --no-pager diff --staged) "`.
38
37
 
39
38
  ## API Method Coverage
40
39
 
@@ -81,7 +80,12 @@ Methods or CLI commands marked with ❌ should be used with caution as their beh
81
80
  | `get_a_single_asset` | ✅ | ❌ | Tested in PDF asset lifecycle test. |
82
81
  | `get_current_user_info` | ✅ | ❌ | Pytest: Tested indirectly during client init. CLI not directly tested. |
83
82
  | `get_current_user_stats` | ✅ | ✅ | |
84
- | `update_user` | ❌ | ❌ | |
83
+ | `update_user` | ❌ | ❌ | |
84
+ | `get_all_backups` | ✅ | ✅ | Tested in backup lifecycle test. |
85
+ | `trigger_a_new_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
86
+ | `get_a_single_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
87
+ | `delete_a_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
88
+ | `download_a_backup` | ✅ | ❌ | Tested in backup lifecycle test. |
85
89
 
86
90
  ## Installation
87
91
 
@@ -242,9 +246,6 @@ They can be found in the [./community_scripts](https://github.com/thiswillbeyour
242
246
  pytest
243
247
  ```
244
248
 
245
- ## License
246
-
247
- This project is licensed under the **GNU General Public License v3 (GPLv3)**. See the [LICENSE](LICENSE) file for details.
248
249
 
249
250
  ---
250
251
 
@@ -46,6 +46,7 @@ class ContentTypeLink(BaseModel):
46
46
  imageUrl: Optional[str] = None
47
47
  imageAssetId: Optional[str] = None
48
48
  screenshotAssetId: Optional[str] = None
49
+ pdfAssetId: Optional[str] = None
49
50
  fullPageArchiveAssetId: Optional[str] = None
50
51
  precrawledArchiveAssetId: Optional[str] = None
51
52
  videoAssetId: Optional[str] = None
@@ -53,6 +54,7 @@ class ContentTypeLink(BaseModel):
53
54
  htmlContent: Optional[str] = None
54
55
  contentAssetId: Optional[str] = None
55
56
  crawledAt: Optional[str] = None
57
+ crawlStatus: Optional[Literal["success", "failure", "pending"]] = None
56
58
  author: Optional[str] = None
57
59
  publisher: Optional[str] = None
58
60
  datePublished: Optional[str] = None
@@ -84,14 +86,18 @@ class BookmarkAsset(BaseModel):
84
86
  assetType: Literal[
85
87
  "linkHtmlContent",
86
88
  "screenshot",
89
+ "pdf",
87
90
  "assetScreenshot",
88
91
  "bannerImage",
89
92
  "fullPageArchive",
90
93
  "video",
91
94
  "bookmarkAsset",
92
95
  "precrawledArchive",
96
+ "userUploaded",
97
+ "avatar",
93
98
  "unknown",
94
99
  ]
100
+ fileName: Optional[str] = None
95
101
 
96
102
 
97
103
  class Asset(BaseModel):
@@ -117,6 +123,7 @@ class Bookmark(BaseModel):
117
123
  "api", "web", "cli", "mobile", "extension", "singlefile", "rss", "import"
118
124
  ]
119
125
  ] = None
126
+ userId: str
120
127
  tags: List[TagShort]
121
128
  content: Union[
122
129
  ContentTypeLink, ContentTypeText, ContentTypeAsset, ContentTypeUnknown
@@ -138,6 +145,8 @@ class ListModel(BaseModel):
138
145
  type: Optional[Literal["manual", "smart"]] = "manual"
139
146
  query: Optional[str] = None
140
147
  public: bool
148
+ hasCollaborators: bool
149
+ userRole: Literal["owner", "editor", "viewer", "public"]
141
150
 
142
151
 
143
152
  class Highlight(BaseModel):
@@ -160,3 +169,14 @@ class PaginatedHighlights(BaseModel):
160
169
  class PaginatedTags(BaseModel):
161
170
  tags: List[Tag]
162
171
  nextCursor: Optional[str] = ""
172
+
173
+
174
+ class Backup(BaseModel):
175
+ id: str
176
+ userId: str
177
+ assetId: Optional[str]
178
+ createdAt: str
179
+ size: float
180
+ bookmarkCount: int
181
+ status: Literal["pending", "success", "failure"]
182
+ errorMessage: Optional[str] = None
@@ -85,7 +85,7 @@ class KarakeepAPI:
85
85
  """
86
86
 
87
87
  # Version reflects the client library version, updated by bumpver
88
- VERSION: str = "1.4.1"
88
+ VERSION: str = "1.6.0"
89
89
 
90
90
  def __init__(
91
91
  self,
@@ -1295,12 +1295,15 @@ class KarakeepAPI:
1295
1295
  asset_id: str,
1296
1296
  asset_type: Literal[
1297
1297
  "screenshot",
1298
+ "pdf",
1298
1299
  "assetScreenshot",
1299
1300
  "bannerImage",
1300
1301
  "fullPageArchive",
1301
1302
  "video",
1302
1303
  "bookmarkAsset",
1303
1304
  "precrawledArchive",
1305
+ "userUploaded",
1306
+ "avatar",
1304
1307
  "unknown",
1305
1308
  ],
1306
1309
  ) -> Union[datatypes.BookmarkAsset, Dict[str, Any], List[Any]]:
@@ -1310,8 +1313,9 @@ class KarakeepAPI:
1310
1313
  Args:
1311
1314
  bookmark_id: The ID (string) of the bookmark.
1312
1315
  asset_id: The ID (string) of the asset to attach.
1313
- asset_type: The type of asset being attached. Must be one of: "screenshot", "assetScreenshot",
1314
- "bannerImage", "fullPageArchive", "video", "bookmarkAsset", "precrawledArchive", "unknown".
1316
+ asset_type: The type of asset being attached. Must be one of: "screenshot", "pdf", "assetScreenshot",
1317
+ "bannerImage", "fullPageArchive", "video", "bookmarkAsset", "precrawledArchive",
1318
+ "userUploaded", "avatar", "unknown".
1315
1319
 
1316
1320
  Returns:
1317
1321
  datatypes.BookmarkAsset: The attached asset object.
@@ -2042,7 +2046,7 @@ class KarakeepAPI:
2042
2046
  Get information about the current authenticated user. Corresponds to GET /users/me.
2043
2047
 
2044
2048
  Returns:
2045
- dict: A dictionary containing user information ('id', 'name', 'email', 'localUser').
2049
+ dict: A dictionary containing user information ('id', 'name', 'email', 'image', 'localUser').
2046
2050
  Validation is not performed on this response type by default.
2047
2051
 
2048
2052
  Raises:
@@ -2058,7 +2062,15 @@ class KarakeepAPI:
2058
2062
  Get statistics about the current authenticated user's data. Corresponds to GET /users/me/stats.
2059
2063
 
2060
2064
  Returns:
2061
- dict: A dictionary containing user statistics ('numBookmarks', 'numFavorites', 'numArchived', etc.).
2065
+ dict: A dictionary containing user statistics including:
2066
+ - numBookmarks, numFavorites, numArchived, numTags, numLists, numHighlights
2067
+ - bookmarksByType: breakdown by content type (link, text, asset)
2068
+ - topDomains: most bookmarked domains
2069
+ - totalAssetSize: total size of stored assets
2070
+ - assetsByType: breakdown of assets by type
2071
+ - bookmarkingActivity: activity metrics (thisWeek, thisMonth, thisYear, byHour, byDayOfWeek)
2072
+ - tagUsage: most used tags
2073
+ - bookmarksBySource: breakdown by source (api, web, cli, mobile, extension, singlefile, rss, import)
2062
2074
  Validation is not performed on this response type by default.
2063
2075
 
2064
2076
  Raises:
@@ -2175,6 +2187,186 @@ class KarakeepAPI:
2175
2187
  # Response should match Asset schema
2176
2188
  return datatypes.Asset.model_validate(response_data)
2177
2189
 
2190
+ @optional_typecheck
2191
+ def get_all_backups(
2192
+ self,
2193
+ ) -> Union[List[datatypes.Backup], Dict[str, Any], List[Any]]:
2194
+ """
2195
+ Get all backups for the current user. Corresponds to GET /backups.
2196
+
2197
+ Returns:
2198
+ List[datatypes.Backup]: A list of backup objects.
2199
+ If response validation is disabled, returns the raw API response (dict/list).
2200
+
2201
+ Raises:
2202
+ APIError: If the API request fails.
2203
+ pydantic.ValidationError: If response validation fails (and is not disabled).
2204
+ """
2205
+ response_data = self._call("GET", "backups")
2206
+
2207
+ if self.disable_response_validation:
2208
+ logger.debug("Skipping response validation as requested.")
2209
+ # Return raw data, which might be {"backups": [...]} or something else
2210
+ return response_data
2211
+ else:
2212
+ # Response schema is {"backups": [Backup]}, extract the list and validate
2213
+ if (
2214
+ isinstance(response_data, dict)
2215
+ and "backups" in response_data
2216
+ and isinstance(response_data["backups"], list)
2217
+ ):
2218
+ try:
2219
+ return [
2220
+ datatypes.Backup.model_validate(backup)
2221
+ for backup in response_data["backups"]
2222
+ ]
2223
+ except (
2224
+ Exception
2225
+ ) as e: # Catch validation errors during list comprehension
2226
+ logger.error(f"Validation failed for one or more backups: {e}")
2227
+ raise # Re-raise the validation error
2228
+ else:
2229
+ # Raise error if format is unexpected and validation is enabled
2230
+ raise APIError(
2231
+ f"Unexpected response format for get_all_backups when validation is enabled: {response_data}"
2232
+ )
2233
+
2234
+ @optional_typecheck
2235
+ def trigger_a_new_backup(
2236
+ self,
2237
+ ) -> Union[datatypes.Backup, Dict[str, Any], List[Any]]:
2238
+ """
2239
+ Trigger a new backup. Corresponds to POST /backups.
2240
+
2241
+ Returns:
2242
+ datatypes.Backup: The created backup object.
2243
+ If response validation is disabled, returns the raw API response (dict/list).
2244
+
2245
+ Raises:
2246
+ APIError: If the API request fails.
2247
+ pydantic.ValidationError: If response validation fails (and is not disabled).
2248
+ """
2249
+ response_data = self._call("POST", "backups")
2250
+
2251
+ if self.disable_response_validation:
2252
+ logger.debug("Skipping response validation as requested.")
2253
+ return response_data
2254
+ else:
2255
+ # Response should match Backup schema
2256
+ return datatypes.Backup.model_validate(response_data)
2257
+
2258
+ @optional_typecheck
2259
+ def get_a_single_backup(
2260
+ self, backup_id: str
2261
+ ) -> Union[datatypes.Backup, Dict[str, Any], List[Any]]:
2262
+ """
2263
+ Get a single backup by its ID. Corresponds to GET /backups/{backupId}.
2264
+
2265
+ Args:
2266
+ backup_id: The ID (string) of the backup to retrieve.
2267
+
2268
+ Returns:
2269
+ datatypes.Backup: The requested backup object.
2270
+ If response validation is disabled, returns the raw API response (dict/list).
2271
+
2272
+ Raises:
2273
+ APIError: If the API request fails (e.g., 404 backup not found).
2274
+ pydantic.ValidationError: If response validation fails (and is not disabled).
2275
+ """
2276
+ endpoint = f"backups/{backup_id}"
2277
+ response_data = self._call("GET", endpoint)
2278
+
2279
+ if self.disable_response_validation:
2280
+ logger.debug("Skipping response validation as requested.")
2281
+ return response_data
2282
+ else:
2283
+ # Response should match Backup schema
2284
+ return datatypes.Backup.model_validate(response_data)
2285
+
2286
+ @optional_typecheck
2287
+ def delete_a_backup(self, backup_id: str) -> None:
2288
+ """
2289
+ Delete a backup by its ID. Corresponds to DELETE /backups/{backupId}.
2290
+
2291
+ Args:
2292
+ backup_id: The ID (string) of the backup to delete.
2293
+
2294
+ Returns:
2295
+ None: Returns None upon successful deletion (204 No Content).
2296
+
2297
+ Raises:
2298
+ APIError: If the API request fails (e.g., 404 backup not found).
2299
+ """
2300
+ endpoint = f"backups/{backup_id}"
2301
+ self._call("DELETE", endpoint) # Expects 204 No Content
2302
+ return None # Explicitly return None for 204
2303
+
2304
+ @optional_typecheck
2305
+ def download_a_backup(self, backup_id: str) -> bytes:
2306
+ """
2307
+ Download the backup file (zip archive) by its ID. Corresponds to GET /backups/{backupId}/download.
2308
+
2309
+ Args:
2310
+ backup_id: The ID (string) of the backup to download.
2311
+
2312
+ Returns:
2313
+ bytes: The raw backup file content (zip archive).
2314
+
2315
+ Raises:
2316
+ APIError: If the API request fails (e.g., 404 backup not found).
2317
+ ValueError: If backup_id is empty or invalid.
2318
+
2319
+ Note:
2320
+ This method always returns raw bytes regardless of the disable_response_validation setting,
2321
+ as the response is binary content (zip file) rather than JSON.
2322
+ """
2323
+ # Validate backup_id
2324
+ if not backup_id or not backup_id.strip():
2325
+ raise ValueError("backup_id cannot be empty")
2326
+
2327
+ backup_id = backup_id.strip()
2328
+
2329
+ # Validate backup_id format (basic check for reasonable ID format)
2330
+ if len(backup_id) < 5: # Assuming backup IDs are at least 5 characters
2331
+ raise ValueError(f"backup_id appears to be invalid: {backup_id}")
2332
+
2333
+ endpoint = f"backups/{backup_id}/download"
2334
+
2335
+ # Override the Accept header to get the zip file instead of JSON
2336
+ extra_headers = {"Accept": "application/zip"}
2337
+
2338
+ if self.verbose:
2339
+ logger.debug(f"Downloading backup: {backup_id}")
2340
+
2341
+ response_data = self._call("GET", endpoint, extra_headers=extra_headers)
2342
+
2343
+ # The _call method should return bytes for non-JSON responses
2344
+ if isinstance(response_data, bytes):
2345
+ if self.verbose:
2346
+ logger.debug(
2347
+ f"Downloaded backup {backup_id}: {len(response_data)} bytes"
2348
+ )
2349
+ return response_data
2350
+ elif response_data is None:
2351
+ # Handle empty response
2352
+ if self.verbose:
2353
+ logger.debug(f"Downloaded empty backup {backup_id}")
2354
+ return b""
2355
+ else:
2356
+ # This shouldn't happen with the updated _call method, but handle gracefully
2357
+ error_msg = f"Expected bytes from backup download endpoint for backup {backup_id}, got {type(response_data).__name__}"
2358
+ if isinstance(response_data, (dict, list)):
2359
+ # If we got JSON, it might be an error response that wasn't caught
2360
+ error_detail = (
2361
+ str(response_data)[:200] + "..."
2362
+ if len(str(response_data)) > 200
2363
+ else str(response_data)
2364
+ )
2365
+ error_msg += f". Response content: {error_detail}"
2366
+
2367
+ logger.error(error_msg)
2368
+ raise APIError(error_msg)
2369
+
2178
2370
  @optional_typecheck
2179
2371
  def get_a_single_asset(self, asset_id: str) -> bytes:
2180
2372
  """