├── .gitignore ├── LICENSE ├── README.rst ├── requirements.txt ├── setup.py └── wfw ├── __init__.py ├── __main__.py ├── api.py ├── commands.py ├── lib.py ├── tests └── tree_test.py ├── tree.py └── wfexceptions.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.exported 2 | .tree 3 | wfw/venv 4 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | 676 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | WFW 2 | === 3 | 4 | CLI for WorkFlowy inspired by WWW:WorkFlowy_ 5 | 6 | WorkFlowy does not maintain an external API, so the cli can break anytime. **Do not use it for anything mission critical.** 7 | 8 | Installation 9 | ------------ 10 | 11 | Please note that the package supports **Python 2.7** only. 12 | 13 | Install it using pip 14 | :: 15 | 16 | pip install wfw 17 | 18 | 19 | Configuration 20 | ------------- 21 | 22 | Configure the tool using a configuration file. The name of the file have to be .wfwrc and it is must be located 23 | in the home directory. **If the following options are not set properly, connecting to the server is not possible.** 24 | 25 | Sample configuration 26 | ~~~~~~~~~~~~~~~~~~~~ 27 | 28 | /home/user/.wfwrc 29 | :: 30 | 31 | [user] 32 | email: name@server.com 33 | password: secretpass 34 | 35 | Commands 36 | -------- 37 | 38 | wfw add 39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 40 | 41 | Add new item to list. 42 | 43 | | parent-item: parent of the new item 44 | | new-item: new item's text 45 | 46 | ``wfw add "My list" "Shopping list"`` 47 | 48 | ``wfw add places home`` 49 | 50 | wfw agenda 51 | ~~~~~~~~~~~~~~ 52 | 53 | Agenda view of a node's children. 54 | 55 | item: root of the agenda 56 | 57 | ``wfw agenda ThisWeek`` 58 | 59 | wfw export 60 | ~~~~~~~~~~~~~~~~~~~~~ 61 | 62 | Export the list to file. The output file can be imported to hnb. 63 | 64 | filename: path to file, default: tree.exported in current directory 65 | 66 | ``wfw export`` 67 | 68 | ``wfw export my-pretty-file`` 69 | 70 | wfw fetch 71 | ~~~~~~~~~ 72 | 73 | Fetch list from WorkFlowy server. 74 | 75 | ``wfw fetch`` 76 | 77 | wfw find 78 | ~~~~~~~~~~~~~~~~~~ 79 | 80 | Find items using pattern matching. 81 | 82 | pattern: pattern that matches the item 83 | 84 | ``wfw find TODO`` 85 | 86 | ``wfw find ba*`` 87 | 88 | wfw info 89 | ~~~~~~~~~~~~~~~ 90 | 91 | Show statistics based on the items state. 92 | 93 | ``wfw info tasks`` 94 | 95 | item: root of the group of tasks 96 | 97 | wfw rm 98 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 99 | 100 | Remove item from list. 101 | 102 | | parent-item: parent of the deleted item 103 | | deleted-item: deleted item's text 104 | 105 | ``wfw rm "My list" TODOs`` 106 | 107 | ``wfw rm TODO shopping`` 108 | 109 | wfw show --root 110 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 111 | 112 | Prints list until given depth. 113 | 114 | | root: text of the root item, default: root of tree 115 | | depth: height of tree to be printed, default: 1 116 | 117 | ``wfw show`` 118 | 119 | ``wfw show 2`` 120 | 121 | ``wfw show --root personal 3`` 122 | 123 | wfw tag 124 | ~~~~~~~~~~~~~~~~~~~~~ 125 | 126 | Find items containing the given tag. 127 | 128 | tag-to-find: name of tag to find 129 | 130 | ``wfw tag @work`` 131 | 132 | ``wfw tag "#ThisWeek"`` 133 | 134 | Author 135 | ====== 136 | 137 | Noemi Vanyi 138 | 139 | .. _WWW:WorkFlowy: https://github.com/cotto/www-workflowy/ 140 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | click 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | import wfw 4 | 5 | setup( 6 | name='wfw', 7 | packages=['wfw'], 8 | version='0.3.0', 9 | description='command-line interface for WorkFlowy', 10 | author='Noemi Vanyi', 11 | author_email='sitbackandwait@gmail.com', 12 | url='https://github.com/kvch/wfw', 13 | download_url='https://github.com/kvch/wfw/tarball/0.3.0', 14 | license='GNU General Public License v3', 15 | classifiers=[ 16 | 'Development Status :: 4 - Beta', 17 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 18 | 'Programming Language :: Python :: 2.7' 19 | ], 20 | long_description="WorkFlowy command-line tool for people who prefer the terminal.", 21 | install_requires=[ 22 | 'click', 23 | 'requests', 24 | ], 25 | entry_points={ 26 | 'console_scripts' : [ 27 | 'wfw = wfw.__main__:cli' 28 | ], 29 | }) 30 | -------------------------------------------------------------------------------- /wfw/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kvch/wfw/517993a7b2e6c1f8b8d582799ffb6e0fc782398e/wfw/__init__.py -------------------------------------------------------------------------------- /wfw/__main__.py: -------------------------------------------------------------------------------- 1 | from wfw.commands import cli 2 | 3 | if __name__ == '__main__': 4 | cli() 5 | -------------------------------------------------------------------------------- /wfw/api.py: -------------------------------------------------------------------------------- 1 | from os.path import expanduser 2 | import json 3 | import random 4 | import requests 5 | import string 6 | import uuid 7 | 8 | from wfw.wfexceptions import LoginFailedException, LocalChangePostingError 9 | 10 | 11 | WFURL = 'https://workflowy.com/' 12 | TREE_DATA = expanduser('~/.wfwtree') 13 | 14 | 15 | def log_in(email, password): 16 | info = {'username' : email, 'password': password, 'next' : ''} 17 | request = requests.post(WFURL + 'accounts/login/', data=info) 18 | 19 | if not len(request.history) == 1: 20 | raise LoginFailedException("Login was not successful") 21 | 22 | cookies = requests.utils.dict_from_cookiejar(request.history[0].cookies) 23 | return cookies['sessionid'] 24 | 25 | 26 | def log_out(session_id): 27 | cookie = {'sessionid' : session_id} 28 | requests.get(WFURL + 'offline_logout', cookies=cookie) 29 | 30 | 31 | def get_list_from_server(session_id): 32 | cookie = {'sessionid' : session_id} 33 | request = requests.post(WFURL + 'get_initialization_data?client_version=14', 34 | cookies=cookie) 35 | 36 | tree = request.json() 37 | with open(TREE_DATA, 'w') as tree_data: 38 | json.dump(tree, tree_data) 39 | 40 | 41 | def prepare_new_item(parent_id, name, client_timestamp): 42 | new_id = str(uuid.uuid4()) 43 | 44 | new_node_place = {'projectid' : new_id, 45 | 'parentid' : parent_id, 46 | 'priority' : 999} 47 | 48 | new_node_data = {'projectid' : new_id, 49 | 'name' : name} 50 | 51 | operation = [{'type' : 'create', 52 | 'data' : new_node_place, 53 | 'client_timestamp' : client_timestamp, 54 | 'undo_data' : {}}, 55 | {'type' : 'edit', 56 | 'data' : new_node_data, 57 | 'client_timestamp' : client_timestamp, 58 | 'undo_data': {'previous_last_modified' : client_timestamp, 59 | 'previous_name' : ''}}] 60 | 61 | return operation 62 | 63 | 64 | def prepare_deleted_item(parent_id, deleted_id, client_timestamp): 65 | deleted_node = {'projectid' : deleted_id} 66 | 67 | operation = [{'type' : 'delete', 68 | 'data' : deleted_node, 69 | 'client_timestamp' : client_timestamp, 70 | 'undo_data': {'previous_last_modified' : client_timestamp, 71 | 'parentid' : parent_id, 72 | 'priority' : 0}}] 73 | 74 | return operation 75 | 76 | 77 | def _is_successful(request): 78 | response = request.json() 79 | if 'results' in response and 'error' in response['results'][0]: 80 | return False 81 | if request.status_code != 200: 82 | return False 83 | return True 84 | 85 | 86 | def post_local_change(session_id, operation, parent_id, name, deleted_id=None): 87 | with open(TREE_DATA, 'r') as tree_data: 88 | config = json.load(tree_data) 89 | 90 | client_timestamp = config['projectTreeData']['mainProjectTreeInfo']['dateJoinedTimestampInSeconds'] / 60 91 | most_recent_op = config['projectTreeData']['mainProjectTreeInfo']['initialMostRecentOperationTransactionId'] 92 | client_id = config['projectTreeData']['clientId'] 93 | 94 | push_poll_id = ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase) for _ in range(8)) 95 | 96 | operation_data = [] 97 | if operation == 'add': 98 | operation_data = prepare_new_item(parent_id, name, client_timestamp) 99 | elif operation == 'rm': 100 | operation_data = prepare_deleted_item(parent_id, deleted_id, client_timestamp) 101 | 102 | push_poll_data = [{'most_recent_operation_transaction_id' : most_recent_op, 103 | 'operations' : operation_data}] 104 | 105 | push_poll_data = json.dumps(push_poll_data) 106 | 107 | payload = {'client_id' : client_id, 108 | 'client_version' : 14, 109 | 'push_poll_id' : push_poll_id, 110 | 'push_poll_data' : push_poll_data} 111 | 112 | cookie = {'sessionid' : session_id} 113 | 114 | request = requests.post(WFURL + 'push_and_poll', data=payload, cookies=cookie) 115 | print(request.text) 116 | 117 | if not _is_successful(request): 118 | raise LocalChangePostingError 119 | -------------------------------------------------------------------------------- /wfw/commands.py: -------------------------------------------------------------------------------- 1 | import click 2 | from wfw.wfexceptions import (InvalidTagFormatException, 3 | LocalChangePostingError, 4 | LoginFailedException, 5 | NodeNotFoundError) 6 | from wfw.lib import (add_item, 7 | calc_item_stats, 8 | export_list, 9 | fetch_list, 10 | print_list, 11 | remove_item, 12 | search_nodes, 13 | search_tags, 14 | show_agenda) 15 | 16 | @click.group() 17 | def cli(): 18 | pass 19 | 20 | @cli.command() 21 | def fetch(): 22 | """Fetch list from WorkFlowy server""" 23 | 24 | try: 25 | fetch_list() 26 | except LoginFailedException: 27 | click.echo("Unable to fetch your list: wrong e-mail or password.") 28 | except IOError: 29 | click.echo("Error while fetching: missing config") 30 | 31 | 32 | @cli.command() 33 | @click.argument('file-name', default='tree.exported') 34 | def export(file_name): 35 | """Export your list""" 36 | 37 | try: 38 | export_list(file_name) 39 | except IOError: 40 | click.echo("You have no local list. Please, download it using wfw fetch.") 41 | except Exception as ex: 42 | click.echo("Error while exporting: {msg}".format(msg=ex.message)) 43 | 44 | 45 | @cli.command() 46 | @click.argument('level', default=1) 47 | @click.option('--root', default=None) 48 | def show(level, root): 49 | """Print your list""" 50 | 51 | try: 52 | print_list(level, root) 53 | except IOError: 54 | click.echo("You have no local list. Please, download it using wfw fetch.") 55 | except NodeNotFoundError: 56 | click.echo("No such node") 57 | except Exception as ex: 58 | click.echo("Error while printing list: {msg}".format(msg=ex.message)) 59 | 60 | 61 | @cli.command() 62 | @click.argument('pattern') 63 | def find(pattern): 64 | """Find items using pattern matching""" 65 | 66 | try: 67 | search_nodes(pattern) 68 | except IOError: 69 | click.echo("You have no local list. Please, download it using wfw fetch.") 70 | except Exception as ex: 71 | click.echo("Error while printing list: {msg}".format(msg=ex.message)) 72 | 73 | 74 | @cli.command() 75 | @click.argument('parent-item') 76 | @click.argument('new-item') 77 | def add(parent_item, new_item): 78 | """Add new item to list""" 79 | 80 | try: 81 | add_item(parent_item, new_item) 82 | except LocalChangePostingError: 83 | click.echo("Error while posting your change") 84 | except Exception as ex: 85 | click.echo("Error while adding new item: {msg}".format(msg=ex.message)) 86 | 87 | 88 | @cli.command() 89 | @click.argument('parent-item') 90 | @click.argument('deleted-item') 91 | def rm(parent_item, deleted_item): 92 | """Remove item from list""" 93 | 94 | try: 95 | remove_item(parent_item, deleted_item) 96 | except LocalChangePostingError: 97 | click.echo("Error while posting your change") 98 | except Exception as ex: 99 | click.echo("Error while removing item: {msg}".format(msg=ex.message)) 100 | 101 | 102 | @cli.command() 103 | @click.argument('item') 104 | def info(item): 105 | """Show statistics""" 106 | 107 | try: 108 | calc_item_stats(item) 109 | except Exception as ex: 110 | click.echo("Error while calculating stats: {msg}".format(msg=ex.message)) 111 | 112 | 113 | @cli.command() 114 | @click.argument('tag-to-find') 115 | def tag(tag_to_find): 116 | """Find items containing the given tag""" 117 | 118 | try: 119 | search_tags(tag_to_find) 120 | except IOError: 121 | click.echo("You have no local list. Please, download it using wfw fetch.") 122 | except InvalidTagFormatException as ex: 123 | click.echo("Invalid tag format: {msg}".format(msg=ex.message)) 124 | except Exception as ex: 125 | click.echo("Error while searching tag: {msg}".format(msg=ex.message)) 126 | 127 | 128 | @cli.command() 129 | @click.argument('item') 130 | def agenda(item): 131 | """Agenda view""" 132 | 133 | try: 134 | show_agenda(item) 135 | except Exception as ex: 136 | click.echo("Error while showing your agenda: {msg}".format(msg=ex.message)) 137 | -------------------------------------------------------------------------------- /wfw/lib.py: -------------------------------------------------------------------------------- 1 | from ConfigParser import RawConfigParser 2 | from os.path import expanduser, isfile 3 | import json 4 | 5 | from wfw.api import log_in, log_out, get_list_from_server, post_local_change 6 | from wfw.tree import Tree 7 | from wfw.wfexceptions import LocalChangePostingError, NodeNotFoundError 8 | 9 | 10 | TREE_DATA = expanduser('~/.wfwtree') 11 | USER_DATA = expanduser('~/.wfwrc') 12 | 13 | 14 | def get_tree_from_file(): 15 | tree = None 16 | with open(TREE_DATA, 'r') as tree_data: 17 | tree = Tree(json.load(tree_data)) 18 | return tree 19 | 20 | 21 | def get_user_data(): 22 | if isfile(USER_DATA): 23 | configparser = RawConfigParser() 24 | user_data = {} 25 | with open(USER_DATA) as config: 26 | configparser.readfp(config) 27 | user_data['email'] = configparser.get('user', 'email') 28 | user_data['password'] = configparser.get('user', 'password') 29 | user_data['aux'] = configparser.get('tree', 'shared') 30 | return user_data 31 | 32 | 33 | def fetch_list(): 34 | user = get_user_data() 35 | try: 36 | session_id = log_in(user['email'], user['password']) 37 | except Exception: 38 | raise 39 | else: 40 | get_list_from_server(session_id) 41 | log_out(session_id) 42 | 43 | 44 | def print_list(depth, selected_root=None): 45 | tree = get_tree_from_file() 46 | try: 47 | if selected_root is None: 48 | tree.print_by_node(depth) 49 | else: 50 | tree.print_by_name(selected_root, depth) 51 | except NodeNotFoundError: 52 | raise 53 | 54 | 55 | def export_list(file_name): 56 | tree = get_tree_from_file() 57 | tree.export(file_name) 58 | 59 | 60 | def search_nodes(pattern): 61 | tree = get_tree_from_file() 62 | result = tree.find_nodes(tree.root, pattern) 63 | tree.print_node_list(result) 64 | 65 | 66 | def search_tags(tag): 67 | tree = get_tree_from_file() 68 | result = tree.find_tag(tree.root, tag) 69 | tree.print_node_list(result) 70 | 71 | 72 | def add_item(parent_item, new_item): 73 | tree = get_tree_from_file() 74 | parent_node = tree.get_node(self.root, parent_item) 75 | user = get_user_data() 76 | try: 77 | session_id = log_in(user['email'], user['password']) 78 | post_local_change(session_id, 'add', parent_node['id'], new_item) 79 | except LocalChangePostingError: 80 | log_out(session_id) 81 | raise 82 | except Exception: 83 | raise 84 | else: 85 | get_list_from_server(session_id) 86 | log_out(session_id) 87 | 88 | 89 | def remove_item(parent_item, deleted_item): 90 | tree = get_tree_from_file() 91 | parent_node = tree.get_node(tree.root, parent_item) 92 | deleted_node = tree.get_node(tree.root, deleted_item) 93 | user = get_user_data() 94 | try: 95 | session_id = log_in(user['email'], user['password']) 96 | post_local_change(session_id, 'rm', parent_node['id'], deleted_item, deleted_node['id']) 97 | except LocalChangePostingError: 98 | log_out(session_id) 99 | raise 100 | except Exception: 101 | raise 102 | else: 103 | get_list_from_server(session_id) 104 | log_out(session_id) 105 | 106 | 107 | def calc_item_stats(item): 108 | tree = get_tree_from_file() 109 | node = tree.get_node(tree.root, item) 110 | number_children, done = tree.get_node_info(node) 111 | if node['done']: 112 | done = done - 1 113 | if number_children > 0: 114 | progress = round(done / float(number_children) * 100, 2) 115 | else: 116 | progress = 0 117 | tree.print_node_list([node]) 118 | tree.print_stats(number_children, done, progress) 119 | 120 | def show_agenda(item): 121 | tree = get_tree_from_file() 122 | node = tree.get_node(tree.root, item) 123 | if node: 124 | events = tree.get_agenda(node) 125 | tree.print_agenda(events) 126 | -------------------------------------------------------------------------------- /wfw/tests/tree_test.py: -------------------------------------------------------------------------------- 1 | from io import BytesIO 2 | from mock import call, Mock, mock_open, patch 3 | import json 4 | import unittest 5 | 6 | from wfw.tree import build, export_tree, find_tag, find_nodes, get_agenda, get_node, get_node_info, print_by_name, print_by_node, printable_format 7 | from wfw.wfexceptions import InvalidTagFormatException, NodeNotFoundError 8 | 9 | class TreeTest(unittest.TestCase): 10 | def setUp(self): 11 | self.list_item = [{'lm' : 999, 12 | 'cp' : 999, 13 | 'nm' : 'node1', 14 | 'id' : '2342-1252333-4354-3451'}, 15 | {'lm' : 999, 16 | 'nm' : 'node2', 17 | 'id' : '2342-1252333-4354-3452', 18 | 'ch' : [{'lm' : 888, 19 | 'nm' : 'node4', 20 | 'id' : '2342-1252333-4354-3454'}, 21 | {'lm' : 888, 22 | 'nm' : 'node5', 23 | 'id' : '2342-1252333-4354-3455', 24 | 'ch' : [{'lm' : 777, 25 | 'nm' : 'node6', 26 | 'id' : '2342-1252333-4354-3456'}]}]}, 27 | {'lm' : 999, 28 | 'nm' : 'node3', 29 | 'id' : '2342-1252333-4354-3453'}] 30 | self.tree_data = {'projectTreeData' : {'mainProjectTreeInfo' : {'rootProjectChildren' : self.list_item}}} 31 | self.tree_data = json.dumps(self.tree_data) 32 | 33 | self.root = {'id' : 0, 'text' : 'My list', 'children' : [], 'done' : False} 34 | self.node1 = {'id' : '2342-1252333-4354-3451', 'text' : 'node1', 'children' : [], 'done' : True, 'parent' : 'My list'} 35 | self.node2 = {'id' : '2342-1252333-4354-3452', 'text' : 'node2', 'children' : [], 'done' : False, 'parent' : 'My list'} 36 | self.node3 = {'id' : '2342-1252333-4354-3453', 'text' : 'node3', 'children' : [], 'done' : False, 'parent' : 'My list'} 37 | self.root['children'].append(self.node1) 38 | self.root['children'].append(self.node2) 39 | self.root['children'].append(self.node3) 40 | self.node4 = {'id' : '2342-1252333-4354-3454', 'text' : 'node4', 'children' : [], 'done' : False, 'parent' : 'node2'} 41 | self.node5 = {'id' : '2342-1252333-4354-3455', 'text' : 'node5', 'children' : [], 'done' : False, 'parent' : 'node2'} 42 | self.node6 = {'id' : '2342-1252333-4354-3456', 'text' : 'node6', 'children' : [], 'done' : False, 'parent' : 'node5'} 43 | self.node2['children'].append(self.node4) 44 | self.node2['children'].append(self.node5) 45 | self.node5['children'].append(self.node6) 46 | 47 | 48 | def test_build(self): 49 | mock_file = Mock(spec=file) 50 | mock_file.read.return_value = self.tree_data 51 | result = {'id' : 0, 'text' : 'My list', 'children' : [], 'done' : False} 52 | build(mock_file, result) 53 | 54 | self.assertEqual(result, self.root) 55 | 56 | 57 | def test_export(self): 58 | exported_tree = [call("My list\n"), 59 | call("\tnode1\n"), 60 | call("\tnode2\n"), 61 | call("\t\tnode4\n"), 62 | call("\t\tnode5\n"), 63 | call("\t\t\tnode6\n"), 64 | call("\tnode3\n")] 65 | 66 | unexpected_tree = [call("My list\n"), 67 | call("\tnode2\n"), 68 | call("\t\tnode5\n"), 69 | call("\t\t\tnode6\n"), 70 | call("\tnode3\n")] 71 | 72 | file_name = 'tree.exported' 73 | mock_opener = mock_open() 74 | with patch('wfw.tree.open', mock_opener, create=True): 75 | export_tree(file_name, self.root) 76 | 77 | self.assertEqual(mock_opener().write.call_args_list, exported_tree) 78 | self.assertNotEqual(mock_opener().write.call_args_list, unexpected_tree) 79 | self.assertNotEqual(mock_opener().write.call_args_list, 'bad_output') 80 | 81 | def test_get_node(self): 82 | result = get_node(self.root, 'not_existent_node') 83 | self.assertEqual(result, None) 84 | 85 | result = get_node(self.root, 'My list') 86 | self.assertEqual(result, self.root) 87 | 88 | result = get_node(self.root, 'node2') 89 | self.assertEqual(result, self.node2) 90 | 91 | result = get_node(self.root, 'node6') 92 | self.assertEqual(result, self.node6) 93 | 94 | def test_find_nodes(self): 95 | result = find_nodes(self.root, 'no*') 96 | self.assertItemsEqual(result, [self.node1, self.node2, self.node3, self.node4, self.node5, self.node6]) 97 | 98 | def test_print_by_name(self): 99 | expected_tree_depth_limited = ("* node2\n" 100 | " * node4\n" 101 | " * node5\n") 102 | 103 | expected_tree_without_limit = ("* node2\n" 104 | " * node4\n" 105 | " * node5\n" 106 | " * node6\n") 107 | 108 | with patch('sys.stdout', new=BytesIO()) as fakeout: 109 | print_by_name('node2', 1, self.root) 110 | self.assertEqual(fakeout.getvalue(), expected_tree_depth_limited) 111 | 112 | with patch('sys.stdout', new=BytesIO()) as fakeout: 113 | print_by_name('node2', 2, self.root) 114 | self.assertEqual(fakeout.getvalue(), expected_tree_without_limit) 115 | 116 | self.assertRaises(NodeNotFoundError, print_by_name, 'not_existent_node', 1, self.root) 117 | 118 | 119 | def test_print_by_node(self): 120 | expected_tree = ("* My list\n" 121 | " * \033[2mnode1\033[0m\n" 122 | " * node2\n" 123 | " * node4\n" 124 | " * node5\n" 125 | " * node6\n" 126 | " * node3\n") 127 | 128 | with patch('sys.stdout', new=BytesIO()) as fakeout: 129 | print_by_node(self.root, 3) 130 | self.assertEqual(fakeout.getvalue(), expected_tree) 131 | 132 | 133 | def test_find_tag(self): 134 | root = {'id' : 0, 'text' : 'My list', 'children' : []} 135 | with_tag = {'id' : 1, 'text' : 'Pretty little node with a #tag', 'children' : []} 136 | without_tag = {'id' : 2, 'text' : 'Pretty little node without a tag', 'children' : []} 137 | root['children'].append(without_tag) 138 | without_tag['children'].append(with_tag) 139 | 140 | self.assertEqual(find_tag(root, '#tag'), [with_tag]) 141 | 142 | invalid_tags = ('cica', 'ci#ca', '%cica', '(cica)', '$cica', 143 | '!cica', 'cic@', '*cica', '&cica', '%cica') 144 | 145 | for tag in invalid_tags: 146 | self.assertRaises(InvalidTagFormatException, find_tag, self.root, tag) 147 | 148 | def test_colored_output(self): 149 | node_simple = {'id' : 10, 'text' : 'i am a simple node', 'done' : False} 150 | node_bold = {'id' : 11, 'text' : 'i am bold', 'done' : False} 151 | node_bold_wannabe = {'id' : 12, 'text' : 'i wanna be bold', 'done' : False} 152 | node_tagged_bang = {'id' : 13, 'text' : 'i am a node with a #tag', 'done' : False} 153 | node_tagged_at = {'id' : 14, 'text' : 'i am a node with a @tag', 'done' : False} 154 | node_bold_tagged = {'id' : 15, 'text' : 'i am so bold that i have a #tag', 'done' : False} 155 | node_done = {'id' : 15, 'text' : 'i am done', 'done' : True} 156 | 157 | self.assertEquals('* i am a simple node', printable_format(node_simple)) 158 | self.assertEquals('* \033[1mi am bold\033[0m', printable_format(node_bold)) 159 | self.assertEquals('* i wanna be bold', printable_format(node_bold_wannabe)) 160 | self.assertEquals('* i am a node with a \033[33m#tag\033[0m', printable_format(node_tagged_bang)) 161 | self.assertEquals('* i am a node with a \033[33m@tag\033[0m', printable_format(node_tagged_at)) 162 | self.assertEquals('* \033[1mi am so bold that i have a \033[33m#tag\033[0m', printable_format(node_bold_tagged)) 163 | self.assertEquals('* \033[2mi am done\033[0m', printable_format(node_done)) 164 | 165 | def test_get_node_info(self): 166 | self.assertEquals((3, 0), get_node_info(self.node2)) 167 | 168 | def test_agenda(self): 169 | agenda = [{'id' : 2, 170 | 'text' : 'meeting @bar #2015-01-01'}, 171 | {'id' : 3, 172 | 'text' : 'doing nothing #2015-01-07'}, 173 | {'id' : 4, 174 | 'text' : 'breathing'}, 175 | {'id' : 5, 176 | 'text' : 'going home #2015-01-03'}] 177 | root = {'id' : 0, 'text' : 'a', 'children' : agenda} 178 | expected = [{'desc' : 'meeting', 179 | 'place' : 'bar', 180 | 'date' : '2015-01-01'}, 181 | {'desc' : 'going home', 182 | 'date' : '2015-01-03'}, 183 | {'desc' : 'doing nothing', 184 | 'date' : '2015-01-07'}] 185 | 186 | self.assertEqual(get_agenda(root), expected) 187 | -------------------------------------------------------------------------------- /wfw/tree.py: -------------------------------------------------------------------------------- 1 | import json 2 | import re 3 | from operator import itemgetter 4 | 5 | from wfw.wfexceptions import NodeNotFoundError, InvalidTagFormatException 6 | 7 | 8 | DIM = '\033[2m' 9 | BRIGHT = '\033[1m' 10 | YELLOW = '\033[33m' 11 | WHITE = '\033[37m' 12 | END = '\033[0m' 13 | 14 | 15 | class Tree(object): 16 | def __init__(self, raw): 17 | self.root = {'id' : "None", 'text' : 'My list', 'children' : [], 'done' : False} 18 | children_of_root = raw['projectTreeData']['mainProjectTreeInfo']['rootProjectChildren'] 19 | 20 | for child in children_of_root: 21 | self._add_node(child, self.root) 22 | 23 | def _add_node(self, node, parent): 24 | is_done = 'cp' in node.keys() 25 | new_node = {'id' : node['id'], 26 | 'text' : node['nm'].encode('utf-8'), 27 | 'children' : [], 28 | 'done' : is_done, 'parent' : parent['text']} 29 | parent['children'].append(new_node) 30 | 31 | if 'ch' in node.keys(): 32 | for child in node['ch']: 33 | self._add_node(child, new_node) 34 | 35 | def get_node(self, node, text_to_find): 36 | if node['text'] == text_to_find.encode('utf-8'): 37 | return node 38 | for child in node['children']: 39 | result = self.get_node(child, text_to_find) 40 | if result: 41 | return result 42 | 43 | def find_nodes(self, node, text_to_find, result=[]): 44 | pattern = re.compile(text_to_find) 45 | for child in node['children']: 46 | if pattern.match(child['text']): 47 | result.append(child) 48 | self.find_nodes(child, text_to_find, result) 49 | 50 | return result 51 | 52 | def find_tag(self, node, tag, result=[]): 53 | if tag[0] == '#' or tag[0] == '@': 54 | for child in node['children']: 55 | if tag.encode('utf-8') in child['text']: 56 | result.append(child) 57 | self.find_tag(child, tag, result) 58 | 59 | return result 60 | raise InvalidTagFormatException 61 | 62 | def _write_to_file(self, destination, start, depth=0): 63 | destination.write(exportable_format(start, depth)) 64 | for child in start['children']: 65 | self.write_to_file(destination, child, depth+1) 66 | 67 | def export_tree(self, file_name): 68 | with open(file_name, 'w') as destination: 69 | self.write_to_file(destination, self.root) 70 | 71 | def get_node_info(self, node, children_number=0, done=0): 72 | children_number += len(node['children']) 73 | if node['done']: 74 | done += 1 75 | for child in node['children']: 76 | children_number, done = self.get_node_info(child, children_number, done) 77 | 78 | return (children_number, done) 79 | 80 | def print_by_node(self, start, depth, current_depth=0): 81 | print(self._printable_format(start, current_depth)) 82 | 83 | if depth > current_depth: 84 | current_depth += 1 85 | for child in start['children']: 86 | self.print_by_node(child, depth, current_depth) 87 | 88 | def print_by_name(self, name, depth): 89 | selected_root = self.get_node(self.root, name) 90 | if selected_root is None: 91 | raise NodeNotFoundError 92 | self.print_by_node(selected_root, depth) 93 | 94 | def print_node_list(self, nodelist): 95 | for node in nodelist: 96 | if 'parent' in node: 97 | print("{}\n parent: {}".format(self._printable_format(node), node['parent'])) 98 | 99 | def _exportable_format(self, node, depth): 100 | return "{fill}{name}\n".format(fill='\t' * depth, name=node['text']) 101 | 102 | def _printable_format(self, node, depth=0): 103 | name = node['text'] 104 | 105 | if node['done']: 106 | name = "{}{}{}".format(DIM, name, END) 107 | elif '' in name and '' in name: 108 | name = name.replace('', BRIGHT) 109 | name = name.replace('', END) 110 | 111 | for tag in ('@', '#'): 112 | if tag in name: 113 | index = name.index(tag) 114 | name = "{}{}{}".format(name[:index], YELLOW, name[index:]) 115 | if not name.endswith(END): 116 | name = name + END 117 | 118 | return "{fill}* {name}".format(fill=' ' * depth, name=name) 119 | 120 | def print_stats(self, children, done, progress): 121 | print(" subtasks: {}".format(children)) 122 | print(" done: {}".format(done)) 123 | print(" progress: {}%".format(progress)) 124 | 125 | def get_agenda(self, node): 126 | events = [] 127 | for child in node['children']: 128 | event = dict() 129 | event_words = [] 130 | tokens = child['text'].split(' ') 131 | for token in tokens: 132 | if token.startswith('@'): 133 | event['place'] = token[1:] 134 | elif token.startswith('#'): 135 | event['date'] = token[1:] 136 | else: 137 | event_words.append(token) 138 | event['desc'] = " ".join(event_words) 139 | if 'date' in event: 140 | events.append(event) 141 | 142 | events.sort(key=itemgetter('date')) 143 | 144 | return events 145 | 146 | def print_agenda(self, events): 147 | current_date = events[0]['date'] 148 | print("---{}---".format(current_date)) 149 | for event in events: 150 | if not current_date == event['date']: 151 | current_date = event['date'] 152 | print("---{}---".format(current_date)) 153 | print(" {}".format(event['desc'])) 154 | if "place" in event: 155 | print(" // {}".format(event['place'])) 156 | -------------------------------------------------------------------------------- /wfw/wfexceptions.py: -------------------------------------------------------------------------------- 1 | class LoginFailedException(Exception): 2 | pass 3 | 4 | class NodeNotFoundError(Exception): 5 | pass 6 | 7 | class InvalidTagFormatException(Exception): 8 | pass 9 | 10 | class LocalChangePostingError(Exception): 11 | pass 12 | --------------------------------------------------------------------------------