├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.rst ├── ooxml_git_hooks ├── __init__.py ├── cli.py ├── post_checkout.py ├── store.py └── utils.py └── setup.py /.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 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # PyCharm settings: 95 | .idea/ 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst 2 | include README.md 3 | include LICENSE 4 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ooxml-git-hooks 2 | =============== 3 | 4 | Pre-commit and post-checkout hooks and tools making git better suited for version control 5 | of zipped Office Open XML files, e.g. Word/.docx, Excel/.xlsx, and PowerPoint/.pptx files. 6 | 7 | 8 | 9 | Basic usage: 10 | ------------ 11 | 12 | Usage of the ``ooxml-store=ooxml_git_hooks.store:cli`` entry point:: 13 | 14 | # Store files to .ooxml_store/ directory: 15 | ooxml-store store-file 16 | ooxml-store store-all 17 | 18 | # Recreate files stored in .ooxml_store/ directory: 19 | ooxml-store recreate-file 20 | ooxml-store recreate-all 21 | 22 | 23 | 24 | Installation: 25 | ------------- 26 | 27 | Installation with pip:: 28 | 29 | pip install ooxml-git-hooks 30 | 31 | 32 | 33 | Setting up Git: 34 | --------------- 35 | 36 | 37 | Alter repository config, ``.git/config``:: 38 | 39 | # Add git hooks (optional): 40 | 41 | # Better xml diffs: 42 | [diff "xml"] 43 | textconv = prettify-xml 44 | 45 | 46 | Modify worktree ``.gitattributes`` or repository ``$GIT_DIR/info/attributes`` file:: 47 | 48 | # *.pptx diff=zip 49 | *.xml diff=xml 50 | *.rels diff=xml 51 | 52 | 53 | Finally, make sure your git repository is not located inside your Dropbox 54 | (or other sync service), as that can corrupt your git repository. 55 | It is still possible to have the files you are working on inside Dropbox, 56 | you just have to keep your "working directory" and the git repository separate. 57 | See the "Separating repository and working directory" section at the bottom 58 | of this readme for more information. 59 | 60 | 61 | 62 | Development notes: 63 | ================== 64 | 65 | **Project name?** 66 | 67 | Keywords: ooxml, zip, git, gitter, hooks, storage, store, manager, stage, staging, 68 | push, pusher, booker, revision, version, versioning, library, librarian. 69 | 70 | Suggestions: 71 | 72 | * ooxml-git-hooks 73 | * ooxml-git 74 | * ooxml-git-store 75 | * ooxml-git-storage 76 | * ooxml-git-pusher 77 | * ooxml-for-git 78 | * ooxml-gitter 79 | * ooxml-store-manager 80 | * ooxml-stage-manager 81 | * ooxml-hooka 82 | * ooxml-git-stager 83 | * ooxml-accountant 84 | * ooxml-librarian 85 | * 86 | 87 | 88 | Package name? 89 | 90 | * ooxml_store? 91 | * ooxml_git_hooks? 92 | 93 | 94 | Git hook vs manual command? 95 | 96 | * Hook is convenient, especially if the repository is only used for versioning ooxml files. 97 | * However, git hooks may be surprising, so could also just use the entry points manually. 98 | 99 | 100 | Nomenclature: 101 | 102 | * ``ooxml-store``, with hyphen, is used to denote the project name and the main entry point / "executable". 103 | * ``ooxml_store``, with underscore, is used to denote the package name, 104 | and is also used for the storage directory, ``.ooxml_store``. 105 | 106 | 107 | Features: 108 | 109 | * Extract ooxml and other zip files. 110 | * Create markdown mirror files. 111 | 112 | 113 | Options: 114 | 115 | * Which files to process (match by filename pattern, e.g. ``*.docx``). 116 | * Where and how to extract the zip files. 117 | * Whether to create pandoc mirrors e.g. in Markdown format. 118 | * Whether to create md5 checksums of files. 119 | * Have a '.ooxml_store' directory where all files are extracted (seems like a good idea). 120 | 121 | Implementation: 122 | 123 | * For each ooxml file, we have a directory: 124 | * The directory should probably be placed so that it mirrors the location of the ooxml filepath. 125 | * Alternatively, we could just have a random foldername (like a hash index), git can figure out how files have moved. 126 | * In the directory we have:: 127 | 128 | zip/ 129 | md5checksums.txt - checksums of the extracted files, with the original ooxml file on top. 130 | metadata.yaml - metadata, 131 | 132 | * In the root of the ooxml_store, we should probably have an index file that keeps track of the ooxml files stored here. 133 | * Sure, we could just loop through all folders until we find folders that match a particular pattern, 134 | but that does seem inefficient. 135 | 136 | 137 | TODO: 138 | 139 | * We are currently purging the ``.ooxml_store`` directory every time we run ``ooxml-store store-all``. 140 | This is pretty fool proof: The store reflects exactly the ooxml files present in the working directory. 141 | (and selected by the file-glob filter). However, it is also obviously inefficient, especially if we have many 142 | ooxml files in the working directory and only one of them has been updated since last commit. 143 | So, consider using file-attributes to determine if files have been changed before purging. 144 | 145 | 146 | 147 | Stackoverflow questions: 148 | 149 | * https://stackoverflow.com/questions/17083502/how-to-perform-better-document-version-control-on-excel-files-and-sql-schema-fil 150 | * https://stackoverflow.com/questions/8001663/can-git-treat-zip-files-as-directories-and-files-inside-the-zip-as-blobs 151 | 152 | * 15 votes for "no solutions currently, but a git-hook based setup should work" answer. 153 | * 9 votes for Sippey/Zippey git file filter solution - converting the zip file to a single large text-like file. 154 | * 6 votes for diff-only solution using ``textconv = unzip -c -a`` diff conversion. 155 | 156 | * https://stackoverflow.com/questions/28357163/can-a-pre-commit-git-hook-zip-a-directory-and-add-it-to-the-repository 157 | * https://stackoverflow.com/questions/17888604/git-with-large-files/19494211 158 | 159 | 160 | 161 | 162 | References: 163 | =========== 164 | 165 | Git references: 166 | 167 | * https://git-scm.com/docs/githooks 168 | 169 | 170 | Blogs posts, etc: 171 | ----------------- 172 | 173 | Using Pandoc for version tracking/diffing of Word files: 174 | 175 | * http://blog.martinfenner.org/2014/08/25/using-microsoft-word-with-git/ 176 | * https://github.com/vigente/gerardus/wiki/Integrate-git-diffs-with-word-docx-files 177 | * https://ben.balter.com/2015/02/06/word-diff/ - See also github repo, /benbalter/word_diff 178 | * http://tante.cc/2010/06/23/managing-zip-based-file-formats-in-git/ 179 | * https://paulhammant.com/2015/07/30/git-storing-unzipped-office-docs/ 180 | 181 | Managing zip-archives with Git: 182 | 183 | * https://tante.cc/2010/06/23/managing-zip-based-file-formats-in-git/ - ``textconv = unzip -c -a`` when diffing .zip. 184 | 185 | 186 | Mailing list posts: 187 | 188 | * https://www.mail-archive.com/git@vger.kernel.org/msg68285.html 189 | 190 | 191 | Prior art: 192 | 193 | * https://xltools.net/excel-version-control/ 194 | * https://bitbucket.org/sippey/zippey - [Python] converts zipped files to unzipped "text-like" format (one file per zip-file). 195 | * https://github.com/benbalter/word_diff - [Ruby] automatically converting any Word document committed to a GitHub repo to Markdown. 196 | * https://github.com/ckrf/xlsx-git - [Shell] Convert .xlsx files to XML before committing them to git. 197 | 198 | 199 | Other possibly-interesting projects: 200 | 201 | * https://github.com/bup/bup - An incremental backup system for large files based on Git. 202 | * https://git-lfs.github.com/ - Git Large File Storage (LFS), for versioning of large binary files. 203 | 204 | 205 | Commit hook examples not related to zip files: 206 | 207 | * https://github.com/drwahl/puppet-git-hooks 208 | * https://github.com/pre-commit/pre-commit-hooks 209 | * https://github.com/awslabs/git-secrets 210 | 211 | 212 | 213 | Separating repository and working directory: 214 | ============================================ 215 | 216 | TL;DR: To combine Dropbox and Git, create a repository outside Dropbox, then 217 | initialize the repository with the `--separate-git-dir ` option:: 218 | 219 | cd /Users/rasmus/Dropbox/path/to/your-folder-here 220 | git clone --separate-git-dir /Users/rasmus/Documents/git-repos/your-folder-here . 221 | 222 | This will create a filesystem-agnostic Git symbolic link in your working directory, 223 | linking to the external repository. 224 | 225 | 226 | Background: 227 | ----------- 228 | 229 | If your document is located inside dropbox, it may be beneficial to place 230 | your repository outside the working directory in a location not managed by dropbox. 231 | The reason is that dropbox can sometimes mess up git's repository, which would be 232 | devastating to your repository. Adding insult to injury, the damages made by dropbox 233 | to your git repository may not be immediately visible. 234 | (Note: If you absolutely must have the repository inside Dropbox, use the git-bundle 235 | format, where the whole repository is a single file, which is less likely to be corrupted 236 | when dropbox syncs.) 237 | 238 | 239 | In Git, a working directory must have exactly one git repository specified. 240 | A git repository can have zero or one "main working tree", and zero or more "linked working trees". 241 | 242 | You can execute git commands either from a working directory (usual case), or from a repository. 243 | 244 | When inside a working tree, git must be able to locate the corresponding repository. 245 | Git looks for the git repository (config) as follows: 246 | 247 | 1. If ``$GIT_DIR`` environment variable is set, use that. 248 | 2. If ``./.git`` is a text file with content being a directory path, use that directory. 249 | 3. Else, use ``./.git`` if it exists and is a directory. 250 | 4. Try 2 and 3 for all parent directories of the current folder. 251 | 5. If everything above fails to find a config, the git command fails. 252 | 253 | When inside a repository, git determines the working tree as follows: 254 | 255 | 1. If ``--work-tree`` command line argument is given, use that. 256 | 2. If ``$GIT_WORK_TREE`` environment variable is given, use that. 257 | 3. Use the configured value of ``core.worktree``. 258 | 4. If ``core.worktree`` is not configured, commands operating on the current working directory 259 | are disabled (e.g. ``git status``). 260 | 261 | 262 | 263 | 264 | 265 | 266 | -------------------------------------------------------------------------------- /ooxml_git_hooks/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scholer/ooxml-git-hooks/c0c18570e06f8a2fa8ef019ae922a697ad3da863/ooxml_git_hooks/__init__.py -------------------------------------------------------------------------------- /ooxml_git_hooks/cli.py: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | import sys 5 | import click 6 | 7 | from .utils import prettyprint_xml 8 | 9 | 10 | @click.command() 11 | @click.argument('files', nargs=-1) 12 | @click.option('--outputfn') 13 | @click.option('--method') 14 | @click.option('--indent', default=" "*4) 15 | def prettify_xml_cli(files, outputfn=None, method=None, indent=" "*4): 16 | if not files: 17 | files = ("-",) 18 | print("Files:", files) 19 | for inputfn in files: 20 | if inputfn is None or inputfn == "-": 21 | text = sys.stdin.read() 22 | else: 23 | text = open(inputfn).read() 24 | 25 | pretty = prettyprint_xml(text, method=method, indent=indent) 26 | if outputfn is None: 27 | print(pretty) 28 | elif outputfn == '-': 29 | return pretty 30 | else: 31 | with open(outputfn, 'w') as fd: 32 | fd.write(pretty) 33 | -------------------------------------------------------------------------------- /ooxml_git_hooks/post_checkout.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scholer/ooxml-git-hooks/c0c18570e06f8a2fa8ef019ae922a697ad3da863/ooxml_git_hooks/post_checkout.py -------------------------------------------------------------------------------- /ooxml_git_hooks/store.py: -------------------------------------------------------------------------------- 1 | 2 | """ 3 | 4 | Regarding not getting .gitignored: 5 | * Make sure stores does not end with an excluded filetype, e.g. by adding a suffix: `file.docx.store`. 6 | * Use the exclude directive in the .gitignore: 7 | !*.docx/* 8 | 9 | 10 | Usage, ooxml-store=ooxml_git_hooks.store:cli entry point: 11 | 12 | # Store files to .ooxml_store/ directory: 13 | ooxml-store store-file 14 | ooxml-store store-all 15 | 16 | # Recreate files stored in .ooxml_store/ directory: 17 | ooxml-store recreate-file 18 | ooxml-store recreate-all 19 | 20 | 21 | """ 22 | 23 | # TODO: Opening .docx files with zipfile.ZipFile() sometimes fails if file is open in Word. Copy file before unzipping! 24 | 25 | import os 26 | import zipfile 27 | import shutil 28 | import yaml 29 | import pypandoc 30 | import click 31 | 32 | from ooxml_git_hooks.utils import get_filename_attrs, zip_directory, find_files, hash_file 33 | 34 | 35 | # TODO: Read these from config file: 36 | FILE_METADATA_FN = "ooxml_metadata.yaml" 37 | STORE_ROOT = '.ooxml_store' 38 | IGNORE = ('.ooxml_store/*', "**/~$*") 39 | INCLUDE = ('**/*.docx', '**/*.pptx', '**/*.xlsx') 40 | # OBS: Using just the filepath can cause directories to be .gitignored. 41 | # Add `!.ooxml_store/**` to .gitignore to make sure the ooxml_store files are included. 42 | STORE_DIRFMT = '{filepath}.store/' 43 | # STORE_DIRFMT = '{filepath}/' 44 | PANDOC_FNFMT = '{fpnoext}.md' 45 | INDEX_FN = 'index.yaml' 46 | HASH_METHOD = 'md5' 47 | DEFAULT_METADATA = { 48 | 'archive': '.zip', 49 | } 50 | 51 | 52 | @click.group() 53 | def cli(): 54 | pass 55 | 56 | 57 | @click.command(name="store-all") 58 | def store_all_cli(basedir=".", **kwargs): 59 | store_all(basedir, **kwargs) 60 | 61 | 62 | def store_all( 63 | basedir=".", 64 | include=INCLUDE, 65 | ignore=IGNORE, 66 | store_root=STORE_ROOT, 67 | store_dirfmt=STORE_DIRFMT, 68 | pandoc_fnfmt=PANDOC_FNFMT, 69 | # configfn=None, 70 | clean=True, 71 | verbose=2, 72 | ): 73 | """""" 74 | # TODO: Option to only process changed files. 75 | # For instance, 76 | # Q: How does git determine which files have changed? A: It records `lstat` information. 77 | 78 | if verbose and verbose > 1: 79 | print("\nCreating store...") 80 | 81 | if clean: 82 | if verbose and verbose > 1: 83 | print(" - Removing old store...") 84 | # os.removedirs(store_root) 85 | shutil.rmtree(store_root) 86 | os.mkdir(store_root) 87 | 88 | # print(f"finding files: rootdir={basedir!r}, glob_pats={include!r}, excludes={ignore!r}") 89 | input_files = find_files(rootdir=basedir, glob_pats=include, excludes=ignore) 90 | if verbose and verbose > 1: 91 | print(" - Adding files to store:", input_files) 92 | 93 | for filepath in input_files: 94 | if os.path.basename(filepath).startswith("~$"): 95 | print("SKIPPING FILE: %r" % (filepath,)) 96 | continue 97 | store_file(filepath, store_root=store_root, store_dirfmt=store_dirfmt) 98 | 99 | 100 | @click.command(name="store-file") 101 | @click.argument('filename', type=click.Path(exists=True)) 102 | def store_file_cli( 103 | filename, 104 | store_root=STORE_ROOT, store_dirfmt=STORE_DIRFMT, 105 | pandoc_fnfmt=None, 106 | verbose=2 107 | ): 108 | store_file(filename, store_root=store_root, store_dirfmt=store_dirfmt, pandoc_fnfmt=pandoc_fnfmt, verbose=verbose) 109 | 110 | 111 | def store_file( 112 | filename, 113 | store_root=STORE_ROOT, store_dirfmt=STORE_DIRFMT, 114 | pandoc_fnfmt="{store_dir}/{stem}.md", 115 | add_lstat=True, add_hash='md5', 116 | verbose=2 117 | ): 118 | 119 | inputfn_attrs = get_filename_attrs(filename) 120 | 121 | store_dir = os.path.join(store_root, store_dirfmt).format(store_root=store_root, **inputfn_attrs) 122 | 123 | if verbose and verbose > 0: 124 | print("Creating store %r for file %r" % (store_dir, filename)) 125 | 126 | config = DEFAULT_METADATA.copy() 127 | archive_dir = os.path.join(store_dir, config['archive']) 128 | os.makedirs(archive_dir) 129 | config['inputfn'] = filename 130 | 131 | if add_hash: 132 | if add_hash is True: 133 | add_hash = HASH_METHOD 134 | config['hash_method'] = add_hash 135 | config['hash_hexdigest'] = hash_file(filename) 136 | 137 | if add_lstat: 138 | # (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime) 139 | # Do not include atime, it is frequently updated (e.g. by search indexing). 140 | lstat = os.lstat(filename) 141 | stat_attrs = ( 142 | 'st_size', # size, in bytes 143 | 'st_ctime', 'st_ctime_ns', # time of creation (Windows) or change (Unix) 144 | 'st_mtime', 'st_mtime_ns', # time of modificaton. 145 | 'st_nlink', 'st_dev', 'st_ino', # device, inode 146 | 'st_mode', 'st_uid', 'st_gid', # filemode, user id, group id, 147 | # 'st_flags', 'st_gen', # user-defined flags, generation, 148 | ) 149 | config['lstat'] = {a: getattr(lstat, a, 0) for a in stat_attrs} # list(lstat) 150 | 151 | try: 152 | with zipfile.ZipFile(filename, 'r') as zipfd: 153 | zipfd.extractall(archive_dir) 154 | except zipfile.BadZipfile: 155 | import tempfile 156 | with tempfile.TemporaryDirectory() as tempdir: 157 | tempfn = os.path.join(tempdir, inputfn_attrs['name']) 158 | print("Copying %r -> %r" % (filename, tempfn)) 159 | shutil.copyfile(filename, tempfn) 160 | with zipfile.ZipFile(tempfn, 'r') as zipfd: 161 | zipfd.extractall(archive_dir) 162 | 163 | if pandoc_fnfmt: 164 | pandoc_supported_formats = pypandoc.get_pandoc_formats() # from, to 165 | if isinstance(pandoc_fnfmt, str): 166 | pandoc_fnfmt = [pandoc_fnfmt] 167 | for output_fnfmt in pandoc_fnfmt: 168 | pandoc_fn = output_fnfmt.format(store_root=store_root, store_dir=store_dir, **inputfn_attrs) 169 | assert '.' in pandoc_fn 170 | output_format = pandoc_fn.rsplit('.')[-1] 171 | # if output_format not in pandoc_supported_formats[0]: 172 | # print(" - Output format %r not supported by Pandoc!" % output_format) 173 | # elif inputfn_attrs['filetype'] not in pandoc_supported_formats[1]: 174 | # print(" - Input format %r not supported by Pandoc!" % inputfn_attrs['filetype']) 175 | # else: 176 | try: 177 | if verbose and verbose > 1: 178 | print(" - Making %s file: %r -> %r" % (output_format, filename, pandoc_fn)) 179 | pypandoc.convert_file(filename, output_format, outputfile=pandoc_fn) 180 | except RuntimeError as exc: 181 | print(" - Could not convert with pandoc: %s" % (exc,)) 182 | metadata_fn = os.path.join(store_dir, FILE_METADATA_FN) 183 | 184 | with open(metadata_fn, 'w') as fp: 185 | yaml.dump(config, fp, default_flow_style=False) 186 | 187 | 188 | @click.command(name="recreate-file") 189 | @click.argument('store_dir', type=click.Path(exists=True)) 190 | def recreate_file_cli(store_dir, target_fn=None, overwrite=None, verbose=2): 191 | recreate_stored_file(store_dir, target_fn=target_fn, overwrite=overwrite, verbose=verbose) 192 | 193 | 194 | def recreate_stored_file( 195 | store_dir, target_fn=None, overwrite=None, 196 | skip_if_unchanged=False, skip_test="lstat", 197 | verbose=2 198 | ): 199 | """""" 200 | 201 | if verbose: 202 | print("\nRe-creating ooxml file from store directory %r" % (store_dir,)) 203 | metadata_fn = os.path.join(store_dir, FILE_METADATA_FN) 204 | if verbose and verbose > 1: 205 | print("\n - Reading metadata:", metadata_fn) 206 | config = yaml.load(open(metadata_fn)) 207 | 208 | if target_fn is None: 209 | target_fn = config['inputfn'] 210 | 211 | if os.path.exists(target_fn): 212 | assert os.path.isfile(target_fn) 213 | if 'lstat' in config: 214 | lstat = config['lstat'] 215 | 216 | 217 | archive_dir = os.path.join(store_dir, config['archive']) 218 | 219 | if verbose and verbose > 1: 220 | print(" - Creating ooxml/zipfile %r from store archive %r..." % (target_fn, archive_dir)) 221 | zip_directory(directory=archive_dir, overwrite=overwrite, targetfn=target_fn) 222 | 223 | 224 | @click.command(name="recreate-all") 225 | @click.option('--overwrite', is_flag=True, default=None) 226 | @click.option('--use-index', is_flag=True, default=None) 227 | def recreate_all_cli(store_root=STORE_ROOT, use_index=None, overwrite=None, verbose=2): 228 | recreate_all(store_root=store_root, use_index=use_index, overwrite=overwrite, verbose=verbose) 229 | 230 | 231 | def recreate_all( 232 | store_root=STORE_ROOT, use_index=None, overwrite=None, verbose=2 233 | ): 234 | """""" 235 | # TODO: Only re-create changed files. 236 | 237 | if verbose and verbose > 0: 238 | print("\nRe-creating all files in store_root %r" % (store_root,)) 239 | index_fn = os.path.join(store_root, INDEX_FN) 240 | if use_index is None: 241 | use_index = os.path.isfile(index_fn) 242 | 243 | if use_index: 244 | if verbose and verbose > 0: 245 | print(" - Reading index: %r" % (index_fn,)) 246 | index = yaml.load(open(index_fn)) 247 | if isinstance(index, dict): 248 | # inputfn: store_dir, but we only need the store_dir 249 | store_dirs = index.values() 250 | else: 251 | # just a list of store_dirs 252 | store_dirs = index 253 | else: 254 | glob_pat = os.path.join(store_root, "**", FILE_METADATA_FN) 255 | print("Metadata glob_pat:", glob_pat) 256 | metadata_files = find_files( 257 | rootdir=store_root, glob_pats=glob_pat, unix_globbing=True) 258 | if verbose and verbose > 0: 259 | print(" - %s store metadata files located" % (len(metadata_files),)) 260 | store_dirs = [os.path.dirname(metadata_fn) for metadata_fn in metadata_files] 261 | assert all(os.path.isdir(d) for d in store_dirs) 262 | 263 | for store_dir in store_dirs: 264 | recreate_stored_file(store_dir, overwrite=overwrite) 265 | 266 | # Add click commands to the click `cli` group: 267 | cli.add_command(store_all_cli, name="store-all") 268 | cli.add_command(store_file_cli, name="store-file") 269 | cli.add_command(recreate_file_cli, name="recreate-file") 270 | # cli.add_command(recreate_stored_file) 271 | cli.add_command(recreate_all_cli, name="recreate-all") 272 | 273 | 274 | -------------------------------------------------------------------------------- /ooxml_git_hooks/utils.py: -------------------------------------------------------------------------------- 1 | 2 | 3 | import sys 4 | import os 5 | import re 6 | import pathlib 7 | import fnmatch 8 | import glob 9 | import zipfile 10 | import hashlib 11 | 12 | 13 | IGNORE = [ 14 | '.unzipped/' 15 | ] 16 | 17 | 18 | DIRECTORIES = [ 19 | # ooxml pattern: {configuraton} - or just a list of {configuration}s ? 20 | # Maybe say if we have ooxml is a key pattern, e.g. '.docx' then convert to '**/*.docx' glob-style pattern? 21 | 22 | ] 23 | 24 | # formatting variables (example: ./path/to/file.docx 25 | # * filepath ./path/to/file.docx 26 | # * filename file.docx 27 | # * fnbase file # or `stem`, which is what the pathlib module uses? 28 | # * fpnoext ./path/to/file 29 | # * fnext .docx # or `suffix`, which is what the pathlib module uses? 30 | # * filetype docx 31 | # * dirpath ./path/to 32 | 33 | 34 | DEFAULT_CONVERSION = { 35 | 'include': ('**/*.docx', '**/*.pptx', '**/*.xlsx'), 36 | 'ignore': '.ooxml_store/*', 37 | 'pandoc_fnfmt': '{fpnoext}.md', 38 | 'untip_dirfmt': '.ooxml_store/{filepath}/', 39 | # Create regex from 'unzip_dir' pattern. Or just have the original filename in a metadata file. 40 | 'rezip_regex': None, 41 | } 42 | 43 | 44 | def find_files(rootdir, glob_pats, excludes=None, unix_globbing=True, exclude_match_dirs=True): 45 | # OBS: Unlike Unix glob, Python's glob/fnmatch modules does NOT treat '/' as a special character. 46 | # That is, '*' will match '/' characters. 47 | # Unix: ``fnmatch('path/to/file.txt', '*.txt') -> False`` 48 | # Unix: ``fnmatch('path/to/file.txt', '**/*.txt') -> True`` 49 | # Python: ``fnmatch('path/to/file.txt', '*.txt') -> True`` 50 | # Python's fnmatch just translates the glob pattern to regex, compiles, and returns the match function. 51 | # '*' in the glob pattern is converted to '.*'. You could just change that to '[^//]*'. 52 | # So, roll your own fnmatch->regex translator if you need posix-like matching: 53 | # Edit: Starting with Python 3.5, glob now supports unix-like recursive globbing with '**'. 54 | # For earlier versions of Python, use e.g. glob2 or formic packages. 55 | if isinstance(glob_pats, str): 56 | glob_pats = [glob_pats] 57 | if isinstance(excludes, str): 58 | excludes = [excludes] 59 | 60 | result = [] 61 | result_set = set() 62 | 63 | def not_excluded(fp): 64 | if excludes: 65 | return not any(fnmatch.fnmatch(fp, pat) for pat in excludes) 66 | else: 67 | return True 68 | 69 | def not_in_result_set(fp): 70 | return fp not in result_set 71 | 72 | if unix_globbing: 73 | # '*.png' will only match 'file.png' but not 'path/to/file.png' 74 | # Use '**/*.png' to match png files in all sub-directories. 75 | # Use '*/*/*.png' to match png files exactly two levels deep. 76 | # This is Git's default globbing style. 77 | for pattern in glob_pats: 78 | matches = glob.glob(pattern, recursive=True) 79 | files = filter(os.path.isfile, matches) 80 | files = filter(not_excluded, files) 81 | files = filter(not_in_result_set, files) 82 | files = list(files) 83 | result.extend(files) 84 | result_set.update(set(files)) 85 | else: 86 | # '*.png' will match 'file.png' and '/path/to/file.png' 87 | for root, dirs, files in os.walk(rootdir): 88 | for fn in files: 89 | fpath = os.path.join(root, fn) 90 | if excludes and any(fnmatch.fnmatch(fpath, pat) for pat in excludes): 91 | continue 92 | if any(fnmatch.fnmatch(fpath, pat) for pat in glob_pats): 93 | result.append(fpath) 94 | # Excluded dirs: 95 | # We must update `dirs` in-place, which is a bit awkward: 96 | if exclude_match_dirs and excludes: 97 | exclude_dirs = [ 98 | dirname for dirname in dirs 99 | if any(fnmatch.fnmatch(fpath, pat) for pat in excludes) 100 | ] 101 | # Removing in reversed order should perform slightly better: 102 | for dirname in reversed(exclude_dirs): 103 | dirs.remove(dirname) 104 | 105 | return result 106 | 107 | 108 | def regex_from_pathfmt(pathfmt, fnchars="[^//]", do_test=True): 109 | """Convert a path-format str to regex pattern.""" 110 | fmtpat = r"\{\w+\}" 111 | matches = re.findall(fmtpat, pathfmt) 112 | path_regex = pathfmt 113 | for varname in matches: 114 | regex = r"(?P<%s>%s+)" % (varname, fnchars) 115 | # replace "{varname}" with "(?P[^//]+)" 116 | path_regex = re.sub("{%s}" % (varname,), regex, path_regex) 117 | if do_test: 118 | test_path_regex(path_regex=path_regex, pathfmt=pathfmt) 119 | return path_regex 120 | 121 | 122 | def test_path_regex(path_regex, pathfmt, testset=None): 123 | """Assert that path_regex properly captures the variables of pathfmt.""" 124 | if testset is None: 125 | testset = [ 126 | dict(inputfn='path/to/file.docx', glob_pat='**/*.docx'), 127 | ] 128 | for params in testset: 129 | inputfn, glob_pat = params['inputfn'], params['glob_pat'] 130 | pathobj = pathlib.Path(inputfn) 131 | assert pathobj.match(glob_pat) 132 | filename_attrs = get_filename_attrs(inputfn) 133 | outputdir = pathfmt.format(**filename_attrs) 134 | match = re.match(path_regex, outputdir) 135 | # Make sure we can re-create filepath from match groups! 136 | 137 | 138 | def recreate_filepath(matchdict): 139 | if 'filepath' in matchdict: 140 | return matchdict['filepath'] 141 | if 'dirpath' in matchdict: 142 | dirpath = matchdict['dirpath'] 143 | if 'filename' in matchdict: 144 | return os.path.join(dirpath, matchdict['filename']) 145 | elif 'stem' in matchdict: 146 | if 'suffix' in matchdict: 147 | return os.path.join(dirpath, matchdict['stem']+matchdict['suffix']) 148 | elif 'filetype' in matchdict: 149 | return os.path.join(dirpath, matchdict['stem']+'.'+matchdict['filetype']) 150 | raise ValueError("Could not recreate filepath from matchdict %s" % (matchdict,)) 151 | 152 | 153 | def get_filename_attrs(filepath): 154 | # See https://www.python.org/dev/peps/pep-0428/ 155 | # For a discussion of "suffix" vs "ext" and "base" vs "stem", see: 156 | # * https://groups.google.com/forum/#!topic/python-ideas/f4fZfY1HLJs%5B1-25%5D 157 | # * https://groups.google.com/d/msg/python-ideas/f4fZfY1HLJs/2FSCObPdTKEJ 158 | # 159 | 160 | p = pathlib.Path(filepath) 161 | return dict( 162 | filepath=filepath, path=filepath, 163 | dirpath=p.parent, parent=p.parent, 164 | filename=p.name, name=p.name, 165 | stem=p.stem, 166 | suffix=p.suffix, 167 | filetype=p.suffix.strip('.') if p.suffix else None, 168 | ) 169 | 170 | 171 | def as_posix_path_str(path): 172 | """Ensure that a filepath str that has forward slashes regardless of platform.""" 173 | return pathlib.PurePath(path).as_posix() 174 | 175 | pp = as_posix_path_str # alias 176 | 177 | 178 | # From pptx-downsizer package: 179 | def zip_directory( 180 | directory, targetfn=None, relative=True, 181 | overwrite=None, 182 | compress_type=zipfile.ZIP_DEFLATED, verbose=1 183 | ): 184 | """Zip all files and folders in a directory. 185 | 186 | Args: 187 | directory: The directory whose contents should be zipped. 188 | targetfn: Output filename of the zipped archive. 189 | relative: If True, make the arcname relative to the input directory. 190 | compress_type: Which kind of compression to use. See zipfile package. 191 | verbose: How much information to print to stdout while creating the archive. 192 | 193 | Returns: 194 | The filename of the zipped archive. 195 | 196 | """ 197 | assert os.path.isdir(directory) 198 | if targetfn is None: 199 | targetfn = directory + ".zip" 200 | filecount = 0 201 | if verbose and verbose > 0: 202 | print("Creating archive %r from directory %r:" % (targetfn, directory)) 203 | 204 | if os.path.exists(targetfn): 205 | if overwrite is None: 206 | print(""" 207 | NOTICE: Output file %r already exists. 208 | If you want to keep the old file, please move/rename it before continuing.""" % (targetfn,)) 209 | input("Press enter to continue... ") 210 | elif overwrite is False: 211 | raise FileExistsError("Target file %r already exists and overwrite set to %r" % (targetfn, overwrite)) 212 | 213 | with zipfile.ZipFile(targetfn, mode="w") as zipfd: 214 | for dirpath, dirnames, filenames in os.walk(directory): 215 | for fname in filenames: 216 | fpath = os.path.join(dirpath, fname) 217 | arcname = os.path.relpath(fpath, start=directory) if relative else fpath 218 | if verbose and verbose > 0: 219 | print(" - adding %r" % (arcname,)) 220 | zipfd.write(fpath, arcname=arcname, compress_type=compress_type) 221 | filecount += 1 222 | if verbose and verbose > 0: 223 | print("\n%s files written to archive %r" % (filecount, targetfn)) 224 | return targetfn 225 | 226 | 227 | def hash_file(filepath, method='md5', filemode='rb', single_read=None, blocksize=64*1024, digest='hexdigest'): 228 | """ 229 | 230 | Args: 231 | filepath: 232 | method: 233 | filemode: 234 | single_read: 235 | blocksize: 236 | digest: 237 | 238 | Returns: 239 | 240 | Refs: 241 | * https://stackoverflow.com/questions/1131220/get-md5-hash-of-big-files-in-python 242 | * https://stackoverflow.com/questions/22058048/hashing-a-file-in-python 243 | * http://pythoncentral.io/hashing-files-with-python/ 244 | """ 245 | if isinstance(method, str): 246 | method = getattr(hashlib, method) 247 | hasher = method() 248 | if single_read is None: 249 | # If file is small, just read the whole file in a single read: 250 | single_read = os.path.getsize(filepath) < 2**20 251 | with open(filepath, mode=filemode) as fd: 252 | if single_read: 253 | hasher.update(fd.read()) 254 | else: 255 | for b in iter(lambda: fd.read(blocksize), b''): 256 | hasher.update(b) 257 | if not digest: 258 | return hasher 259 | elif isinstance(digest, str): 260 | return getattr(hasher, digest)() # e.g. hasher.hexdigest() 261 | else: 262 | return digest(hasher) 263 | 264 | 265 | def prettyprint_xml(text, method='stdlib-xml', indent=" "*4): 266 | """ 267 | 268 | Args: 269 | text: 270 | method: 271 | 272 | Returns: 273 | pretty, indented xml str 274 | 275 | Alternatives: 276 | 277 | * xmllint command line tool (from libxml2-utils) 278 | * xml_pp - from XML::Twig perl module. 279 | * xmlstarlet - 280 | * tidy - 281 | * saxon-lint 282 | * 283 | * xmlpp - http://xmlpp.codeplex.com/ 284 | * pyxml 285 | * xmlformatter - command line tool - https://github.com/pamoller/xmlformatter 286 | * XMLLayout (2011) 287 | 288 | 289 | 290 | Refs: 291 | * https://stackoverflow.com/questions/749796/pretty-printing-xml-in-python 292 | * https://stackoverflow.com/questions/16090869/how-to-pretty-print-xml-from-the-command-line 293 | * https://stackoverflow.com/questions/3844360/best-way-to-generate-xml 294 | 295 | """ 296 | 297 | if method is None: 298 | method = 'stdlib-xml' 299 | if indent is None: 300 | indent = " "*4 301 | 302 | if method == 'lxml': 303 | # https://stackoverflow.com/a/3844432/3241277 304 | import lxml 305 | pretty = lxml.etree.tostring(lxml.etree.fromstring(text), pretty_print=True) 306 | elif method == 'vkbeautify': 307 | # https://stackoverflow.com/a/41455013/3241277 308 | import vkbeautify 309 | pretty = vkbeautify.xml(text) 310 | elif method in ('beautifulsoup', 'bs'): 311 | # https://stackoverflow.com/a/39482716/3241277 312 | import bs4 313 | bs = bs4.BeautifulSoup(text, 'xml') 314 | pretty = bs.prettify() 315 | elif method == 'yattag': 316 | # https://stackoverflow.com/a/23634596/3241277 317 | import yattag 318 | pretty = yattag.indent(text) 319 | else: # if method == 'stdlib-xml': 320 | # https://stackoverflow.com/a/749839/3241277 321 | import xml.dom.minidom 322 | print("Converting text", type(text)) 323 | print("indent: %r" % indent) 324 | tree = xml.dom.minidom.parseString(text) 325 | pretty = tree.toprettyxml(indent=indent) 326 | 327 | return pretty 328 | 329 | 330 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | try: 2 | # Uset setuptools if available to prevent "UserWarning: Unknown distribution option: 'entry_points'" 3 | from setuptools import setup 4 | except ImportError: 5 | from distutils.core import setup 6 | 7 | """ 8 | 9 | ooxml-git-hooks: 10 | ================ 11 | 12 | Python environments:: 13 | 14 | ``ooxml-git-dev``: 15 | Has main git repo installed in "editable" mode with ``pip install -e .`` 16 | ``conda create -n ooxml-git-dev python pip pillow pyyaml docutils pandoc`` 17 | 18 | ``ooxml-git-build-test``: 19 | For installing and testing the ``dist/ooxml-git-hooks-.tar.gz`` builds. 20 | ``source activate ooxml-git-build-test`` 21 | 22 | ``ooxml-git-pypi-test``: 23 | For testing the package uploaded to PyPI. 24 | 25 | 26 | Release protocol: 27 | 28 | 0. Open a new terminal tab for each of the three environments above. 29 | 30 | 1. Make sure all tests passes in the dev environment ``ooxml-git-hooks-dev``. 31 | Verify that all entry points are functional and able to successfully complete. 32 | Preferably verify that it works both when invoked from console and from Automator scripts (particularly: stdout). 33 | Check that README.rst is correctly formatted:: 34 | 35 | ``python setup.py check --restructuredtext`` (``docutils`` must be installed) 36 | 37 | 2. Bump version number: 38 | ``version``+``download_url`` in ``setup.py`` 39 | and ``version`` in ``ooxml_git/__init__.py``), 40 | then ``git commit`` (or maybe do that after uploading release). 41 | 42 | 3. Build release: 43 | (a) Change to dedicated build/dist environment, e.g. ``ooxml-git-hooks-build-test``. 44 | (b) Clear the old version: ``pip uninstall ooxml-git-hooks`` (or do a complete wipe). 45 | (c) Go to project root directory in terminal and build release with ``python setup.py sdist``, 46 | (d) Install build in sdist environment using ``pip install dist/ooxml-git-hooks-.tar.gz``, 47 | (e) Run tests and verify that all entry points are working. 48 | 49 | 4. Register upload release and source distribution to PyPI TEST site: 50 | ``python setup.py sdist upload -r pypitest_legacy``, 51 | then check https://testpypi.python.org/pypi/ooxml-git-hooks/ and make sure it looks right. 52 | Note: Previously, this was a two-step process, requiring pre-registration with 53 | ``python setup.py register -r pypi(test)``. This is no longer needed. 54 | 55 | 5. Register and upload release to production PyPI site and check https://pypi.python.org/pypi/ooxml-git-hooks/ 56 | ``python setup.py sdist upload -r pypi``. 57 | 58 | 6. Test the PYPI release using the ``ooxml-git-hooks-pypi-test`` environment, 59 | preferably also on a different platforms as well (Windows/Mac/Linux). 60 | Use ``pip install -U ooxml-git-hooks`` to update, or do a complete 61 | wipe+reinstall of the ``ooxml-git-hooks-pypi-test`` environment. 62 | 63 | 7. Commit, tag, and push: 64 | Add all updated files to git (``git status``, then ``git add -u``), 65 | and commit (``git commit -m "message"``). 66 | Tag and annotate this version in git with ``git tag -a -m "message"``, 67 | then push it with ``git push --follow-tags`` 68 | (or ``git push --tags`` if you have already pushed the branch/commits). 69 | Check that everything looks good on the GitHub page, https://github.com/scholer/ooxml-git-hooks 70 | You can also create tags/releases using GitHub's interface, c.f. 71 | https://help.github.com/articles/creating-releases/. 72 | 73 | 8. Update ``version`` again, adding "-dev" postfix. 74 | 75 | If you find an error at any point, go back to step 1. 76 | 77 | 78 | 79 | Regarding PyPI and packaging/distribution: 80 | * You can use a .pypirc to configure server/username/password (can be configured globally in ~/.pypirc). 81 | * https://wiki.python.org/moin/TestPyPI 82 | * https://wiki.python.org/moin/CheeseShopTutorial 83 | * https://packaging.python.org/tutorials/distributing-packages/ 84 | * https://mail.python.org/pipermail/distutils-sig/2017-June/030766.html 85 | * http://inre.dundeemt.com/2014-05-04/pypi-vs-readme-rst-a-tale-of-frustration-and-unnecessary-binding/ (OLD) 86 | * http://python-packaging.readthedocs.io/en/latest/metadata.html 87 | * https://docs.python.org/devguide/documenting.html 88 | 89 | Regarding reStructuredText and Markdown: 90 | * http://docutils.sourceforge.net/rst.html 91 | * Markdown to rST using Pandoc: ``pandoc --from=markdown --to=rst --output=README.rst README.md`` 92 | * Fix line wrap using pandoc: ``pandoc README.rst -o README.rst`` [may also change a lot of other stuff!] 93 | * Using docutils: ``python setup.py check --restructuredtext`` 94 | * Linting using restructuredtext_lint: ``rst-lint README.rst`` 95 | * https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet 96 | * https://en.support.wordpress.com/markdown-quick-reference/ 97 | * http://www.sphinx-doc.org/en/stable/rest.html 98 | * http://docutils.sourceforge.net/docs/user/rst/quickstart.html 99 | * http://docutils.sourceforge.net/rst.html 100 | * https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html 101 | 102 | 103 | """ 104 | 105 | # try: 106 | # import pypandoc 107 | # long_description = pypandoc.convert_file('README.md', 'rst') 108 | # long_description = long_description.replace("\r", "") 109 | # except (ImportError, OSError): 110 | # print("NOTE: pypandoc not available, reading README.md as-is.") 111 | # Edit, switched to using reStructuredText for README file: 112 | try: 113 | long_description = open('README.rst').read() 114 | except FileNotFoundError: 115 | import pypandoc 116 | long_description = pypandoc.convert_file('README.md', to='rst') 117 | 118 | 119 | # update 'version' and 'download_url', as well as pptx_downsizer.__init__.__version__ 120 | setup( 121 | name='ooxml-git-hooks', 122 | description='Tools for uncompressing Microsoft Office (Office Open XML) files for better git version control.', 123 | long_description=long_description, 124 | url='https://github.com/scholer/ooxml-git-hooks', 125 | packages=['ooxml_git_hooks'], # List all packages (directories) to include in the source dist. 126 | version='0.1.1-dev', # Update for each new version 127 | # download_url='https://github.com/scholer/ooxml-git-hooks/tarball/0.1.2', # Update for each new version 128 | download_url='https://github.com/scholer/ooxml-git-hooks/archive/master.zip', 129 | author='Rasmus Scholer Sorensen', 130 | author_email='rasmusscholer@gmail.com', 131 | license='GNU General Public License v3 (GPLv3)', 132 | keywords=[ 133 | "ooxml", 134 | "Office Open", 135 | "git", 136 | "pptx", 137 | "docx", 138 | "xlsx", 139 | "Word", 140 | "Excel", 141 | "PowerPoint", 142 | "compression", 143 | "versioning", 144 | "version control", 145 | ], 146 | # Automatic script creation using entry points has largely super-seeded the "scripts" keyword. 147 | # you specify: name-of-executable-script: module[.submodule]:function 148 | # When the package is installed with pip, a script is automatically created (.exe for Windows). 149 | # Note: The entry points are stored in ./.egg-info/entry_points.txt, which is used by pkg_resources. 150 | entry_points={ 151 | 'console_scripts': [ 152 | # These should all be lower-case, else you may get an error when uninstalling: 153 | 'ooxml-store=ooxml_git_hooks.store:cli', 154 | 'prettify-xml=ooxml_git_hooks.cli:prettify_xml_cli', 155 | 156 | ], 157 | }, 158 | # install_requires: Minimal requirement for this project. 159 | # (Whereas `requirements.txt` is typically used to produce a comprehensive python environment.) 160 | install_requires=[ 161 | 'pyyaml', 162 | 'click', 163 | ], 164 | classifiers=[ 165 | # https://pypi.python.org/pypi?%3Aaction=list_classifiers 166 | # How mature is this project? Common values are 167 | # 3 - Alpha 168 | # 4 - Beta 169 | # 5 - Production/Stable 170 | 'Development Status :: 4 - Beta', 171 | 172 | # Indicate who your project is intended for 173 | # 'Intended Audience :: Developers', 174 | 'Intended Audience :: Education', 175 | 'Intended Audience :: End Users/Desktop', 176 | 177 | # 'Topic :: Software Development :: Build Tools', 178 | 'Topic :: Education', 179 | 'Topic :: Office/Business', 180 | 'Topic :: Office/Business :: Office Suites', 181 | 182 | # Pick your license as you wish (should match "license" above) 183 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 184 | 185 | # Specify the Python versions you support here. In particular, ensure 186 | # that you indicate whether you support Python 2, Python 3 or both. 187 | 'Programming Language :: Python', 188 | 'Programming Language :: Python :: 3', 189 | 'Programming Language :: Python :: 3.6', 190 | 191 | 'Environment :: Console', 192 | 193 | 'Operating System :: MacOS', 194 | 'Operating System :: Microsoft', 195 | 'Operating System :: POSIX :: Linux', 196 | ], 197 | 198 | ) 199 | --------------------------------------------------------------------------------