├── .gitignore ├── LICENSE ├── README.md ├── resources_packer ├── resources_packer.bat └── screenshot.png /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | 55 | # Sphinx documentation 56 | docs/_build/ 57 | 58 | # PyBuilder 59 | target/ 60 | 61 | #Ipython Notebook 62 | .ipynb_checkpoints 63 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # resources_packer 资源包生成工具 2 | 3 | resources_packer是一个简单实用的游戏资源更新包制作工具。 4 | 5 | 6 | ## 应用场景 7 | 8 | 玩游戏的时候经常遇到这样的一个场景，打开游戏，提示正在下载游戏资源更新包。 9 | 10 | 假设本地游戏版本1.0.0， 提示下载1.0.0-1.zip更新包，那么这个zip包当中，包含的是的1.0.0版本与1.0.1版本差异的文件； 11 | 12 | 假设本地游戏版本1.0.1， 很久没有玩游戏，提示正在更新1.0.1-10.zip更新包，这个zip包当中，包含了从1.0.1版本到1.0.10版本的所有差异文件。 13 | 14 | 那么，像1.0.1-10.zip这种差异包，是如何生成？人工挑出差异文件，制作zip包？有没有自动化的方法？ 15 | 16 | resources_packer就是一个生成版本差异资源包自动化工具。 17 | 18 | ## Example 19 | 20 | 假设, 所需打包的目录testdir 21 | 22 | > - testdir 23 | > - test1.txt 24 | > - test2.txt 25 | 26 | 执行命令, 操作行为check 27 | ```shell 28 | resources_packer -paths testdir -package-name TestPackage -artifact-dir testdirOutput -action check 29 | 30 | ``` 31 | 32 | 这时候，与testdir目录平级的testdirOutput目录下，将生成: 33 | 34 | > - testdirOutput --> 输出目录 35 | > - TestPackage.0.zip --> 生成的0号资源包，包含test1.txt, test2.txt两个文件 36 | > - TestPackage.0.zip.md5 --> 0号资源包的md5文本 37 | > - TestPackage.resource_version.txt --> TestPackage这个系列包的最新版本（比如当前内容为0） 38 | 39 | 40 | 这时候，我们已经拥有了0号资源包了。我们做一些差异文件：往testdir里新加文件test3.txt。 41 | testdir目录的结构将变化成： 42 | > - testdir 43 | > - test1.txt 44 | > - test2.txt 45 | > - test3.txt 46 | 47 | 执行命令, 操作行为pack： 48 | ```shell 49 | resources_packer -paths testdir -package-name TestPackage -artifact-dir testdirOutput -action pack 50 | ``` 51 | 52 | 53 | 这时候，与testdir目录平级的testdirOutput目录下，将变成: 54 | 55 | > - testdirOutput --> 输出目录 56 | > - TestPackage.0.zip --> 生成的0号资源包全量包，包含test1.txt, test2.txt两个文件 57 | > - TestPackage.0.zip.md5 --> 0号资源包的md5文本 58 | > - TestPackage.0-1.zip --> 0号资源包与1号资源包的差异包 59 | > - TestPackage.0-1.zip.md5 60 | > - TestPackage.1.zip --> 1号资源包的全量包 61 | > - TestPackage.1.zip.md5 62 | > - TestPackage.resource_version.txt --> TestPackage这个系列包的最新版本（现在内容为1） 63 | 64 | 好了，一个差异资源包0-1就这样生成了。 65 | 66 | 为什么同时有全量包和差异包？ 67 | 因为差异包的生成，是基于两个全量包之间进行比较的。 68 | 69 | ## 生成的zip包，有什么特别？ 70 | 71 | > - .manifest 记录全量的文件（不论差异与否，所有的目录文件）的大小、MD5等文件信息 72 | > - OTHER1 73 | > - OTHER2 74 | > - OTHER3/OTHER4.txt 75 | 76 | 简而言之，生成的资源zip，只有根路径的.manifest文件是由resources_packer生成的，其余的所有文件，都是您所设置的资源文件。 77 | 78 | 79 | ## 命令行如何获取帮助? 80 | 81 | 你可以同通过命令行获取到详细帮助: 82 | 83 | ![screenshot.png](screenshot.png) 84 | 85 | Linux/Unix下： 86 | ```shell 87 | resources_packer --help 88 | ``` 89 | 90 | Windows下，需要预先安装Python环境： 91 | ```shell 92 | resources_packer.bat --help 93 | ``` 94 | 或 95 | ```shell 96 | python resources_packer --help 97 | ``` 98 | 99 | ## 打包操作模式 100 | 101 | resources_packer有几种不同的操作模式，来适应不同的实际情况。参数-action传入。 102 | 103 | ### check检查或创建 104 | 常用。检查是否存在当前版本的资源包，不存在则init创建。存在则不做任何事。 105 | 106 | 假设，当前没有生成任何资源包，则生成0号zip包。 107 | 假设，当前已有0号zip包，则不做任何事。 108 | 109 | ### pack差异打包 110 | 核心。生成差异资源包时，提升资源版本号。 111 | 112 | 假设当前已0号资源包， 执行pack行为，将会识别0号资源包的文件，与当前所有资源文件进行比较。差异的文件，生成1号资源包。 113 | 114 | 115 | ### init初始化 116 | 117 | 强制重新生成当前版本的差异包。 118 | 119 | 假设当前资源版本10， 执行init后，重新生成10版本，覆盖之前的10号资源包。 120 | 121 | init一般很少手动执行，一般在你不想修改当前资源包版本号，但又想重新添加差异文件的时候使用。 122 | 123 | ### clean清理 124 | 125 | 清理旧版本的zip包。 126 | 假设当前最新版本3，那么其实只会用到1-3, 2-3, 0-3几个zip包。像0-2, 1-2这种旧版本的zip包，已经没有用处了。执行clean，它们将被归档到archives目录，考虑到稳健性，不做删除操作。 127 | 128 | ### test测试 129 | 130 | 将会在脚本目录进行一系列的测试，并生成目录。可以快速验证resources_packer的效果； 131 | 测试包括跨文件版本回滚、跨版本删除文件； 132 | 如版本1新增文件，版本2删掉该文件，版本3恢复版本1的文件； 133 | 1-2包，将包含.deleted文件； 134 | 1-3包，包含.deleted文件； 135 | 2-3包，整个zip只有.manifest文件 136 | -------------------------------------------------------------------------------- /resources_packer: -------------------------------------------------------------------------------- 1 | #!/bin/env python 2 | #encoding=utf-8 3 | """ 4 | 5 | Author : chenpeilin <23110388@qq.com> 6 | Website: http://github.com/mr-kelly/resources_packer 7 | 8 | 用于指定目录的差异zip包命令行工具，无项目逻辑依赖，可各个项目使用 9 | 10 | 注意点：跨版本，文件回滚； 相邻版本，文件删除 11 | """ 12 | import argparse, os, sys, zipfile, csv 13 | import StringIO 14 | import hashlib 15 | import datetime 16 | import shutil 17 | import errno 18 | 19 | MANIFEST_FILE_NAME ='.manifest' 20 | MANIFEST_HEADERS = ['File', 'MD5', 'Size', 'MTime', 'MFormatTime'] 21 | 22 | def get_clean_path(dirtyPath): 23 | """ 24 | 获取干净路径，主要替换windows的\\ 25 | """ 26 | return dirtyPath.replace('\\', '/') 27 | 28 | def get_stream_md5(stream): 29 | """ 30 | 获取流的MD5 31 | """ 32 | return hashlib.md5(stream.read()).hexdigest().upper() 33 | 34 | def get_file_md5(filePath): 35 | """ 36 | 获取文件的MD5 37 | """ 38 | return get_stream_md5(open(filePath, 'rb')) 39 | 40 | def verify_package(packagePath, writedFilesMap, deleted_files_map): 41 | """ 42 | 校验文件内容是否跟manifest一致，一致则生成md5文件 43 | """ 44 | assert(os.path.isfile(packagePath)) 45 | with zipfile.ZipFile(packagePath, 'r', zipfile.ZIP_DEFLATED) as rz: 46 | print 'Verify zip package correct ... %s' % packagePath 47 | rManifestStream = rz.open(MANIFEST_FILE_NAME) 48 | rManifestReader = csv.DictReader(rManifestStream, delimiter=' ', fieldnames=MANIFEST_HEADERS) 49 | 50 | for row in rManifestReader: 51 | # 忽略第一行header 52 | if rManifestReader.line_num == 1: 53 | continue 54 | 55 | zipFilePath = row['File'] 56 | if not zipFilePath in writedFilesMap: # 上一次没有写入，忽略校验 57 | continue 58 | 59 | md5Str = row['MD5'] 60 | 61 | zipFileMd5 = get_stream_md5(rz.open(zipFilePath)) 62 | fullFile = writedFilesMap[zipFilePath] 63 | assert(zipFileMd5 == md5Str) 64 | assert(zipFileMd5 == get_file_md5(fullFile)) 65 | 66 | for deleted in deleted_files_map: 67 | try: 68 | rz.open(deleted) 69 | except: 70 | continue # 不存在就对了，存在反而不对 71 | assert(False) 72 | 73 | # 验证成功，生成md5文件 74 | with open('%s.md5' % packagePath, 'wb+') as md5f: 75 | md5f.write(get_file_md5(packagePath)) 76 | return True 77 | 78 | 79 | def create_package(args, packagePath, paths, compareFilesMap=None, force_create=False): 80 | """ 81 | 创建资源包 82 | 后面参数为空则是全量包了 83 | force_create 默认如果没有任何文件差异，会自动删除掉文件，适用于跨版本差异包，文件回滚状态时，如3-7版本，虽然没有变化，但要强制创建 84 | compareFilesMap 为上一版的文件列表 85 | """ 86 | 87 | print('@@ => Create Package ... %s' % packagePath) 88 | 89 | writedFilesMap = {} # 写入过的文件统计 / zipPath -> fullPath 90 | touchFilesMap = {} # 检查过但没有实际写入的文件统计 / zipPath -> fullPath 91 | deleted_files_map = {} # 差异比较后，被删除的文件的列表 92 | 93 | print paths 94 | 95 | if os.path.isfile(packagePath): 96 | print '[WARN]Delete and repack ... %s' % packagePath 97 | os.remove(packagePath) 98 | 99 | manifestStream = StringIO.StringIO() 100 | manifestCsv = csv.DictWriter(manifestStream, delimiter=' ', fieldnames=MANIFEST_HEADERS) 101 | manifestCsv.writeheader() 102 | with zipfile.ZipFile(packagePath, 'w', zipfile.ZIP_DEFLATED) as zf: 103 | for path in paths: 104 | abspath = os.path.abspath(path) 105 | 106 | if not os.path.isdir(abspath): 107 | print('[WARN]Cannot found directory: %s, ignore it' % abspath) 108 | continue 109 | 110 | topDirPath = get_clean_path(os.path.dirname(abspath)) # 上级目录路径，替换掉这个字符串，就是最终目录相对路径了 111 | 112 | print 'Top Dir: ' + topDirPath 113 | print('') 114 | 115 | for dirFullPath, subdirList, fileList in os.walk(abspath): 116 | cleanDirFullPath = get_clean_path(dirFullPath) 117 | # 文件夹相对zip的路径 = 完整路径 - 上层大目录路径 118 | dirZipPath = cleanDirFullPath.replace(topDirPath, '') 119 | 120 | for filePath in fileList: 121 | 122 | fileFullPath = get_clean_path('%s/%s' % (cleanDirFullPath, filePath)) 123 | filename, file_extension = os.path.splitext(fileFullPath) 124 | 125 | # 文件相对zip的路径 126 | fileZipPath = get_clean_path('%s/%s' % (dirZipPath, filePath)) 127 | fileZipPath = fileZipPath.lstrip('/') # 去掉开始的/ 128 | 129 | # 扩展名判断 130 | hasIgnoreExt = False 131 | if args.ignores_ext != None:# and file_extension in args.ignores_ext: 132 | for ext in args.ignores_ext: 133 | if fileFullPath.endswith(ext): 134 | hasIgnoreExt = True # 忽略该扩展名的 135 | if hasIgnoreExt: 136 | continue 137 | 138 | # 是否激活黑名单模式 139 | in_blacklist = False # 默认true 140 | if args.blacklist: #黑名单存在则要判断 141 | for black_item in args.blacklist: 142 | if black_item in fileFullPath: 143 | in_blacklist = True 144 | break 145 | 146 | if in_blacklist: 147 | # 黑名单直接忽略 148 | # if compareFilesMap: 149 | # manifestCsv.writerow(compareFilesMap[fileZipPath]) 150 | continue 151 | 152 | fileMD5 = get_file_md5(fileFullPath) 153 | 154 | # 进行比较! 如果一样，不写入文件，但写入信息, 以下是写入文件 155 | if ( \ 156 | compareFilesMap == None or \ 157 | (fileZipPath not in compareFilesMap) or \ 158 | (fileZipPath in compareFilesMap and compareFilesMap[fileZipPath]['MD5'] != fileMD5) \ 159 | ): 160 | 161 | print('%s --> %s' % (fileFullPath, fileZipPath)) 162 | zf.write(fileFullPath, fileZipPath) 163 | writedFilesMap[fileZipPath] = fileFullPath 164 | print 'write .... %s' % fileZipPath 165 | 166 | # 使用整数时间戳 167 | os.stat_float_times(False) 168 | file_mtime = os.path.getmtime(fileFullPath) 169 | 170 | touchFilesMap[fileZipPath] = fileFullPath 171 | # 所有文件都写入这里，无例外 172 | manifestCsv.writerow({ 173 | 'File': fileZipPath, 174 | 'MD5': fileMD5, 175 | 'Size' : os.path.getsize(fileFullPath), 176 | 'MTime' : file_mtime, 177 | 'MFormatTime' : datetime.datetime.fromtimestamp(os.path.getmtime(fileFullPath)) 178 | }) 179 | zf.writestr(MANIFEST_FILE_NAME, manifestStream.getvalue()) 180 | 181 | # 判断有无文件删除 182 | if compareFilesMap: 183 | for filepath in compareFilesMap.keys(): 184 | if not filepath in touchFilesMap.keys(): 185 | print("[Deleted]Found a deleted file `%s`" % (filepath)) 186 | deleted_files_map[filepath] = compareFilesMap[filepath] 187 | 188 | # 写入被删除的文件的列表 189 | if len(deleted_files_map) > 0: 190 | deletedStream= StringIO.StringIO() 191 | for k in deleted_files_map.keys(): 192 | deletedStream.write('%s\n'%k) 193 | zf.writestr('.deleted', deletedStream.getvalue()) 194 | 195 | 196 | 197 | 198 | 199 | #print manifestStream.getvalue() 200 | print("Total Writed Files Count: %d" % len(writedFilesMap)) 201 | has_changed = len(writedFilesMap) > 0 or len(deleted_files_map) > 0 202 | 203 | # 验证文件 204 | verify_package(packagePath, writedFilesMap, deleted_files_map) 205 | 206 | manifestStream.close() 207 | 208 | 209 | # 处理有没有文件被删除的情况 210 | 211 | # 如果没任何操作就直接退出，不写入版本，并且删除临时创建的zip 212 | if not has_changed and not force_create: 213 | # 没写入任何文件，删掉生成的zip直接退出吧 214 | print("[WARN]No Files Changed, no need to Zip Resource : %s "% packagePath) 215 | os.remove(packagePath) 216 | return False 217 | return True 218 | 219 | 220 | 221 | def mkdir_p(path): 222 | """ 223 | same as command `mkdir -p` 224 | """ 225 | try: 226 | os.makedirs(path) 227 | except OSError as exc: # Python >2.5 228 | if exc.errno == errno.EEXIST and os.path.isdir(path): 229 | pass 230 | else: 231 | raise 232 | 233 | def get_current_resource_version(versionFilePath): 234 | """ 235 | 获取当前Resource Version返回 int 236 | """ 237 | strVersion = '' 238 | with open(versionFilePath, 'rb+') as f: 239 | strVersion = f.read() 240 | return int(strVersion) 241 | 242 | def create_package_diff(args, autoClean = True): 243 | """ 244 | 创建指定新版本的新差异资源包 245 | 246 | autoClean 是否创建完毕后，清理旧的差异包 247 | """ 248 | args.resVersion = args.newResVersion - 1 249 | 250 | 251 | # 寻找上一版zip包, 总结跟现在的不同 252 | i = args.resVersion + 1 253 | bResult = True # 标记是否有任意失败 254 | force_create_diff = False 255 | while True: 256 | i = i - 1 257 | if i < 0: 258 | break 259 | 260 | _zipName = '%s.%d.zip' % ( args.package_name, i) # 用来对比差异的zip包 261 | _zipPath = '%s/%s' % (args.artifact_dir, _zipName) 262 | 263 | print '' 264 | print '====>' 265 | print 'ANANALYSE ==============> %s' % _zipName 266 | 267 | compareFilesMap = {} # 文件历史记录在这 268 | 269 | if not os.path.isfile(_zipPath): 270 | print("[ERROR]Cannot find package: %s" % _zipName) 271 | sys.exit(1) 272 | 273 | # 读取上一版的manifeset 274 | with zipfile.ZipFile(_zipPath, 'r') as rzip: 275 | rManifestStream = rzip.open(MANIFEST_FILE_NAME) 276 | rManifestReader = csv.DictReader(rManifestStream, delimiter=' ', fieldnames=MANIFEST_HEADERS) 277 | 278 | for row in rManifestReader: 279 | # 忽略第一行header 280 | if rManifestReader.line_num == 1: 281 | continue 282 | 283 | compareFilesMap[row['File']] = row # 读取到所有记录 284 | 285 | # 写入新版 286 | newPackageName = '%s.%d-%d.zip' % (args.package_name, i, args.newResVersion) 287 | newPackagePath = '%s/%s' % (args.artifact_dir, newPackageName) 288 | print 'NEW PACK ==============> %s' % newPackageName 289 | 290 | if create_package(args, newPackagePath, args.paths, compareFilesMap, force_create_diff): 291 | # 当最后一个差异包生成成功后，要确保其它差异包强制生成！ 292 | if (i+1) == args.newResVersion: # 293 | force_create_diff = True 294 | pass 295 | else: 296 | # 任意一个没有构建成功直接退出吧 297 | bResult = False 298 | break 299 | 300 | return bResult 301 | 302 | def clean_old_packages(args): 303 | """ 304 | 清理指定旧版本的所有资源包 305 | """ 306 | args.resVersion = get_current_resource_version(args.version_file) 307 | cleanVersion = args.resVersion - 1 # 因为未知上一阶段是否生成生成，所以起始位上上个版本 308 | 309 | for _oldVersion in range(1, cleanVersion + 1): 310 | # 清理资源版本的顶头包，比如现在最新资源版本7, 那么0-6, 1-6等，已经用不上了 311 | for i in range(0, _oldVersion): 312 | oldPackageName = '%s.%d-%d.zip' % (args.package_name, i, _oldVersion) 313 | oldPackagePath = '%s/%s' % (args.artifact_dir, oldPackageName) 314 | archiveDir = '%s/archives' % args.artifact_dir 315 | mkdir_p(archiveDir) 316 | moveToPath = '%s/%s' % (archiveDir, oldPackageName) 317 | if os.path.isfile(oldPackagePath): 318 | shutil.move(oldPackagePath, moveToPath) 319 | print('Clean/Archived `%s`' % oldPackageName) 320 | 321 | def test_assert_nofile(zip_path, filepath): 322 | """ 323 | 断点一个zip包里 不！ 包含一个文件 324 | """ 325 | with zipfile.ZipFile(zip_path, 'r') as rzip: 326 | try: 327 | rzip.open(filepath) 328 | except: 329 | return # 不存在，则成功 330 | assert(False) 331 | 332 | def test_assert_file(zip_path, filepath): 333 | """ 334 | 断点一个zip包里包含一个文件 335 | """ 336 | with zipfile.ZipFile(zip_path, 'r') as rzip: 337 | assert(rzip.open(filepath)) 338 | 339 | def test(args): 340 | """ 341 | 自动化测试 342 | """ 343 | print("A test for resources_packer, will generate a test folder under script") 344 | script_path = os.path.dirname(os.path.realpath(__file__)) 345 | test_dirpath = os.path.join(script_path, '___test_resources_packer') 346 | test_artifactpath = os.path.join(script_path, '___test_resources_packer_artifacts') 347 | 348 | if os.path.exists(test_dirpath): 349 | print('Delete test dir... %s' % test_dirpath) 350 | shutil.rmtree(test_dirpath) 351 | if os.path.exists(test_artifactpath): 352 | print('Delete test dir... %s' % test_artifactpath) 353 | shutil.rmtree(test_artifactpath) 354 | 355 | os.makedirs(test_dirpath) 356 | os.makedirs(os.path.join(test_dirpath, 'subdir')) 357 | os.makedirs(test_artifactpath) 358 | 359 | args.paths = [test_dirpath] 360 | args.package_name = 'test_package' 361 | args.artifact_dir = test_artifactpath 362 | 363 | 364 | # create test file 365 | with open(os.path.join(test_dirpath, 'a.file'), 'wb+') as wf: 366 | wf.write('ok, this is a file') 367 | 368 | args.action = 'init' 369 | init_args(args) 370 | do_init_or_check(args) 371 | test_assert_file(os.path.join(test_artifactpath, 'test_package.0.zip'), '___test_resources_packer/a.file') 372 | 373 | args.action = 'check' 374 | init_args(args) 375 | do_init_or_check(args) 376 | 377 | # 1号包 378 | with open(os.path.join(test_dirpath, 'a.file'), 'wb+') as wf: 379 | wf.write('ok, this is a file but modified') 380 | init_args(args) 381 | do_pack(args) 382 | assert(os.path.exists(os.path.join(test_artifactpath, 'test_package.0-1.zip'))) 383 | test_assert_file(os.path.join(test_artifactpath, 'test_package.0-1.zip'), '___test_resources_packer/a.file') 384 | 385 | # 无差异，不会生成资源包 386 | args.action = 'pack' 387 | init_args(args) 388 | do_pack(args) 389 | assert(not os.path.exists(os.path.join(test_artifactpath, 'test_package.0-.zip'))) 390 | 391 | # 2号包，回滚a文件内容， 测试跨版本，回滚同样的内容生成出包 392 | with open(os.path.join(test_dirpath, 'a.file'), 'wb+') as wf: 393 | wf.write('ok, this is a file') 394 | init_args(args) 395 | do_pack(args) 396 | assert(os.path.exists(os.path.join(test_artifactpath, 'test_package.0-2.zip'))) 397 | test_assert_nofile(os.path.join(test_artifactpath, 'test_package.0-2.zip'), '___test_resources_packer/a.file') 398 | 399 | # 3号包 400 | with open(os.path.join(test_dirpath, 'subdir', 'b.file'), 'wb+') as wf: 401 | wf.write('ok, this is b file') 402 | init_args(args) 403 | do_pack(args) 404 | assert(os.path.exists(os.path.join(test_artifactpath, 'test_package.0-3.zip'))) 405 | test_assert_file(os.path.join(test_artifactpath, 'test_package.0-3.zip'), '___test_resources_packer/subdir/b.file') 406 | 407 | 408 | # 4号包，回到了0号包的同样状态 409 | os.remove(os.path.join(test_dirpath, 'subdir', 'b.file')) 410 | init_args(args) 411 | do_pack(args) 412 | assert(os.path.exists(os.path.join(test_artifactpath, 'test_package.0-4.zip'))) 413 | test_assert_nofile(os.path.join(test_artifactpath, 'test_package.0-4.zip'), '___test_resources_packer/subdir/b.file') 414 | 415 | # 5号包，多生成写文件 c 416 | with open(os.path.join(test_dirpath, 'subdir', 'c.file'), 'wb+') as wf: 417 | wf.write('ok, this is c file') 418 | init_args(args) 419 | do_pack(args) 420 | assert(os.path.exists(os.path.join(test_artifactpath, 'test_package.0-5.zip'))) 421 | test_assert_file(os.path.join(test_artifactpath, 'test_package.0-5.zip'), '___test_resources_packer/subdir/c.file') 422 | 423 | # 6号包，删除所有。。。 424 | os.remove(os.path.join(test_dirpath, 'a.file')) 425 | os.remove(os.path.join(test_dirpath, 'subdir', 'c.file')) 426 | init_args(args) 427 | do_pack(args) 428 | assert(os.path.exists(os.path.join(test_artifactpath, 'test_package.0-6.zip'))) 429 | test_assert_nofile(os.path.join(test_artifactpath, 'test_package.0-6.zip'), '___test_resources_packer/subdir/b.file') 430 | test_assert_nofile(os.path.join(test_artifactpath, 'test_package.0-6.zip'), '___test_resources_packer/subdir/c.file') 431 | test_assert_nofile(os.path.join(test_artifactpath, 'test_package.0-6.zip'), '___test_resources_packer/a.file') 432 | 433 | 434 | def do_pack(args): 435 | """ 436 | 执行pack操作 437 | """ 438 | bResult = create_package_diff(args) 439 | 440 | if bResult: 441 | 442 | # 差异包生成完，生成对应版本的完整包 443 | newFullPackageName = '%s.%d.zip' % (args.package_name, args.newResVersion) 444 | newFullPackagePath = '%s/%s' % (args.artifact_dir, newFullPackageName) 445 | create_package(args, newFullPackagePath, args.paths, None) 446 | 447 | 448 | cleanVersion = args.resVersion 449 | # 修改版本号，并写入 450 | with open(args.version_file, 'wb+') as wf: 451 | wf.write(str(args.newResVersion).zfill(8)) 452 | print('') 453 | print('New Resource Version --> %s' % args.newResVersion) 454 | 455 | # TODO: 暂时不清理，永久保留历史 456 | # clean_old_packages(args) 457 | 458 | 459 | def do_init_or_check(args): 460 | # 直接生成完整包 461 | # init相当于强制创建 462 | if not os.path.isfile(args.get_main_package_path() ) or args.action == 'init': # 不存在，或init时强制重新创建版本完整包 463 | create_package(args, args.get_main_package_path() , args.paths) 464 | 465 | if args.resVersion != 0: 466 | create_package_diff(args, False) # 重复生成差异包，这时候已经没有差异了，强制生成空的 467 | print("[WARN]ReBuild Main Package because it has existed... %s" % args.get_main_package_path() ) 468 | else: # check and exist 469 | # 存在的，不允许重新创建 470 | print('[WARN]no need main package `%s`' % args.get_main_package_path() ) 471 | 472 | def init_args(args): 473 | """ 474 | 初始化args，放入参数 475 | """ 476 | args.version_file = '%s/%s.resource_version.txt' % (args.artifact_dir, args.package_name) 477 | 478 | if not os.path.isfile(args.version_file): 479 | # 不存在则创建默认Versionfile版本号0 480 | mkdir_p(args.artifact_dir) 481 | 482 | with open(args.version_file, 'wb+') as wf: 483 | wf.write('0'.zfill(8)) 484 | print "Create Version file: %s" % args.version_file 485 | 486 | strVersion = get_current_resource_version(args.version_file) 487 | 488 | # 资源版本号在第4位 489 | args.resVersion = int(strVersion) 490 | args.newResVersion = args.resVersion + 1 491 | 492 | print("Current Resource Version: %d" % args.resVersion) 493 | print("Action: %s" % args.action) 494 | if args.ignores_ext: 495 | print('Ignores Ext: `%s`' % ','.join(args.ignores_ext)) 496 | if args.blacklist: 497 | print('Blacklist: `%s`' % ','.join(args.blacklist)) 498 | 499 | 500 | args.get_main_package_name = lambda: '%s.%d.zip' % (args.package_name, args.resVersion) 501 | args.get_main_package_path = lambda: '%s/%s' % (args.artifact_dir, args.get_main_package_name()) 502 | 503 | 504 | def main(): 505 | parser = argparse.ArgumentParser(description=u'资源包、差异包生成工具， 传入指定的文件目录、输出名字，生成zip') 506 | parser.add_argument('-paths', required=True, nargs='+', help=u'路径，目录或文件，将作为zip的根路径') 507 | parser.add_argument('-package-name', required=True, help=u'包名字前缀') 508 | # parser.add_argument('-version-file-name', default='ResourceVersion.txt', help=u'包含一个数字的txt文件名，相对artifact-dir路径,默认ResourceVersion.txt') 509 | parser.add_argument('-artifact-dir', required=True, help=u'最终成品目录？将搜索这些目录，找出过往的日志') 510 | parser.add_argument('-action', choices=['init', 'check', 'pack', 'clean', 'test'], required=True, help=u'check只确保初始包存在，init则强制重新生成初始化包(不提版), pack则生成差异包(递进版本)') 511 | parser.add_argument('-ignores-ext', nargs='*', help=u'彻底忽略的扩展名，如: .meta .gitignore') 512 | parser.add_argument('-blacklist', nargs='*', help=u'类似ignores-ext, 激活黑名单模式,路径包含这些字符串才会被忽略') 513 | 514 | args = parser.parse_args() 515 | 516 | init_args(args) 517 | 518 | if args.action == 'test': 519 | test(args) 520 | elif args.action == 'init' or args.action == 'check': 521 | do_init_or_check(args) 522 | elif args.action == 'clean': 523 | clean_old_packages(args) # 清理旧版本 524 | else: 525 | do_pack(args) 526 | 527 | if __name__ == '__main__': 528 | main() 529 | -------------------------------------------------------------------------------- /resources_packer.bat: -------------------------------------------------------------------------------- 1 | @echo off 2 | %~dp0python.exe %~dp0resources_packer %* -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mr-kelly/resources_packer/e0da80e04a4181971a58751f9bda045cacf72ea2/screenshot.png --------------------------------------------------------------------------------