├── .exampleRootMetadata.json ├── .gitignore ├── LICENSE ├── README.MD ├── _start_venv.lnk ├── api.py ├── backup.bat ├── export.py ├── paths.py ├── requirements.txt ├── stats.py └── tree.py /.exampleRootMetadata.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "Bookmarked": false, 4 | "ID": "1b110b2e-35c2-4542-9049-b4ee2c72326b", 5 | "ModifiedClient": "2018-08-29T07:30:03.00Z", 6 | "Parent": "", 7 | "Type": "CollectionType", 8 | "Version": 1, 9 | "VissibleName": "Folder A" 10 | }, 11 | { 12 | "Bookmarked": false, 13 | "ID": "2225c8b4-5c2f-4e6f-9231-4b48f446af24", 14 | "ModifiedClient": "2018-07-29T07:17:03.00Z", 15 | "Parent": "", 16 | "Type": "CollectionType", 17 | "Version": 1, 18 | "VissibleName": "Folder B" 19 | }, 20 | { 21 | "Bookmarked": false, 22 | "CurrentPage": 19, 23 | "ID": "bbddfa01-9b8b-4b74-818d-0caa6e08f71e", 24 | "ModifiedClient": "2018-11-08T12:05:25.281281Z", 25 | "Parent": "", 26 | "Type": "DocumentType", 27 | "Version": 138, 28 | "VissibleName": "Quick sheets", 29 | "extraMetadata": { 30 | "LastBrushColor": "Black", 31 | "LastBrushThicknessScale": "2", 32 | "LastColor": "Black", 33 | "LastEraserThicknessScale": "2", 34 | "LastPen": "Ballpoint", 35 | "LastPenColor": "Black", 36 | "LastPenThicknessScale": "2", 37 | "LastPencil": "SharpPencil", 38 | "LastPencilColor": "Black", 39 | "LastPencilThicknessScale": "2", 40 | "LastTool": "Ballpoint", 41 | "ThicknessScale": "2" 42 | }, 43 | "fileType": "notebook", 44 | "fontName": "", 45 | "lastOpenedPage": 19, 46 | "lineHeight": -1, 47 | "margins": 100, 48 | "orientation": "portrait", 49 | "pageCount": 21, 50 | "textScale": 1, 51 | "transform": { 52 | "m11": 1, 53 | "m12": 0, 54 | "m13": 0, 55 | "m21": 0, 56 | "m22": 1, 57 | "m23": 0, 58 | "m31": 0, 59 | "m32": 0, 60 | "m33": 1 61 | } 62 | }, 63 | { 64 | "Bookmarked": false, 65 | "CurrentPage": 0, 66 | "ID": "bc2e151d-a535-41c8-9eb9-c596b8c2112b", 67 | "ModifiedClient": "2018-11-13T15:40:24.00Z", 68 | "Parent": "", 69 | "Type": "DocumentType", 70 | "Version": 1, 71 | "VissibleName": "Document A.pdf", 72 | "extraMetadata": {}, 73 | "fileType": "pdf", 74 | "fontName": "", 75 | "lastOpenedPage": 0, 76 | "lineHeight": -1, 77 | "margins": 100, 78 | "orientation": "portrait", 79 | "pageCount": 2, 80 | "textScale": 1, 81 | "transform": { 82 | "m11": 1, 83 | "m12": 0, 84 | "m13": 0, 85 | "m21": 0, 86 | "m22": 1, 87 | "m23": 0, 88 | "m31": 0, 89 | "m32": 0, 90 | "m33": 1 91 | } 92 | }, 93 | { 94 | "Bookmarked": false, 95 | "CurrentPage": 0, 96 | "ID": "55361a78-b630-4586-8491-9b775ae088e1", 97 | "ModifiedClient": "2018-10-02T17:58:35.00Z", 98 | "Parent": "", 99 | "Type": "DocumentType", 100 | "Version": 6, 101 | "VissibleName": "Notebook B", 102 | "extraMetadata": { 103 | "LastBrushColor": "Black", 104 | "LastBrushThicknessScale": "2", 105 | "LastColor": "Black", 106 | "LastEraserThicknessScale": "1", 107 | "LastPen": "Ballpoint", 108 | "LastPenColor": "Black", 109 | "LastPenThicknessScale": "2", 110 | "LastPencil": "SharpPencil", 111 | "LastPencilColor": "Black", 112 | "LastPencilThicknessScale": "2", 113 | "LastTool": "Eraser", 114 | "ThicknessScale": "1" 115 | }, 116 | "fileType": "notebook", 117 | "fontName": "", 118 | "lastOpenedPage": 0, 119 | "lineHeight": -1, 120 | "margins": 100, 121 | "orientation": "portrait", 122 | "pageCount": 1, 123 | "textScale": 1, 124 | "transform": { 125 | "m11": 1, 126 | "m12": 0, 127 | "m13": 0, 128 | "m21": 0, 129 | "m22": 1, 130 | "m23": 0, 131 | "m31": 0, 132 | "m32": 0, 133 | "m33": 1 134 | } 135 | }, 136 | { 137 | "Bookmarked": false, 138 | "CurrentPage": 0, 139 | "ID": "2651bed5-9565-40f7-a517-bc0b960ab0f3", 140 | "ModifiedClient": "2018-11-20T12:12:34.00Z", 141 | "Parent": "", 142 | "Type": "DocumentType", 143 | "Version": 3, 144 | "VissibleName": "Book A", 145 | "extraMetadata": { 146 | }, 147 | "fileType": "epub", 148 | "fontName": "", 149 | "lastOpenedPage": 0, 150 | "lineHeight": -1, 151 | "margins": 100, 152 | "orientation": "portrait", 153 | "pageCount": 831, 154 | "textScale": 1, 155 | "transform": { 156 | "m11": 1, 157 | "m12": 0, 158 | "m13": 0, 159 | "m21": 0, 160 | "m22": 1, 161 | "m23": 0, 162 | "m31": 0, 163 | "m32": 0, 164 | "m33": 1 165 | } 166 | }, 167 | ] 168 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /*/* 2 | /__pycache__ 3 | /_backup* 4 | /venv 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | 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 | 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. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 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. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | 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 557 | combined work, and to convey the resulting work. The terms of this 558 | 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. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | 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 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | 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 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | 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 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 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 | Copyright (C) 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". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | 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 667 | . 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 | . 675 | -------------------------------------------------------------------------------- /README.MD: -------------------------------------------------------------------------------- 1 | # rmWebUiTools 2 | 3 | [![Mentioned in Awesome reMarkable](https://awesome.re/mentioned-badge.svg)](https://github.com/reHackable/awesome-reMarkable) 4 | 5 | This is a collection of scripts that utilize the reMarkable USB webinterface to export files. 6 | 7 | 8 | ## DISCLAIMER 9 | 10 | Using the export functionality, the script will prompt your device to **export every single file** onto your pc. 11 | This will - as of now - lead to freezes and other problems, as the software is not specifically suited for this usecase. 12 | 13 | I (and reMarkable AS too) **WON'T take any responsibility** for potential damage done to your device using this software. 14 | 15 | 16 | ## Installation 17 | 18 | First ensure you have a recent version of [Python 3](https://www.python.org/downloads/) installed. 19 | 20 | To install all dependencies, execute this command in your terminal or command prompt: 21 | ``` 22 | $ pip install requests 23 | ``` 24 | 25 | Next you clone this repository (or download it as a zip file), and go into the folder using the `cd` command in your terminal or command prompt. 26 | 27 | 28 | ## Usage 29 | 30 | The scripts (except `api.py`) are meant to be executed with python 3. 31 | 32 | This can be done by typing `python` followed by the name of the script file. 33 | On unix systems, you can also execute those scripts like any other shell script. 34 | 35 | Examples: 36 | ``` 37 | $ python export.py --only-notebooks --update NotebookBackup 38 | $ ./export.py --only-notebooks --update NotebookBackup 39 | $ ./export.py --help 40 | 41 | $ ./tree.py 42 | $ ./paths.py 43 | $ ./stats.py 44 | ``` 45 | 46 | 47 | ## Possibilities 48 | 49 | Right now, you can export/mirror all your files into a specified folder, export only changed files or view general information using on of the various scripts available. 50 | 51 | You can also make your own scripts using the `api.py` and give you access to all metadata provided by the reMarkable USB webinterface. An example of such information can be found in the file `.exampleRootMetadata.json`. 52 | 53 | There is certainly a lot more possible than currently provided. 54 | If you want a certain feature, you can create an issue (= feature request) or contribute it yourself. 55 | 56 | 57 | ## Common problem 58 | 59 | When exporting a large amount of files, it can happen that your reMarkable **enters sleep mode** during that process or **locks up and restarts** (happens on some huge pdf files). 60 | 61 | When this happens, you can just execute the same command again. It should continue where it failed with no data loss. 62 | 63 | -------------------------------------------------------------------------------- /_start_venv.lnk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LinusCDE/rmWebUiTools/fac3766135f8051330084ae53760a3098e6a508f/_start_venv.lnk -------------------------------------------------------------------------------- /api.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Utilities regarding the reMarkable usb webinterface. 3 | ''' 4 | 5 | from collections.abc import Iterable 6 | from datetime import datetime 7 | import requests 8 | 9 | 10 | RM_WEB_UI_URL = 'http://10.11.99.1' # No trailing slash! 11 | 12 | 13 | class RmFile: 14 | ''' 15 | Representation of a file or folder on the reMarkable device. 16 | ''' 17 | 18 | def __init__(self, metadata, parent=None): 19 | # Given parameters: 20 | self.metadata = metadata 21 | self.parent = parent 22 | 23 | # Hierachial data: 24 | self.isFolder = (metadata['Type'] == 'CollectionType') 25 | self.files = [] if self.isFolder else None 26 | 27 | # Determine file type: 28 | self.isNotebook = not self.isFolder and metadata['fileType'] == 'notebook' 29 | self.isPdf = not self.isFolder and metadata['fileType'] == 'pdf' 30 | self.isEpub = not self.isFolder and metadata['fileType'] == 'epub' 31 | 32 | # Easy access of common metadata: 33 | self.name = metadata['VissibleName'] if 'VissibleName' in metadata else metadata['VisibleName'] # Typo from reMarkable which will probably get fixed in next patch 34 | self.id = metadata['ID'] 35 | self.isBookmarked = metadata['Bookmarked'] 36 | self.pages = metadata['pageCount'] if not self.isFolder else None 37 | self.modifiedTimestamp = datetime.strptime(metadata['ModifiedClient'], '%Y-%m-%dT%H:%M:%S.%fZ').timestamp() 38 | 39 | 40 | # Prevent faulty structures: 41 | if '/' in self.name: 42 | self.name = self.name.replace('/', '') 43 | 44 | def path(self, basePath=''): 45 | ''' 46 | Returns the complete path including this file/folder. 47 | basePath may be provided and prepended. 48 | ''' 49 | if basePath and not basePath.endswith('/'): 50 | basePath += '/' 51 | 52 | path = self.name 53 | parent = self.parent 54 | while parent: 55 | path = parent.name + '/' + path 56 | parent = parent.parent 57 | 58 | return basePath + path 59 | 60 | def parentFolderPath(self, basePath=''): 61 | ''' 62 | Returns the current folder path that a file is in. 63 | A basePath may be provided and prepended. 64 | 65 | If in root, the basePath (default '') will be returned. 66 | ''' 67 | if self.parent: 68 | if basePath and not basePath.endswith('/'): 69 | basePath += '/' 70 | return basePath + self.parent.path() 71 | else: 72 | basePath 73 | 74 | def exportPdf(self, targetPath): 75 | ''' 76 | Downloads this file as pdf to a given path. 77 | I may take a while before the download is started, 78 | due to the conversion happening on the reMarkable device. 79 | 80 | Returns bool with True for successful and False for unsuccessful. 81 | ''' 82 | response = requests.get(RM_WEB_UI_URL + '/download/' + self.id + '/placeholder', stream=True) 83 | 84 | if not response.ok: 85 | return False 86 | 87 | # Credit: https://stackoverflow.com/a/13137873 88 | response.raw.decode_content = True # Decompress if needed 89 | 90 | with open(targetPath, 'wb') as targetFile: 91 | for chunk in response.iter_content(8192): 92 | targetFile.write(chunk) 93 | return True 94 | 95 | def __str__(self): 96 | return 'RmFile{name=%s}' % self.name 97 | 98 | def __repr__(self): 99 | return self.__str__() 100 | 101 | 102 | def iterateAll(filesOrRmFile): 103 | ''' 104 | Yields all files in this iterable (list, tuple, ...) or file including subfiles and folders. 105 | 106 | In case any (nested) value that isn't a iterable or of class api.RmFile a ValueError will be raised! 107 | ''' 108 | if isinstance(filesOrRmFile, RmFile): 109 | # Yield file and optional sub files recursivly: 110 | yield filesOrRmFile 111 | if filesOrRmFile.isFolder: 112 | for recursiveSubFile in iterateAll(filesOrRmFile.files): 113 | yield recursiveSubFile 114 | elif isinstance(filesOrRmFile, Iterable): 115 | # Assumes elements to be of class api.RmFile 116 | for rmFile in filesOrRmFile: 117 | for subFile in iterateAll(rmFile): 118 | yield subFile 119 | else: 120 | # Unknown type found! 121 | raise ValueError('"api.iterateAll(filesOrRmFile)" only accepts (nested) iterables and instances of class api.RmFile !') 122 | 123 | 124 | def fetchFileStructure(parentRmFile=None): 125 | ''' 126 | Fetches the fileStructure from the reMarkable USB webinterface. 127 | 128 | Specify a RmFile of type folder to fetch only all folders after the given one. 129 | Ignore to get all possible file and folders. 130 | 131 | Returns either list of files OR FILLS given parentRmFiles files 132 | 133 | May throw RuntimeError or other releated ones from "requests" 134 | if there are problems fetching the data from the usb webinterface. 135 | ''' 136 | if parentRmFile and not parentRmFile.isFolder: 137 | raise ValueError('"api.fetchFileStructure(parentRmFile)": parentRmFile must be None or of type folder!') 138 | 139 | # Use own list if not parentRmFile is given (aka beeing in root) 140 | if not parentRmFile: 141 | rootFiles = [] 142 | 143 | # Get metadata: 144 | directoryMetadataUrl = RM_WEB_UI_URL + '/documents/' + (parentRmFile.id if parentRmFile else '') 145 | response = requests.get(directoryMetadataUrl) 146 | response.encoding = 'UTF-8' # Ensure, all Non-ASCII characters get decoded properly 147 | 148 | if not response.ok: 149 | raise RuntimeError('Url %s responsed with status code %d' % (directoryMetadataUrl, response.status_code)) 150 | 151 | directoryMetadata = response.json() 152 | 153 | # Parse Entries in jsonArray (= files in directory) and request subFolders: 154 | for fileMetadata in directoryMetadata: 155 | rmFile = RmFile(fileMetadata, parentRmFile) 156 | if parentRmFile: 157 | parentRmFile.files.append(rmFile) 158 | else: 159 | rootFiles.append(rmFile) 160 | 161 | # Fetch subdirectories recursivly: 162 | if rmFile.isFolder: 163 | fetchFileStructure(rmFile) 164 | 165 | # Return files as list if in root (otherwise the given parentRmFile got their files): 166 | if not parentRmFile: 167 | return rootFiles 168 | 169 | 170 | def findId(filesOrRmFile, fileId): 171 | ''' 172 | Searched for any file or directory with fileId in given filesOrRmFile (including nested files) 173 | 174 | Returns matching RmFile if found. Otherwise None . 175 | ''' 176 | for rmFile in iterateAll(filesOrRmFile): 177 | if rmFile.id == fileId: 178 | return rmFile 179 | return None 180 | -------------------------------------------------------------------------------- /backup.bat: -------------------------------------------------------------------------------- 1 | @echo off 2 | setlocal 3 | 4 | set VENV=venv 5 | set DEST=_backup 6 | 7 | if not exist %VENV% ( 8 | py -3 -m venv %VENV% 9 | call %VENV%\scripts\activate 10 | python -m pip install --upgrade pip 11 | pip install --requirement requirements.txt 12 | ) else ( 13 | call %VENV%\scripts\activate 14 | ) 15 | 16 | if not exist %DEST% mkdir %DEST% 17 | export.py --update %DEST% 18 | 19 | pause 20 | -------------------------------------------------------------------------------- /export.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | ''' 3 | Export - Exports all files of the remarkable onto your PC as pdfs. 4 | 5 | Info: If a file is already exported, it will get skipped by default. 6 | ''' 7 | 8 | 9 | import api 10 | 11 | from argparse import ArgumentParser, RawDescriptionHelpFormatter 12 | from datetime import datetime 13 | from os import makedirs, utime 14 | from os.path import exists, getmtime 15 | from sys import stderr 16 | from time import time 17 | 18 | # ------------------------------ 19 | # Config: 20 | DEBUG = False 21 | # ------------------------------ 22 | 23 | def local_time_offset(): 24 | now_timestamp = time() 25 | return (datetime.fromtimestamp(now_timestamp) - datetime.utcfromtimestamp(now_timestamp)).total_seconds() 26 | 27 | def exportTo(files, targetFolderPath, onlyNotebooks, onlyBookmarked, updateFiles, onlyPathPrefix=None): 28 | # Preprocessing filterPath: 29 | if onlyPathPrefix is not None: 30 | if onlyPathPrefix.startswith('/'): 31 | onlyPathPrefix = onlyPathPrefix[1:] 32 | onlyPathPrefix = onlyPathPrefix.lower() 33 | if onlyPathPrefix == '': 34 | onlyPathPrefix = None 35 | 36 | exportableFiles = list(filter(lambda rmFile: rmFile.isFolder is False, api.iterateAll(files))) 37 | 38 | # Apply filter: 39 | if onlyPathPrefix is not None: 40 | exportableFiles = list(filter(lambda rmFile: rmFile.path().lower().startswith(onlyPathPrefix), exportableFiles)) 41 | 42 | # Filter for only notebooks if requested: 43 | if onlyNotebooks: 44 | exportableFiles = list(filter(lambda rmFile: rmFile.isNotebook, exportableFiles)) 45 | 46 | # Filter for only bookmared if requested: 47 | if onlyBookmarked: 48 | exportableFiles = list(filter(lambda rmFile: rmFile.isBookmarked, exportableFiles)) 49 | 50 | totalExportableFiles = len(exportableFiles) 51 | 52 | lastDirectory = None 53 | for i, exportableFile in enumerate(exportableFiles): 54 | 55 | # Announce directory change: 56 | directory = exportableFile.parentFolderPath() 57 | if(directory != lastDirectory): 58 | print('INFO: Current folder: %s' % ('' if not directory else directory)) 59 | lastDirectory = directory 60 | 61 | # Get full path: 62 | path = exportableFile.path(targetFolderPath) 63 | if not path.endswith('.pdf'): 64 | path += '.pdf' 65 | 66 | # Create necessary directories: 67 | parentDir = exportableFile.parentFolderPath(targetFolderPath) 68 | if parentDir: # May be None in the root 69 | try: 70 | makedirs(parentDir, exist_ok=True) 71 | except Exception as ex: 72 | print('ERROR: Failed to create directories: "%s"' % parentDir) 73 | raise ex 74 | 75 | # Check if file needs to be downloaded and output appropriate messages: 76 | skipFile = False 77 | if exists(path): 78 | # Existing exported file: 79 | if updateFiles: 80 | if int(getmtime(path)) < int(exportableFile.modifiedTimestamp + local_time_offset()): 81 | # Update outdated export: 82 | print('INFO: [%d/%d] Updating file \'%s\'...' % (i+1, totalExportableFiles, exportableFile.name)) 83 | else: 84 | # Skip file that is up-to-date: 85 | skipFile = True 86 | print('WARN: [%d/%d] Skipping unchanged file \'%s\'...' % (i+1, totalExportableFiles, exportableFile.name)) 87 | else: 88 | # Don't override files. Regardless of date: 89 | skipFile = True 90 | print('INFO: [%d/%d] Skipping file \'%s\' (already exists in your target folder)...' % (i+1, totalExportableFiles, exportableFile.name)) 91 | 92 | if not exists(path): 93 | print('INFO: [%d/%d] Exporting \'%s\'...' % (i+1, totalExportableFiles, exportableFile.name)) 94 | 95 | # Export file if necessary: 96 | if not skipFile: 97 | try: 98 | exportableFile.exportPdf(path) 99 | except Exception as ex: 100 | print('ERROR: Failed to export "%s" to "%s"' % (exportableFile.name, path)) 101 | raise ex 102 | try: 103 | local_mod_time = exportableFile.modifiedTimestamp + local_time_offset() 104 | utime(path, (local_mod_time, local_mod_time)) # Use timestamp from the reMarkable device 105 | except Exception as ex: 106 | print('ERROR: Failed to change timestamp for exported file "%s"' % path) 107 | raise ex 108 | 109 | def printUsageAndExit(): 110 | print('Usage: %s [--only-notebooks] [--override-modified] ' % argv[0], file=stderr) 111 | print('WARNING: Existing files won''t get overridden (helpful for continuing an interrupted export).') 112 | exit(1) 113 | 114 | 115 | if __name__ == '__main__': 116 | # Disclaimer: 117 | print('DISCLAIMER: Please be aware that this puts the STRAIN of creating exported pdf files on YOUR REMARKABLE DEVICE rather than this computer.\n' \ 118 | 'This can lead to UNEXPECTED BEHAVIOUR when many and/or big files are being exported.\n' \ 119 | 'I WON\'T TAKE ANY RESPONSIBILITY for potential damage this may induce!\n', file=stderr) 120 | 121 | # Argument parsing: 122 | ap = ArgumentParser( 123 | description=__doc__, 124 | formatter_class=RawDescriptionHelpFormatter) 125 | 126 | ap.add_argument('target_folder', help='Base folder to put the exported files in') 127 | 128 | ap.add_argument( 129 | '-n', '--only-notebooks', 130 | action='store_true', default=False, help='Skips all files except notebooks') 131 | 132 | ap.add_argument( 133 | '-b', '--only-bookmarked', 134 | action='store_true', default=False, help='Skips all files except bookmarked') 135 | 136 | ap.add_argument( 137 | '-f', '--only-path-prefix', metavar='path', 138 | default='', help='Skips all files that DON\'T starts with the given path (case-insensitive)') 139 | 140 | ap.add_argument( 141 | '-u', '--update', 142 | action='store_true', default=False, help='Overrides/Updates all updated files. Does not remove deleted files!') 143 | 144 | args = ap.parse_args() 145 | targetFolder, onlyNotebooks, onlyBookmarked, updateFiles, onlyPathPrefix = args.target_folder, args.only_notebooks, args.only_bookmarked, args.update, args.only_path_prefix 146 | 147 | # Print info regarding arguments: 148 | if updateFiles: 149 | print('INFO: Updating files that have been changed recently. (Does not delete old files.)') 150 | if onlyNotebooks: 151 | print('INFO: Export only notebooks.') 152 | if onlyBookmarked: 153 | print('INFO: Export only bookmarked files.') 154 | if onlyPathPrefix: 155 | print('INFO: Only exporting files whose path begins with given filter (case insensitive).') 156 | 157 | try: 158 | # Actual process: 159 | print('INFO: Fetching file structure...') 160 | files = api.fetchFileStructure() 161 | exportTo(files, targetFolder, onlyNotebooks, onlyBookmarked, updateFiles, onlyPathPrefix) 162 | print('Done!') 163 | except KeyboardInterrupt: 164 | print('Cancelled.') 165 | exit(0) 166 | except Exception as ex: 167 | # Error handling: 168 | if DEBUG: 169 | raise ex 170 | exit(1) 171 | else: 172 | print('ERROR: %s' % ex, file=stderr) 173 | print(file=stderr) 174 | print('Please make sure your reMarkable is connected to this PC and you have enabled the USB Webinterface in "Settings -> Storage".', file=stderr) 175 | exit(1) 176 | -------------------------------------------------------------------------------- /paths.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import api 4 | from sys import stderr 5 | 6 | # ------------------------------ 7 | # Config: 8 | DEBUG = False 9 | # ------------------------------ 10 | 11 | if __name__ == '__main__': 12 | try: 13 | print('Fetching file structure...\n', file=stderr) # Prints to stderr to ignore this if piped into a text file 14 | files = api.fetchFileStructure() 15 | 16 | print('IDs:') 17 | for rmFile in api.iterateAll(files): 18 | print('%s: %s' % (rmFile.id, rmFile.path())) 19 | except Exception as ex: 20 | # Error handling: 21 | if DEBUG: 22 | raise ex 23 | exit(1) 24 | else: 25 | print('ERROR: %s' % ex, file=stderr) 26 | print(file=stderr) 27 | print('Please make sure your reMarkable is connected to this PC and you have enabled the USB Webinterface in "Settings -> Storage".', file=stderr) 28 | exit(1) 29 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.31.0 2 | -------------------------------------------------------------------------------- /stats.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import api 4 | from collections.abc import Iterable 5 | from statistics import mean, median 6 | from sys import stderr 7 | 8 | # ------------------------------ 9 | # Config: 10 | DEBUG = False 11 | # ------------------------------ 12 | 13 | 14 | def printStats(files): 15 | ''' 16 | Collect some interesting stats to show off in console. 17 | ''' 18 | # Data to collect: 19 | filesPerFolder = [] 20 | pagesPerNotebook = [] 21 | pagesPerPdf = [] 22 | pagesPerEpub = [] 23 | 24 | 25 | # Collect data: 26 | for rmFile in api.iterateAll(files): 27 | if rmFile.isFolder: 28 | filesPerFolder.append(len(rmFile.files)) 29 | else: 30 | pages = rmFile.pages 31 | if rmFile.isNotebook: 32 | pagesPerNotebook.append(pages) 33 | elif rmFile.isPdf: 34 | pagesPerPdf.append(pages) 35 | elif rmFile.isEpub: 36 | pagesPerEpub.append(pages) 37 | else: 38 | a = dict() 39 | raise RuntimeError('Unexpeted filetype for "%s": %s' % (rmFile.path(), rmFile.metadata.get('fileType', ''))) 40 | 41 | # Collect root folder / current list as folder if given: 42 | if isinstance(files, Iterable): 43 | filesPerFolder.append(len(files)) 44 | 45 | 46 | # Print collected data: 47 | 48 | # Folders: 49 | print('Files in folders:') 50 | folderFormat = ' ' + 4*'{:<14}' 51 | print(folderFormat.format( 52 | 'TOTAL', 53 | 'MEAN (AVG)', 54 | 'MEDIAN', 55 | 'TOTAL' 56 | )) 57 | print(folderFormat.format( 58 | '%d folders' % len(filesPerFolder), # "TOTAL" 59 | '%.1f files' % mean(filesPerFolder), # "MEAN (AVG)" 60 | '%.0f files' % median(filesPerFolder), # "MEDIAN" 61 | '%d files' % sum(filesPerFolder) # "TOTAL" 62 | )) 63 | 64 | # Documents/Files: 65 | print() 66 | print('Pages in documents:') 67 | docFormat = ' ' + 6*'{:<14}' 68 | print(docFormat.format( 69 | 'TYPE', 70 | 'FILES', 71 | 'MEAN (AVG)', 72 | 'MEDIAN', 73 | 'BIGGEST', 74 | 'TOTAL' 75 | )) 76 | for typeName, pagesPerType in {'notebook': pagesPerNotebook, 'pdf': pagesPerPdf, 'epub': pagesPerEpub}.items(): 77 | if len(pagesPerType) == 0: 78 | continue 79 | 80 | print(docFormat.format( 81 | typeName, # "TYPE" 82 | '%d files' % len(pagesPerType), # "FILES" 83 | '%.1f pages' % mean(pagesPerType), # "MEAN (AVG)" 84 | '%.0f pages' % median(pagesPerType), # "MEDIAN" 85 | '%s pages' % max(pagesPerType), # "BIGGEST" 86 | '%s pages' % sum(pagesPerType) # "TOTAL" 87 | )) 88 | 89 | if len(pagesPerEpub) > 0: 90 | print('\nThe page statistics of epub may not be correct as the device sometimes has trouble calculating them.') 91 | 92 | 93 | 94 | 95 | 96 | if __name__ == '__main__': 97 | try: 98 | print('Fetching file structure...') 99 | files = api.fetchFileStructure() 100 | print() 101 | printStats(files) 102 | except Exception as ex: 103 | # Error handling: 104 | if DEBUG: 105 | raise ex 106 | exit(1) 107 | else: 108 | print('ERROR: %s' % ex, file=stderr) 109 | print(file=stderr) 110 | print('Please make sure your reMarkable is connected to this PC and you have enabled the USB Webinterface in "Settings -> Storage".', file=stderr) 111 | exit(1) 112 | -------------------------------------------------------------------------------- /tree.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import api 4 | from sys import stderr 5 | 6 | # ------------------------------ 7 | # Config: 8 | DEBUG = False 9 | # ------------------------------ 10 | 11 | 12 | def printTree(rmFiles, prefix=(' '*4)): 13 | for index, rmFile in enumerate(rmFiles): 14 | if index == len(rmFiles) - 1 and not rmFile.isFolder: 15 | print('%s└── %s' % (prefix, rmFile.name)) 16 | else: 17 | print('%s├── %s' % (prefix, rmFile.name)) 18 | 19 | if rmFile.isFolder: 20 | printTree(rmFile.files, '%s│ ' % prefix) 21 | 22 | if len(rmFiles) == 0: 23 | print('%s└── ' % prefix) 24 | 25 | 26 | if __name__ == '__main__': 27 | try: 28 | print('Fetching file structure...\n', file=stderr) # Prints to stderr to ignore this if piped into a text file 29 | files = api.fetchFileStructure() 30 | 31 | print('Remarkable file tree:') 32 | printTree(files) 33 | except Exception as ex: 34 | # Error handling: 35 | if DEBUG: 36 | raise ex 37 | exit(1) 38 | else: 39 | print('ERROR: %s' % ex, file=stderr) 40 | print(file=stderr) 41 | print('Please make sure your reMarkable is connected to this PC and you have enabled the USB Webinterface in "Settings -> Storage".', file=stderr) 42 | exit(1) 43 | --------------------------------------------------------------------------------