commit f41df77425a9db7526c2616e2cf29b196473f0b6 Author: Johannes 'josch' Schauer Date: Mon Jul 1 01:39:09 2019 +0200 initial commit diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..6d66006 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,16 @@ +language: python +matrix: + include: + - name: "python 3.7 Xenial" + dist: xenial + python: 3.7 + - name: "python 3.7 Windows" + os: windows + language: shell # 'language: python' is an error on Travis CI Windows + before_install: choco install python + env: PATH=/c/Python37:/c/Python37/Scripts:$PATH + - name: "python 3.7 MacOs" + os: osx + language: shell # 'language: python' is an error on Travis CI macOS +install: pip install wheel PyMuPDF pytest +script: pytest test.py diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..ec1af37 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,4 @@ +0.1 (2019-06-29) +---------------- + +- Initial PyPI release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2968e89 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +TODO: use pdfrw, pypdf2 + +plakativ +======== + +Plakativ is German for "striking" or "eye-catching" and comes from the German +word "Plakat" which means poster in English. + +This software allows one to stretch a PDF document across multiple pages that +can then be printed on a common inkjet printer and be glued together into a +larger poster. + +Features +======== + +Plakativ allows one to make posters with three different goals in mind: + + - I want a poster of size X + - I want a poster X times the input page size + - I have X pages of paper and want to print the biggest possible poster on them + +In contrast to other solutions, plakativ tries hard to find a page +configuration that wastes as little paper as possible, offering three different +layouter algorithms. + +Comparison to PosteRazor +------------------------ + +http://posterazor.sourceforge.net/ + +PosteRazor served as the inspiration for this software. But in contrast to +PosteRazor, plakativ allows PDF documents as input and outputs PDF document +with the exact same quality as the input. It is thus not necessary anymore +to first do a lossy rasterization of an input PDF so that one can work with +PosteRazor. + +Comparison to pdfposter +----------------------- + +https://pdfposter.readthedocs.io/en/stable/ + + - no GUI + - cumbersome box definition + - no page borders for glueing + - superfluous empty pages + - only very simple layouter diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..5b00a41 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,31 @@ +environment: + # For Python versions available on Appveyor, see + # https://www.appveyor.com/docs/windows-images-software/#python + matrix: + - PYTHON: "C:\\Python27" + - PYTHON: "C:\\Python33" + - PYTHON: "C:\\Python34" + - PYTHON: "C:\\Python35" + - PYTHON: "C:\\Python36" + - PYTHON: "C:\\Python37" + - PYTHON: "C:\\Python27-x64" + - PYTHON: "C:\\Python33-x64" + - PYTHON: "C:\\Python34-x64" + - PYTHON: "C:\\Python35-x64" + - PYTHON: "C:\\Python36-x64" + - PYTHON: "C:\\Python37-x64" + +install: + - "%PYTHON%\\python.exe -m pip install wheel PyMuPDF pyinstaller" + +build: off + +test_script: + - "%PYTHON%\\python.exe setup.py test" + +after_test: + - "%PYTHON%\\python.exe setup.py bdist_wheel" + - "%PYTHON%\\python.exe -m PyInstaller --clean --onefile --noconsole plakativ.py" + +artifacts: + - path: dist\* diff --git a/plakativ.py b/plakativ.py new file mode 100644 index 0000000..810cb91 --- /dev/null +++ b/plakativ.py @@ -0,0 +1,1066 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +from collections import OrderedDict +import math +import fitz +import tkinter +import tkinter.filedialog +import sys +import argparse +import os.path +import platform + +VERSION = "0.1" + +PAGE_SIZES = OrderedDict( + [ + ("custom", (None, None)), + ("A0 (84.1 cm × 118.9 cm)", (841, 1189)), + ("A1 (59.4 cm × 84.1 cm)", (594, 841)), + ("A2 (42.0 cm × 59.4 cm)", (420, 594)), + ("A3 (29.7 cm × 42.0 cm)", (297, 420)), + ("A4 (21.0 cm × 29.7 cm)", (210, 297)), + ("A5 (14.8 cm × 21.0 cm)", (148, 210)), + ("Letter (8.5 in × 11 in)", (215.9, 279.4)), + ("Legal (8.5 in × 14 in)", (215.9, 355.6)), + ("Tabloid (11 in × 17 in)", (279.4, 431.8)), + ] +) + + +def mm_to_pt(length): + return (72.0 * length) / 25.4 + + +def pt_to_mm(length): + return (25.4 * length) / 72.0 + + +class Plakativ: + def __init__(self, infile=None): + self.doc = None + if infile is not None: + self.open(infile) + + def open(self, infile): + self.doc = fitz.open(infile) + # only allow pdf documents with exactly a single page + assert len(self.doc) == 1 + self.dlist = self.doc[0].getDisplayList() + + self.pagesize = PAGE_SIZES["A4 (21.0 cm × 29.7 cm)"] + self.border_left = 20 + self.border_right = 20 + self.border_top = 20 + self.border_bottom = 20 + self.config = { + "pagesize": ( + pt_to_mm(self.dlist.rect.width), + pt_to_mm(self.dlist.rect.height), + ), + "postersize": PAGE_SIZES["A1 (59.4 cm × 84.1 cm)"], + } + self.layout = {"pagesize": PAGE_SIZES["A4 (21.0 cm × 29.7 cm)"]} + + def compute_layout(self, mode, size=None, mult=None, npages=None): + if self.doc is None: + return + + self.config["mode"] = mode + self.config["postersize"] = None + self.config["mult"] = None + self.config["npages"] = None + if mode == "size": + self.config["postersize"] = size + elif mode == "mult": + self.config["mult"] = mult + elif mode == "npages": + self.config["npages"] = npages + else: + raise Exception("unsupported mode: %s" % mode) + + printable_width = self.layout["pagesize"][0] - ( + self.border_left + self.border_right + ) + printable_height = self.layout["pagesize"][1] - ( + self.border_top + self.border_bottom + ) + + if mode in ["size", "mult"]: + if mode == "size": + # fit the input page size into the selected postersize + poster_width = self.config["postersize"][0] + poster_height = ( + poster_width * self.config["pagesize"][1] + ) / self.config["pagesize"][0] + if poster_height > self.config["postersize"][1]: + poster_height = self.config["postersize"][1] + poster_width = ( + poster_height * self.config["pagesize"][0] + ) / self.config["pagesize"][1] + elif mode == "mult": + area = self.config["pagesize"][0] * self.config["pagesize"][1] * mult + poster_width = math.sqrt( + area * self.config["pagesize"][0] / self.config["pagesize"][1] + ) + poster_height = math.sqrt( + area * self.config["pagesize"][1] / self.config["pagesize"][0] + ) + else: + raise Exception("unsupported mode: %s" % mode) + + self.layout["postersize"] = poster_width, poster_height + + pages_x_portrait = math.ceil(poster_width / printable_width) + pages_y_portrait = math.ceil(poster_height / printable_height) + + pages_x_landscape = math.ceil(poster_width / printable_height) + pages_y_landscape = math.ceil(poster_height / printable_width) + + portrait = True + if ( + pages_x_portrait * pages_y_portrait + > pages_x_landscape * pages_y_landscape + ): + portrait = False + + if portrait: + pages_x = pages_x_portrait + pages_y = pages_y_portrait + self.layout["overallsize"] = ( + pages_x * printable_width + (self.border_right + self.border_left), + pages_y * printable_height + (self.border_top + self.border_bottom), + ) + else: + pages_x = pages_x_landscape + pages_y = pages_y_landscape + self.layout["overallsize"] = ( + pages_x * printable_height + (self.border_top + self.border_bottom), + pages_y * printable_width + (self.border_right + self.border_left), + ) + elif mode == "npages": + # stupid bruteforce algorithm to determine the largest printable + # postersize with N pages + best_area = 0 + best = None + for x in range(1, self.config["npages"] + 1): + for y in range(1, self.config["npages"] + 1): + if x * y > self.config["npages"]: + continue + width_portrait = x * printable_width + height_portrait = y * printable_height + + poster_width = width_portrait + poster_height = ( + poster_width * self.config["pagesize"][1] + ) / self.config["pagesize"][0] + if poster_height > height_portrait: + poster_height = height_portrait + poster_width = ( + poster_height * self.config["pagesize"][0] + ) / self.config["pagesize"][1] + + area_portrait = poster_width * poster_height + + if area_portrait > best_area: + best_area = area_portrait + best = (x, y, True, poster_width, poster_height) + + width_landscape = x * printable_height + height_landscape = y * printable_width + + poster_width = width_landscape + poster_height = ( + poster_width * self.config["pagesize"][1] + ) / self.config["pagesize"][0] + if poster_height > height_landscape: + poster_height = height_landscape + poster_width = ( + poster_height * self.config["pagesize"][0] + ) / self.config["pagesize"][1] + + area_landscape = poster_width * poster_height + + if area_landscape > best_area: + best_area = area_landscape + best = (x, y, False, poster_width, poster_height) + + pages_x, pages_y, portrait, poster_width, poster_height = best + self.layout["postersize"] = poster_width, poster_height + if portrait: + self.layout["overallsize"] = ( + pages_x * printable_width + (self.border_right + self.border_left), + pages_y * printable_height + (self.border_top + self.border_bottom), + ) + else: + self.layout["overallsize"] = ( + pages_x * printable_height + (self.border_top + self.border_bottom), + pages_y * printable_width + (self.border_right + self.border_left), + ) + else: + raise Exception("unsupported mode: %s" % mode) + + self.layout["positions"] = [] + for y in range(pages_y): + for x in range(pages_x): + if portrait: + posx = x * printable_width + posy = y * printable_height + else: + posx = x * printable_height + posy = y * printable_width + self.layout["positions"].append((posx, posy, portrait)) + + # return (self.postersize, (poster_width*poster_height)/(pt_to_mm(self.dlist.rect.width)*pt_to_mm(self.dlist.rect.height)), pages_x*pages_y) + if mode == "size": + self.config["mult"] = (poster_width * poster_height) / ( + self.config["pagesize"][0] * self.config["pagesize"][1] + ) + self.config["npages"] = pages_x * pages_y + elif mode == "mult": + self.config["postersize"] = poster_width, poster_height + self.config["npages"] = pages_x * pages_y + elif mode == "npages": + self.config["postersize"] = poster_width, poster_height + self.config["mult"] = (poster_width * poster_height) / ( + self.config["pagesize"][0] * self.config["pagesize"][1] + ) + else: + raise Exception("unsupported mode: %s" % mode) + + return self.config["postersize"], self.config["mult"], self.config["npages"] + + def render(self, outfile): + outdoc = fitz.open() + + xref = 0 + r = self.dlist.rect + + for (x, y, portrait) in self.layout["positions"]: + if portrait: + page_width=mm_to_pt(self.layout["pagesize"][0]) + page_height=mm_to_pt(self.layout["pagesize"][1]) + else: + page_width=mm_to_pt(self.layout["pagesize"][1]) + page_height=mm_to_pt(self.layout["pagesize"][0]) + page = outdoc.newPage( + -1, # insert after last page + width=page_width, + height=page_height, + ) + + target_x = ( + x - self.layout["overallsize"][0] / 2 + self.layout["postersize"][0] / 2 + ) + target_y = ( + y - self.layout["overallsize"][1] / 2 + self.layout["postersize"][1] / 2 + ) + target_xoffset = 0 + target_yoffset = 0 + if portrait: + target_width = self.layout["pagesize"][0] + target_height = self.layout["pagesize"][1] + else: + target_width = self.layout["pagesize"][1] + target_height = self.layout["pagesize"][0] + if target_x < 0: + target_xoffset = -target_x + target_width += target_x + target_x = 0 + if target_y < 0: + target_yoffset = -target_y + target_height += target_y + target_y = 0 + if target_x + target_width > self.layout["postersize"][0]: + target_width = self.layout["postersize"][0] - target_x + if target_y + target_height > self.layout["postersize"][1]: + target_height = self.layout["postersize"][1] - target_y + + targetrect = fitz.Rect( + mm_to_pt(target_xoffset), + mm_to_pt(target_yoffset), + mm_to_pt(target_xoffset + target_width), + mm_to_pt(target_yoffset + target_height), + ) + + # FIXME: this should probably the pagesize of the input document instead + factor = self.layout["pagesize"][0] / self.layout["postersize"][0] + sourcerect = fitz.Rect( + mm_to_pt(factor * target_x), + mm_to_pt(factor * target_y), + mm_to_pt(factor * (target_x + target_width)), + mm_to_pt(factor * (target_y + target_height)), + ) + + # update xref + xref = page.showPDFpage( + targetrect, # fill the whole page + self.doc, # input document + 0, # input page number + clip=sourcerect, # part of the input page to use + #rotate=0 if portrait else 90, + ) + + outdoc.save(outfile, garbage=4, deflate=True) + + +# from Python 3.7 Lib/idlelib/configdialog.py +# Copyright 2015-2017 Terry Jan Reedy +# Python License +class VerticalScrolledFrame(tkinter.Frame): + """A pure Tkinter vertically scrollable frame. + + * Use the 'interior' attribute to place widgets inside the scrollable frame + * Construct and pack/place/grid normally + * This frame only allows vertical scrolling + """ + + def __init__(self, parent, *args, **kw): + tkinter.Frame.__init__(self, parent, *args, **kw) + + # Create a canvas object and a vertical scrollbar for scrolling it. + vscrollbar = tkinter.Scrollbar(self, orient=tkinter.VERTICAL) + vscrollbar.pack(fill=tkinter.Y, side=tkinter.RIGHT, expand=tkinter.FALSE) + canvas = tkinter.Canvas( + self, + borderwidth=0, + highlightthickness=0, + yscrollcommand=vscrollbar.set, + width=240, + ) + canvas.pack(side=tkinter.LEFT, fill=tkinter.BOTH, expand=tkinter.TRUE) + vscrollbar.config(command=canvas.yview) + + # Reset the view. + canvas.xview_moveto(0) + canvas.yview_moveto(0) + + # Create a frame inside the canvas which will be scrolled with it. + self.interior = interior = tkinter.Frame(canvas) + interior_id = canvas.create_window(0, 0, window=interior, anchor=tkinter.NW) + + # Track changes to the canvas and frame width and sync them, + # also updating the scrollbar. + def _configure_interior(event): + # Update the scrollbars to match the size of the inner frame. + size = (interior.winfo_reqwidth(), interior.winfo_reqheight()) + canvas.config(scrollregion="0 0 %s %s" % size) + + interior.bind("", _configure_interior) + + def _configure_canvas(event): + if interior.winfo_reqwidth() != canvas.winfo_width(): + # Update the inner frame's width to fill the canvas. + canvas.itemconfigure(interior_id, width=canvas.winfo_width()) + + canvas.bind("", _configure_canvas) + + return + + +# From Python 3.7 Lib/tkinter/__init__.py +# Copyright 2000 Fredrik Lundh +# Python License +# +# add support for 'state' and 'name' kwargs +class OptionMenu(tkinter.Menubutton): + """OptionMenu which allows the user to select a value from a menu.""" + + def __init__(self, master, variable, value, *values, **kwargs): + """Construct an optionmenu widget with the parent MASTER, with + the resource textvariable set to VARIABLE, the initially selected + value VALUE, the other menu values VALUES and an additional + keyword argument command.""" + kw = { + "borderwidth": 2, + "textvariable": variable, + "indicatoron": 1, + "relief": tkinter.RAISED, + "anchor": "c", + "highlightthickness": 2, + } + if "state" in kwargs: + kw["state"] = kwargs["state"] + del kwargs["state"] + if "name" in kwargs: + kw["name"] = kwargs["name"] + del kwargs["name"] + tkinter.Widget.__init__(self, master, "menubutton", kw) + self.widgetName = "tk_optionMenu" + menu = self.__menu = tkinter.Menu(self, name="menu", tearoff=0) + self.menuname = menu._w + # 'command' is the only supported keyword + callback = kwargs.get("command") + if "command" in kwargs: + del kwargs["command"] + if kwargs: + raise tkinter.TclError("unknown option -" + list(kwargs.keys())[0]) + menu.add_command(label=value, command=tkinter._setit(variable, value, callback)) + for v in values: + menu.add_command(label=v, command=tkinter._setit(variable, v, callback)) + self["menu"] = menu + + def __getitem__(self, name): + if name == "menu": + return self.__menu + return tkinter.Widget.__getitem__(self, name) + + def destroy(self): + """Destroy this widget and the associated menu.""" + tkinter.Menubutton.destroy(self) + self.__menu = None + + +class Application(tkinter.Frame): + def __init__(self, master=None, plakativ=None): + super().__init__(master) + self.master = master + self.master.title("plakativ") + + self.pack(fill=tkinter.BOTH, expand=tkinter.TRUE) + + if plakativ is None: + self.plakativ = Plakativ() + else: + self.plakativ = plakativ + + self.border_left = tkinter.DoubleVar(value=20.0) + self.border_right = tkinter.DoubleVar(value=20.0) + self.border_top = tkinter.DoubleVar(value=20.0) + self.border_bottom = tkinter.DoubleVar(value=20.0) + + self.canvas = tkinter.Canvas(self, bg="black") + self.canvas.pack(fill=tkinter.BOTH, side=tkinter.LEFT, expand=tkinter.TRUE) + self.canvas_size = self.canvas.winfo_width(), self.canvas.winfo_height() + self.canvas.bind("", self.on_resize) + + # tkinter does not allow scrollbars for frames + frame1 = VerticalScrolledFrame(self) + frame1.pack(side=tkinter.TOP, expand=tkinter.TRUE, fill=tkinter.Y) + + top_frame = tkinter.Frame(frame1.interior) + top_frame.pack(fill=tkinter.X) + + open_button = tkinter.Button( + top_frame, text="Open PDF", command=self.on_open_button + ) + open_button.pack(side=tkinter.LEFT, expand=tkinter.TRUE, fill=tkinter.X) + help_button = tkinter.Button(top_frame, text="Help", state=tkinter.DISABLED) + help_button.pack(side=tkinter.RIGHT, expand=tkinter.TRUE, fill=tkinter.X) + + input_group = tkinter.LabelFrame(frame1.interior, text="Input properties") + input_group.pack(fill=tkinter.X) + + label_input_width = tkinter.Label(input_group, text="Width:") + label_input_width.grid(row=0, column=0, sticky=tkinter.W) + label_input_height = tkinter.Label(input_group, text="Height:") + label_input_height.grid(row=1, column=0, sticky=tkinter.W) + label_input_npages = tkinter.Label(input_group, text="# of pages:") + label_input_npages.grid(row=2, column=0, sticky=tkinter.W) + label_input_range = tkinter.Label(input_group, text="Page range:") + label_input_range.grid(row=3, column=0, sticky=tkinter.W) + self.input_range = tkinter.StringVar() + self.input_range.set("1") + input_range_entry = tkinter.Entry( + input_group, textvariable=self.input_range, width=6, state=tkinter.DISABLED + ) + input_range_entry.grid(row=3, column=1, sticky=tkinter.W) + + pagesize_group = tkinter.LabelFrame( + frame1.interior, text="Size of output pages" + ) + pagesize_group.pack(fill=tkinter.X) + + pagesize_fixed = tkinter.StringVar() + if self.plakativ.doc is None: + pagesize_fixed.set("") + else: + pagesize_fixed.set( + dict(zip(PAGE_SIZES.values(), PAGE_SIZES.keys()))[ + self.plakativ.pagesize + ] + ) + pagesize_options = OptionMenu( + pagesize_group, + pagesize_fixed, + *PAGE_SIZES.keys(), + command=self.on_select_pagesize, + state=tkinter.DISABLED if self.plakativ.doc is None else tkinter.NORMAL + ) + pagesize_options.grid(row=1, column=0, columnspan=3, sticky=tkinter.W) + + label_pagesize_width = tkinter.Label( + pagesize_group, text="Width:", state=tkinter.DISABLED + ) + label_pagesize_width.grid(row=2, column=0, sticky=tkinter.W) + pagesize_width = tkinter.Spinbox( + pagesize_group, + format="%.2f", + increment=0.01, + from_=0, + to=100, + width=5, + state=tkinter.DISABLED, + ) + pagesize_width.grid(row=2, column=1, sticky=tkinter.W) + label_pagesize_width_mm = tkinter.Label( + pagesize_group, text="mm", state=tkinter.DISABLED + ) + label_pagesize_width_mm.grid(row=2, column=2, sticky=tkinter.W) + + label_pagesize_height = tkinter.Label( + pagesize_group, text="Height:", state=tkinter.DISABLED + ) + label_pagesize_height.grid(row=3, column=0, sticky=tkinter.W) + pagesize_height = tkinter.Spinbox( + pagesize_group, + format="%.2f", + increment=0.01, + from_=0, + to=100, + width=5, + state=tkinter.DISABLED, + ) + pagesize_height.grid(row=3, column=1, sticky=tkinter.W) + label_pagesize_height_mm = tkinter.Label( + pagesize_group, text="mm", state=tkinter.DISABLED + ) + label_pagesize_height_mm.grid(row=3, column=2, sticky=tkinter.W) + + border_group = tkinter.LabelFrame( + frame1.interior, text="Output Borders/Overlap" + ) + border_group.pack(fill=tkinter.X) + + label_left = tkinter.Label(border_group, text="Left:") + label_left.grid(row=0, column=0, sticky=tkinter.W) + border_left = tkinter.Spinbox( + border_group, + format="%.2f", + increment=0.01, + from_=0, + to=100, + width=5, + textvariable=self.border_left, + command=self.on_border, + ) + border_left.grid(row=0, column=1) + label_left_mm = tkinter.Label(border_group, text="mm") + label_left_mm.grid(row=0, column=2) + label_right = tkinter.Label(border_group, text="Right:") + label_right.grid(row=1, column=0, sticky=tkinter.W) + border_right = tkinter.Spinbox( + border_group, + format="%.2f", + increment=0.01, + from_=0, + to=100, + width=5, + textvariable=self.border_right, + command=self.on_border, + ) + border_right.grid(row=1, column=1) + label_right_mm = tkinter.Label(border_group, text="mm") + label_right_mm.grid(row=1, column=2) + label_top = tkinter.Label(border_group, text="Top:") + label_top.grid(row=2, column=0, sticky=tkinter.W) + border_top = tkinter.Spinbox( + border_group, + format="%.2f", + increment=0.01, + from_=0, + to=100, + width=5, + textvariable=self.border_top, + command=self.on_border, + ) + border_top.grid(row=2, column=1) + label_top_mm = tkinter.Label(border_group, text="mm") + label_top_mm.grid(row=2, column=2) + label_bottom = tkinter.Label(border_group, text="Bottom:") + label_bottom.grid(row=3, column=0, sticky=tkinter.W) + border_bottom = tkinter.Spinbox( + border_group, + format="%.2f", + increment=0.01, + from_=0, + to=100, + width=5, + textvariable=self.border_bottom, + command=self.on_border, + ) + border_bottom.grid(row=3, column=1) + label_bottom_mm = tkinter.Label(border_group, text="mm") + label_bottom_mm.grid(row=3, column=2) + + self.postersize = PostersizeWidget(frame1.interior) + self.postersize.pack(fill=tkinter.X) + self.postersize.set("size", (False, (594, 841)), 1.0, 1) + if self.plakativ.doc is not None: + self.postersize.callback = self.on_postersize + + layouter_group = tkinter.LabelFrame(frame1.interior, text="Layouter") + layouter_group.pack(fill=tkinter.X) + + self.layouter = tkinter.IntVar() + self.layouter.set(1) + layouter1 = tkinter.Radiobutton( + layouter_group, text="Simple", variable=self.layouter, value=1 + ) + layouter1.pack(anchor=tkinter.W) + layouter2 = tkinter.Radiobutton( + layouter_group, + text="Advanced", + variable=self.layouter, + value=2, + state=tkinter.DISABLED, + ) + layouter2.pack(anchor=tkinter.W) + layouter3 = tkinter.Radiobutton( + layouter_group, + text="Complex", + variable=self.layouter, + value=3, + state=tkinter.DISABLED, + ) + layouter3.pack(anchor=tkinter.W) + + output_group = tkinter.LabelFrame(frame1.interior, text="Output options") + output_group.pack(fill=tkinter.X) + + tkinter.Checkbutton( + output_group, text="Print cutting guides", state=tkinter.DISABLED + ).pack(anchor=tkinter.W) + tkinter.Checkbutton( + output_group, text="Print poster border", state=tkinter.DISABLED + ).pack(anchor=tkinter.W) + + bottom_frame = tkinter.Frame(frame1.interior) + bottom_frame.pack(fill=tkinter.X) + + self.save_button = tkinter.Button( + bottom_frame, + text="Save PDF", + command=self.on_save_button, + state=tkinter.DISABLED, + ) + self.save_button.pack(side=tkinter.LEFT, expand=tkinter.TRUE, fill=tkinter.X) + + quit_button = tkinter.Button( + bottom_frame, text="Exit", command=self.master.destroy + ) + quit_button.pack(side=tkinter.RIGHT, expand=tkinter.TRUE, fill=tkinter.X) + + def on_postersize(self, value): + mode, (custom_size, size), mult, npages = value + size, mult, npages = self.plakativ.compute_layout(mode, size, mult, npages) + self.draw() + return ( + mode, + (custom_size, size), + mult, + npages, + ) + + def on_border(self): + self.posterizer.border_left = self.border_left.get() + self.posterizer.border_right = self.border_right.get() + self.posterizer.border_top = self.border_top.get() + self.posterizer.border_bottom = self.border_bottom.get() + self.posterizer.compute_layout() + self.draw() + + def on_select_pagesize(self, value): + self.posterizer.pagesize = PAGE_SIZES[value] + self.posterizer.compute_layout() + self.draw() + + def on_resize(self, event): + self.canvas_size = (event.width, event.height) + self.draw() + + def draw(self): + # clean canvas + self.canvas.delete(tkinter.ALL) + + if self.plakativ.doc is None: + return + + canvas_padding = 10 + + r = self.plakativ.dlist.rect + zoom_0 = min( + self.canvas_size[0] + / r.width + * self.plakativ.layout["postersize"][0] + / (self.plakativ.layout["overallsize"][0] + canvas_padding), + self.canvas_size[1] + / r.height + * self.plakativ.layout["postersize"][1] + / (self.plakativ.layout["overallsize"][1] + canvas_padding), + ) + + zoom_1 = min( + self.canvas_size[0] + / (self.plakativ.layout["overallsize"][0] + canvas_padding), + self.canvas_size[1] + / (self.plakativ.layout["overallsize"][1] + canvas_padding), + ) + + mat_0 = fitz.Matrix(zoom_0, zoom_0) + pix = self.plakativ.dlist.getPixmap(matrix=mat_0, alpha=False) + img = pix.getImageData("ppm") + tkimg = tkinter.PhotoImage(data=img) + + # draw image + self.canvas.create_image( + (self.canvas_size[0] - zoom_0 * r.width) / 2, + (self.canvas_size[1] - zoom_0 * r.height) / 2, + anchor=tkinter.NW, + image=tkimg, + ) + self.canvas.image = tkimg + + # draw rectangles + for (x, y, portrait) in self.plakativ.layout["positions"]: + x0 = ( + x * zoom_1 + + self.canvas_size[0] / 2 + - zoom_1 * self.plakativ.layout["overallsize"][0] / 2 + ) + y0 = ( + y * zoom_1 + + self.canvas_size[1] / 2 + - zoom_1 * self.plakativ.layout["overallsize"][1] / 2 + ) + if portrait: + x1 = x0 + self.plakativ.layout["pagesize"][0] * zoom_1 + y1 = y0 + self.plakativ.layout["pagesize"][1] * zoom_1 + else: + x1 = x0 + self.plakativ.layout["pagesize"][1] * zoom_1 + y1 = y0 + self.plakativ.layout["pagesize"][0] * zoom_1 + self.canvas.create_rectangle(x0, y0, x1, y1, outline="red") + self.canvas.create_rectangle( + x0 + zoom_1 * self.border_left.get(), + y0 + zoom_1 * self.border_top.get(), + x1 - zoom_1 * self.border_right.get(), + y1 - zoom_1 * self.border_bottom.get(), + outline="blue", + ) + + def on_open_button(self): + filename = tkinter.filedialog.askopenfilename( + parent=self.master, + title="foobar", + filetypes=[("pdf documents", "*.pdf"), ("all files", "*")], + initialdir="/home/josch/git/plakativ", + initialfile="test.pdf", + ) + if filename == (): + return + self.filename = filename + self.plakativ.open(self.filename) + # compute the splitting with the current values + mode, (_, size), mult, npages = self.postersize.value + size, mult, npages = self.plakativ.compute_layout(mode, size, mult, npages) + # copy computed values to postersize widget + mode, (custom_size, _), _, _ = self.postersize.value + self.postersize.value = ( + mode, + (custom_size, size), + mult, + npages, + ) + # update postersize widget + self.postersize.set(*self.postersize.value) + # draw preview in canvas + self.draw() + # enable save button + self.save_button.configure(state=tkinter.NORMAL) + # set callback function + self.postersize.callback = self.on_postersize + + def on_save_button(self): + base, ext = os.path.splitext(os.path.basename(self.filename)) + filename = tkinter.filedialog.asksaveasfilename( + parent=self.master, + title="foobar", + defaultextension=".pdf", + filetypes=[("pdf documents", "*.pdf"), ("all files", "*")], + initialdir="/home/josch/git/plakativ", + initialfile=base + "_poster" + ext, + ) + if filename == "": + return + self.plakativ.render(filename) + + +class PostersizeWidget(tkinter.LabelFrame): + def __init__(self, parent, *args, **kw): + tkinter.LabelFrame.__init__(self, parent, text="Poster Size", *args, **kw) + + self.callback = None + + self.variables = { + "radio": tkinter.StringVar(), + "dropdown": tkinter.StringVar(), + "width": tkinter.DoubleVar(), + "height": tkinter.DoubleVar(), + "multiplier": tkinter.DoubleVar(), + "pages": tkinter.IntVar(), + } + + for k, v in self.variables.items(): + # need to pass k and v as function arguments so that their value + # does not get overwritten each loop iteration + def callback(varname, idx, op, k_copy=k, v_copy=v): + assert op == "w" + getattr(self, "on_" + k_copy)(v_copy.get()) + + v.trace("w", callback) + + tkinter.Radiobutton( + self, + text="Fit into width/height", + variable=self.variables["radio"], + value="size", + state=tkinter.DISABLED, + name="size_radio", + ).grid(row=0, column=0, columnspan=3, sticky=tkinter.W) + + OptionMenu( + self, + self.variables["dropdown"], + *PAGE_SIZES.keys(), + # state=tkinter.DISABLED, + name="size_dropdown" + ).grid(row=1, column=0, columnspan=3, sticky=tkinter.W, padx=(27, 0)) + + tkinter.Label( + self, text="Width:", state=tkinter.DISABLED, name="size_label_width" + ).grid(row=2, column=0, sticky=tkinter.W, padx=(27, 0)) + tkinter.Spinbox( + self, + format="%.2f", + increment=0.1, + from_=0, + to=10000, + width=5, + textvariable=self.variables["width"], + state=tkinter.DISABLED, + name="size_spinbox_width", + ).grid(row=2, column=1, sticky=tkinter.W) + tkinter.Label( + self, text="mm", state=tkinter.DISABLED, name="size_label_width_mm" + ).grid(row=2, column=2, sticky=tkinter.W) + + tkinter.Label( + self, text="Height:", state=tkinter.DISABLED, name="size_label_height" + ).grid(row=3, column=0, sticky=tkinter.W, padx=(27, 0)) + tkinter.Spinbox( + self, + format="%.2f", + increment=0.1, + from_=0, + to=10000, + width=5, + textvariable=self.variables["height"], + state=tkinter.DISABLED, + name="size_spinbox_height", + ).grid(row=3, column=1, sticky=tkinter.W) + tkinter.Label( + self, text="mm", state=tkinter.DISABLED, name="size_label_height_mm" + ).grid(row=3, column=2, sticky=tkinter.W) + + tkinter.Radiobutton( + self, + text="Factor of input page size", + variable=self.variables["radio"], + value="mult", + state=tkinter.DISABLED, + name="mult_radio", + ).grid(row=4, column=0, columnspan=3, sticky=tkinter.W) + tkinter.Label( + self, + text="Multipler:", + state=tkinter.DISABLED, + name="mult_label_multiplier", + ).grid(row=5, column=0, sticky=tkinter.W, padx=(27, 0)) + tkinter.Spinbox( + self, + format="%.2f", + increment=0.01, + from_=0, + to=10000, + width=6, + textvariable=self.variables["multiplier"], + state=tkinter.DISABLED, + name="mult_spinbox_multiplier", + ).grid(row=5, column=1, sticky=tkinter.W) + tkinter.Label( + self, text="%", state=tkinter.DISABLED, name="mult_label_perc" + ).grid(row=5, column=2, sticky=tkinter.W) + + tkinter.Radiobutton( + self, + text="Fit into X output pages", + variable=self.variables["radio"], + value="npages", + state=tkinter.DISABLED, + name="npages_radio", + ).grid(row=6, column=0, columnspan=3, sticky=tkinter.W) + tkinter.Label( + self, text="# of pages:", state=tkinter.DISABLED, name="npages_label" + ).grid(row=7, column=0, sticky=tkinter.W, padx=(27, 0)) + tkinter.Spinbox( + self, + increment=1, + from_=1, + to=10000, + width=6, + textvariable=self.variables["pages"], + state=tkinter.DISABLED, + name="npages_spinbox", + ).grid(row=7, column=1, sticky=tkinter.W) + + def on_radio(self, value): + _, size, mult, npages = self.value + self.set(value, size, mult, npages) + + def on_dropdown(self, value): + mode, (custom_size, size), mult, npages = self.value + if value == "custom": + custom_size = True + else: + custom_size = False + size = PAGE_SIZES[value] + self.set(mode, (custom_size, size), mult, npages) + + def on_width(self, value): + if getattr(self, "value", None) is None: + return + mode, (custom_size, (_, height)), mult, npages = self.value + self.set(mode, (custom_size, (value, height)), mult, npages) + + def on_height(self, value): + if getattr(self, "value", None) is None: + return + mode, (custom_size, (width, _)), mult, npages = self.value + self.set(mode, (custom_size, (width, value)), mult, npages) + + def on_multiplier(self, value): + if getattr(self, "value", None) is None: + return + mode, size, _, npages = self.value + self.set(mode, size, value, npages) + + def on_pages(self, value): + if getattr(self, "value", None) is None: + return + mode, size, mult, _ = self.value + self.set(mode, size, mult, value) + + def set(self, mode, size, mult, npages): + # before setting self.value, check if the effective value is different + # from before or otherwise we do not need to execute the callback in + # the end + state_changed = True + if getattr(self, "value", None) is not None: + if mode == self.value[0] == "size": + state_changed = self.value[1][1] != size[1] + elif mode == self.value[0] == "mult": + state_changed = self.value[2] != mult + elif mode == self.value[0] == "npages": + state_changed = self.value[3] != npages + # execute callback if necessary + if state_changed and self.callback is not None: + mode, size, mult, npages = self.callback((mode, size, mult, npages)) + self.value = (mode, size, mult, npages) + custom_size, (width, height) = size + # cycle through all widgets and set the state accordingly + for k, v in self.children.items(): + if k.endswith("_radio"): + v.configure(state=tkinter.NORMAL) + continue + if not k.startswith(mode + "_"): + v.configure(state=tkinter.DISABLED) + continue + if k in ["size_dropdown", "size_radio"]: + v.configure(state=tkinter.NORMAL) + continue + if mode != "size": + v.configure(state=tkinter.NORMAL) + continue + if custom_size: + v.configure(state=tkinter.NORMAL) + continue + v.configure(state=tkinter.DISABLED) + # only set variables that changed to not trigger multiple variable tracers + if custom_size or mode != "size": + if self.variables["dropdown"].get() != "custom": + self.variables["dropdown"].set("custom") + else: + val = dict(zip(PAGE_SIZES.values(), PAGE_SIZES.keys()))[(width, height)] + if self.variables["dropdown"].get() != val: + self.variables["dropdown"].set(val) + if self.variables["radio"].get() != mode: + self.variables["radio"].set(mode) + if self.variables["width"].get() != width: + self.variables["width"].set(width) + if self.variables["height"].get() != height: + self.variables["height"].set(height) + if self.variables["multiplier"].get() != mult: + self.variables["multiplier"].set(mult) + if self.variables["pages"].get() != npages: + self.variables["pages"].set(npages) + + +def compute_layout(infile, outfile, mode, size=None, mult=None, npages=None): + plakativ = Plakativ(infile) + plakativ.compute_layout(mode, size, mult, npages) + plakativ.render(outfile) + + +def gui(): + root = tkinter.Tk() + app = Application(master=root) + app.mainloop() + + +def main(): + parser = argparse.ArgumentParser() + gui_group = parser.add_mutually_exclusive_group(required=False) + gui_group.add_argument( + "--gui", + dest="gui", + action="store_true", + help="run tkinter gui (default on Windows)", + ) + gui_group.add_argument( + "--nogui", + dest="gui", + action="store_false", + help="don't run tkinter gui (default elsewhere)", + ) + if platform.system() == "Windows": + parser.set_defaults(gui=True) + else: + parser.set_defaults(gui=False) + + parser.add_argument("-o", "--output", help="output file") + + parser.add_argument("input", nargs="?", help="input file") + + args = parser.parse_args() + + if args.gui: + gui() + exit(0) + + compute_layout(args.input, args.output) + +if __name__ == "__main__": + main() + +__all__ = ["Plakativ", "compute_layout"] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..6a707d8 --- /dev/null +++ b/setup.py @@ -0,0 +1,43 @@ +from setuptools import setup + +VERSION = "0.1" + +setup( + name="plakativ", + version=VERSION, + author="Johannes 'josch' Schauer", + author_email="josch@mister-muffin.de", + description="Convert a PDF into a large poster that can be printed on multiple smaller pages.", + long_description="file: README.md, CHANGELOG.rst", + license="GPL-3", + keywords="pdf poster", + classifiers=[ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "Intended Audience :: Other Audience", + "Environment :: Console", + "Environment :: MacOS X", + "Environment :: Win32 (MS Windows)", + "Environment :: X11 Applications", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Natural Language :: English", + "Operating System :: OS Independent", + ], + url="https://gitlab.mister-muffin.de/josch/plakativ", + download_url="https://gitlab.mister-muffin.de/josch/plakativ/repository/" + "archive.tar.gz?ref=" + VERSION, + test_suite="tests.test_suite", + zip_safe=True, + include_package_data=True, + install_requires=["PyMuPDF"], + entry_points={ + "setuptools.installation": ["eggsecutable = plakativ:main"], + "console_scripts": ["plakativ = plakativ:main"], + "gui_scripts": ["plakativ-gui = plakativ:gui"], + }, +) diff --git a/test.py b/test.py new file mode 100644 index 0000000..fa30fbb --- /dev/null +++ b/test.py @@ -0,0 +1,103 @@ +import pytest +import plakativ +import tempfile +import fitz +import fitz.utils +import os +import pdfrw + + +@pytest.fixture(scope="module") +def infile(): + doc = fitz.open() + page = doc.newPage(pno=-1, width=595, height=842) + img = page.newShape() + + red = fitz.utils.getColor("red") + green = fitz.utils.getColor("green") + blue = fitz.utils.getColor("blue") + orange = fitz.utils.getColor("orange") + + img.insertText(fitz.Point(97, 620), "A", fontsize=600, color=blue) + img.commit() + img.drawLine(fitz.Point(0, 0), fitz.Point(595, 842)) + img.finish(color=red) + img.drawLine(fitz.Point(0, 842), fitz.Point(595, 0)) + img.finish(color=green) + img.drawRect(fitz.Rect(fitz.Point(0, 0), fitz.Point(595, 842))) + img.finish(color=orange) + img.commit() + + fd, tmpfile = tempfile.mkstemp(prefix="plakativ") + os.close(fd) + doc.save(tmpfile, pretty=True, expand=255) + yield tmpfile + os.unlink(tmpfile) + + +def test_foo(infile): + print("blob") + fd, outfile = tempfile.mkstemp(prefix="plakativ") + os.close(fd) + plakativ.compute_layout(infile, outfile, mode="size", size=(297, 420)) + + reader = pdfrw.PdfReader(outfile) + pages = reader.Root.Pages.Kids + assert len(pages) == 4 + assert pages[0].Resources.XObject.fzFrm0.BBox == [ + "0", + "380.6912", + "337.75163", + "842", + ] + assert pages[1].Resources.XObject.fzFrm0.BBox == [ + "257.524", + "380.6912", + "595", + "842", + ] + assert pages[2].Resources.XObject.fzFrm0.BBox == [ + "0", + "0", + "337.75163", + "460.91883", + ] + assert pages[3].Resources.XObject.fzFrm0.BBox == [ + "257.524", + "0", + "595", + "460.91883", + ] + assert pages[0].Resources.XObject.fzFrm0.Matrix == [ + "1.4133016", + "0", + "0", + "1.4133016", + "117.930667", + "-538.03146", + ] + assert pages[1].Resources.XObject.fzFrm0.Matrix == [ + "1.4133017", + "0", + "0", + "1.4133017", + "-363.76438", + "-538.0315", + ] + assert pages[2].Resources.XObject.fzFrm0.Matrix == [ + "1.4133016", + "0", + "0", + "1.4133016", + "117.930667", + "190.19687", + ] + assert pages[3].Resources.XObject.fzFrm0.Matrix == [ + "1.4144558", + "0", + "0", + "1.4144558", + "-364.25627", + "189.93088", + ] + os.unlink(outfile) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..8894c75 --- /dev/null +++ b/tox.ini @@ -0,0 +1,10 @@ +[tox] +envlist = py26, py27, py33, py34, py35, py36, py37 + +[testenv] +deps = pytest +commands = pytest-3 + +[testenv:py37-black] +deps = black +commands = black --check --diff plakativ.py