commit dc3acadb9aaefead52ce11dee62f1a9fbdd444b7 Author: Valentin Niess Date: Sun Mar 29 11:59:23 2020 +0200 Initial commit diff --git a/.github/workflows/appimage.yml b/.github/workflows/appimage.yml new file mode 100644 index 0000000..200ead7 --- /dev/null +++ b/.github/workflows/appimage.yml @@ -0,0 +1,69 @@ +name: AppImage +on: + push: + paths: + - '.github/workflows/appimage.yml' + - 'python_appimage' + +jobs: + Build: + runs-on: ubuntu-latest + strategy: + matrix: + image: ['1', '2010', '2014'] + arch: [x86_64, i686] + tag: [cp27-cp27m, cp27-cp27mu, cp35-cp35m, cp36-cp36m, cp37-cp37m, + cp38-cp38] + exclude: + - image: '2014' + tag: cp27-cp27m + - image: '2014' + tag: cp27-cp27mu + + steps: + - uses: actions/checkout@v2 + + - name: Build + run: | + # Build the AppImage + python -m python_appimage manylinux \ + ${{ matrix.image }}_${{ matrix.arch }} \ + ${{ matrix.tag }} + + # Export the AppImage name and the Python version + appimage=$(ls python*.AppImage) + SCRIPT=$(cat <<-END + version = '${appimage}'[6:].split('.', 2) + print('{:}.{:}'.format(*version[:2])) + END + ) + version=$(python -c "${SCRIPT}") + + echo "::set-env name=PYTHON_APPIMAGE::${appimage}" + echo "::set-env name=PYTHON_VERSION::${version}" + + - uses: actions/upload-artifact@v1 + with: + name: python${{ env.PYTHON_VERSION }}-appimages + path: ${{ env.PYTHON_APPIMAGE }} + + Release: + needs: Build + runs-on: ubuntu-latest + strategy: + matrix: + version: [2.7, 3.4, 3.5, 3.6, 3.7, 3.8] + + steps: + - uses: actions/download-artifact@v1 + with: + name: python${{ matrix.version }}-appimages + + - name: Release + uses: marvinpinto/action-automatic-releases@latest + with: + automatic_release_tag: python${{ matrix.version }} + title: Python ${{ matrix.version }} + files: | + python${{ matrix.version }}-appimages/python*.AppImage + repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/delete-artifacts.yml b/.github/workflows/delete-artifacts.yml new file mode 100644 index 0000000..4de88d7 --- /dev/null +++ b/.github/workflows/delete-artifacts.yml @@ -0,0 +1,13 @@ +name: Delete artifacts +on: + schedule: + - cron: '0 */6 * * *' # every 6 hours + +jobs: + delete-artifacts: + runs-on: ubuntu-latest + steps: + - uses: kolpav/purge-artifacts-action@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} + expire-in: 0days diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..379fe5c --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*.AppImage +*.pyc +*.pyo +__pycache__ +AppDir +python_appimage/bin +python_appimage/data/excludelist 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..ac923ac --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# AppImage distributions of Python + +_Work in progress - Check the [releases][RELEASES] area for available +AppImages._ + + +[RELEASES]: https://github.com/niess/python-appimage/releases diff --git a/python_appimage/__init__.py b/python_appimage/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/python_appimage/__main__.py b/python_appimage/__main__.py new file mode 100644 index 0000000..96e3a92 --- /dev/null +++ b/python_appimage/__main__.py @@ -0,0 +1,58 @@ +import argparse +from importlib import import_module +import logging +import os +import sys + +from .deps import fetch_all + + +__all__ = ['main'] + + +def main(): + # Parse arguments + parser = argparse.ArgumentParser( + description='Bundle a Python install into an AppImage') + subparsers = parser.add_subparsers(title='builder', + help='Appimage builder', + dest='builder') + + parser.add_argument('-q', '--quiet', help='disable logging', + dest='verbosity', action='store_const', const=logging.ERROR) + parser.add_argument('-v', '--verbose', help='print extra information', + dest='verbosity', action='store_const', const=logging.DEBUG) + + parser.add_argument('--deploy', help=argparse.SUPPRESS, + action='store_true', default=False) + + local_parser = subparsers.add_parser('local') + local_parser.add_argument('-d', '--destination', + help='AppImage destination') + local_parser.add_argument('-p', '--python', help='python executable') + + manylinux_parser = subparsers.add_parser('manylinux') + manylinux_parser.add_argument('tag', help='manylinux image tag') + manylinux_parser.add_argument('abi', help='python ABI') + + manylinux_parser.add_argument('--contained', help=argparse.SUPPRESS, + action='store_true', default=False) + + args = parser.parse_args() + + # Configure the verbosity + if args.verbosity: + logging.getLogger().setLevel(args.verbosity) + + if args.deploy: + # Fetch dependencies and exit + fetch_all() + sys.exit(0) + + # Call the AppImage builder + builder = import_module('.' + args.builder, package=__package__) + builder.build(*builder._unpack_args(args)) + + +if __name__ == "__main__": + main() diff --git a/python_appimage/build.py b/python_appimage/build.py new file mode 100644 index 0000000..34613b8 --- /dev/null +++ b/python_appimage/build.py @@ -0,0 +1,55 @@ +import os +import subprocess +import sys + +from .deps import APPIMAGETOOL, ensure_appimagetool +from .docker import docker_run +from .fs import copy_tree +from .log import debug, log +from .tmp import TemporaryDirectory + + +__all__ = ['build_appimage'] + + +def build_appimage(appdir=None, destination=None): + '''Build an AppImage from an AppDir + ''' + if appdir is None: + appdir = 'AppDir' + + log('BUILD', appdir) + ensure_appimagetool() + + cmd = [APPIMAGETOOL, appdir] + if destination is not None: + cmd.append(destination) + cmd = ' '.join(cmd) + + debug('SYSTEM', cmd) + p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, + stderr=subprocess.STDOUT) + stdout = [] + while True: + out = p.stdout.readline() + try: + out = out.decode() + except AttributeError: + out = str(out) + stdout.append(out) + if out == '' and p.poll() is not None: + break + elif out: + out = out.replace('%', '%%')[:-1] + for line in out.split(os.linesep): + if line.startswith('WARNING'): + log('WARNING', line[9:]) + elif line.startswith('Error'): + raise RuntimeError(line) + else: + debug('APPIMAGE', line) + rc = p.poll() + if rc != 0: + print(''.join(stdout)) + sys.stdout.flush() + raise RuntimeError('Could not build AppImage') diff --git a/python_appimage/data/apprun.sh b/python_appimage/data/apprun.sh new file mode 100755 index 0000000..513d51b --- /dev/null +++ b/python_appimage/data/apprun.sh @@ -0,0 +1,9 @@ +#! /bin/bash + +# Export APPRUN if running from an extracted image +self="$(readlink -f -- $0)" +here="${self%/*}" +APPDIR="${APPDIR:-${here}}" + +# Call the python wrapper +"${APPDIR}/usr/bin/python{{version}}" "$@" diff --git a/python_appimage/data/python-wrapper.sh b/python_appimage/data/python-wrapper.sh new file mode 100755 index 0000000..c3efc48 --- /dev/null +++ b/python_appimage/data/python-wrapper.sh @@ -0,0 +1,45 @@ +#!/bin/bash + +SCRIPT="$(readlink -f -- $0)" +SCRIPTPATH="$(dirname $SCRIPT)" +APPDIR="${APPDIR:-$SCRIPTPATH/../..}" + +# Configure the environment +if [ -d "${APPDIR}/usr/share/tcltk" ]; then + export TCL_LIBRARY="$(ls -d ${APPDIR}/usr/share/tcltk/tcl* | tail -1)" + export TK_LIBRARY="$(ls -d ${APPDIR}/usr/share/tcltk/tk* | tail -1)" + export TKPATH="${TK_LIBRARY}" +fi + +# Resolve symlinks within the image +prefix="opt/{{PYTHON}}" +nickname="{{PYTHON}}" +executable="${APPDIR}/${prefix}/bin/${nickname}" + +if [ -L "${executable}" ]; then + nickname="$(basename $(readlink -f ${executable}))" +fi + +for opt in "$@" +do + [ "${opt:0:1}" != "-" ] && break + if [[ "${opt}" =~ "I" ]] || [[ "${opt}" =~ "E" ]]; then + # Environment variables are disabled ($PYTHONHOME). Let's run in a safe + # mode from the raw Python binary inside the AppImage + "$APPDIR/${prefix}/bin/${nickname}" "$@" + exit "$?" + fi +done + +# But don't resolve symlinks from outside! +if [[ "${ARGV0}" =~ "/" ]]; then + executable="$(cd $(dirname ${ARGV0}) && pwd)/$(basename ${ARGV0})" +elif [[ "${ARGV0}" != "" ]]; then + executable=$(which "${ARGV0}") +fi + +# Wrap the call to Python in order to mimic a call from the source +# executable ($ARGV0), but potentially located outside of the Python +# install ($PYTHONHOME) +(PYTHONHOME="${APPDIR}/${prefix}" exec -a "${executable}" "$APPDIR/${prefix}/bin/${nickname}" "$@") +exit "$?" diff --git a/python_appimage/data/python.appdata.xml b/python_appimage/data/python.appdata.xml new file mode 100644 index 0000000..ab69c6c --- /dev/null +++ b/python_appimage/data/python.appdata.xml @@ -0,0 +1,18 @@ + + + python{{fullversion}} + Python-2.0 + Python-2.0 + Python {{version}} + A Python {{version}} runtime + +

A relocated Python {{version}} installation running from an + AppImage. +

+ + python.desktop + https://python.org + + python{{version}} + + diff --git a/python_appimage/data/python.desktop b/python_appimage/data/python.desktop new file mode 100644 index 0000000..d8d41c5 --- /dev/null +++ b/python_appimage/data/python.desktop @@ -0,0 +1,8 @@ +[Desktop Entry] +Type=Application +Name=python{{fullversion}} +Exec=python{{version}} +Comment=A Python {{version}} runtime +Icon=python +Categories=Development; +Terminal=true diff --git a/python_appimage/data/python.png b/python_appimage/data/python.png new file mode 100644 index 0000000..ccaf15d Binary files /dev/null and b/python_appimage/data/python.png differ diff --git a/python_appimage/data/sitecustomize.py b/python_appimage/data/sitecustomize.py new file mode 100644 index 0000000..95cf15d --- /dev/null +++ b/python_appimage/data/sitecustomize.py @@ -0,0 +1,26 @@ +"""Hook for cleaning the paths detected by Python +""" +import os +import sys + + +def clean_path(): + site_packages = "/usr/local/lib/python{:}.{:}/site-packages".format( + *sys.version_info[:2]) + binaries_path = "/usr/local/bin" + env_path = os.getenv("PYTHONPATH") + if env_path is None: + env_path = [] + else: + env_path = [os.path.realpath(path) for path in env_path.split(":")] + + if ((os.path.dirname(sys.executable) != binaries_path) and + (site_packages not in env_path)): + # Remove the builtin site-packages from the path + try: + sys.path.remove(site_packages) + except ValueError: + pass + + +clean_path() diff --git a/python_appimage/deps.py b/python_appimage/deps.py new file mode 100644 index 0000000..790bc66 --- /dev/null +++ b/python_appimage/deps.py @@ -0,0 +1,99 @@ +import os +import platform +import stat + +from .fs import copy_file, copy_tree, make_tree +from .log import log +from .system import system +from .tmp import TemporaryDirectory +from .url import urlretrieve + + +__all__ = ['APPIMAGETOOL', 'EXCLUDELIST', 'PATCHELF', 'PREFIX', + 'ensure_appimagetool', 'ensure_excludelist', 'ensure_patchelf', + 'fetch_all'] + + +_ARCH = platform.machine() + + +PREFIX = os.path.abspath(os.path.dirname(__file__)) +'''Package installation prefix''' + +APPIMAGETOOL = PREFIX + '/bin/appimagetool.' + _ARCH +'''Location of the appimagetool binary''' + +EXCLUDELIST = PREFIX + '/data/excludelist' +'''AppImage exclusion list''' + +PATCHELF = PREFIX + '/bin/patchelf.' + _ARCH +'''Location of the PatchELF binary''' + + +def ensure_appimagetool(): + '''Fetch appimagetool from the web if not available locally + ''' + if os.path.exists(APPIMAGETOOL): + return + + appimage = 'appimagetool-{0:}.AppImage'.format(_ARCH) + baseurl = 'https://github.com/AppImage/AppImageKit/releases/' \ + 'download/continuous' + log('INSTALL', 'appimagetool from %s', baseurl) + + appdir_name = 'appimagetool-{:}.appdir'.format(_ARCH) + appdir = os.path.join(os.path.dirname(APPIMAGETOOL), appdir_name) + if not os.path.exists(appdir): + make_tree(os.path.dirname(appdir)) + with TemporaryDirectory() as tmpdir: + urlretrieve(os.path.join(baseurl, appimage), appimage) + os.chmod(appimage, stat.S_IRWXU) + system('./' + appimage, '--appimage-extract') + copy_tree('squashfs-root', appdir) + + if not os.path.exists(APPIMAGETOOL): + os.symlink(appdir_name + '/AppRun', APPIMAGETOOL) + + +# Installers for dependencies +def ensure_excludelist(): + '''Fetch the AppImage excludelist from the web if not available locally + ''' + if os.path.exists(EXCLUDELIST): + return + + baseurl = 'https://raw.githubusercontent.com/probonopd/AppImages/master' + log('INSTALL', 'excludelist from %s', baseurl) + urlretrieve(baseurl + '/excludelist', EXCLUDELIST) + mode = os.stat(EXCLUDELIST)[stat.ST_MODE] + os.chmod(EXCLUDELIST, mode | stat.S_IWGRP | stat.S_IWOTH) + + +def ensure_patchelf(): + '''Fetch PatchELF from the web if not available locally + ''' + if os.path.exists(PATCHELF): + return + + iarch = 'i386' if _ARCH == 'i686' else _ARCH + appimage = 'patchelf-{0:}.AppImage'.format(iarch) + baseurl = 'https://github.com/niess/patchelf.appimage/releases/download' + log('INSTALL', 'patchelf from %s', baseurl) + + dirname = os.path.dirname(PATCHELF) + patchelf = dirname + '/patchelf.' + _ARCH + make_tree(dirname) + with TemporaryDirectory() as tmpdir: + urlretrieve(os.path.join(baseurl, 'rolling', appimage), appimage) + os.chmod(appimage, stat.S_IRWXU) + system('./' + appimage, '--appimage-extract') + copy_file('squashfs-root/usr/bin/patchelf', patchelf) + os.chmod(patchelf, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO) + + +def fetch_all(): + '''Fetch all dependencies from the web + ''' + ensure_appimagetool() + ensure_excludelist() + ensure_patchelf() diff --git a/python_appimage/docker.py b/python_appimage/docker.py new file mode 100644 index 0000000..1a79032 --- /dev/null +++ b/python_appimage/docker.py @@ -0,0 +1,49 @@ +import os +import platform +import stat +import subprocess +import sys + +from .log import log +from .system import system + + +def docker_run(image, extra_cmds): + '''Execute commands within a docker container + ''' + + ARCH = platform.machine() + if image.endswith(ARCH): + bash_arg = '/pwd/run.sh' + elif image.endswith('i686') and ARCH == 'x86_64': + bash_arg = '-c "linux32 /pwd/run.sh"' + elif image.endswith('x86_64') and ARCH == 'i686': + bash_arg = '-c "linux64 /pwd/run.sh"' + else: + raise ValueError('Unsupported Docker image: ' + image) + + log('PULL', image) + system('docker', 'pull', image) + + script = [ + 'set -e', + 'trap "chown -R {:}:{:} *" EXIT'.format(os.getuid(), + os.getgid()), + 'cd /pwd' + ] + + script += extra_cmds + + with open('run.sh', 'w') as f: + f.write(os.linesep.join(script)) + os.chmod('run.sh', stat.S_IRWXU) + + cmd = ' '.join(('docker', 'run', '--mount', + 'type=bind,source={:},target=/pwd'.format(os.getcwd()), + image, '/bin/bash', bash_arg)) + + log('RUN', image) + p = subprocess.Popen(cmd, shell=True) + p.communicate() + if p.returncode != 0: + sys.exit(p.returncode) diff --git a/python_appimage/fs.py b/python_appimage/fs.py new file mode 100644 index 0000000..a42e9b8 --- /dev/null +++ b/python_appimage/fs.py @@ -0,0 +1,75 @@ +from distutils.dir_util import mkpath as _mkpath, remove_tree as _remove_tree +from distutils.file_util import copy_file as _copy_file +import errno +import os + +from .log import debug + + +__all__ = ['copy_file', 'copy_tree', 'make_tree', 'remove_file', 'remove_tree'] + + +# Wrap some file system related functions +def make_tree(path): + '''Create directories recursively if they don't exist + ''' + debug('MKDIR', path) + return _mkpath(path) + + +def copy_file(source, destination, update=False, verbose=True): + ''' + ''' + name = os.path.basename(source) + if verbose: + debug('COPY', '%s from %s', name, os.path.dirname(source)) + _copy_file(source, destination, update=update) + + +def copy_tree(source, destination): + '''Copy (or update) a directory preserving symlinks + ''' + if not os.path.exists(source): + raise OSError(errno.ENOENT, 'No such file or directory: ' + source) + + name = os.path.basename(source) + debug('COPY', '%s from %s', name, os.path.dirname(source)) + + for root, _, files in os.walk(source): + relpath = os.path.relpath(root, source) + dirname = os.path.join(destination, relpath) + _mkpath(dirname) + for file_ in files: + src = os.path.join(root, file_) + dst = os.path.join(dirname, file_) + if os.path.islink(src): + try: + os.remove(dst) + except OSError: + pass + linkto = os.readlink(src) + os.symlink(linkto, dst) + else: + copy_file(src, dst, update=True, verbose=False) + + +def remove_file(path): + '''remove a file if it exists + ''' + name = os.path.basename(path) + debug('REMOVE', '%s from %s', name, os.path.dirname(path)) + try: + os.remove(path) + except OSError: + pass + + +def remove_tree(path): + '''remove a directory if it exists + ''' + name = os.path.basename(path) + debug('REMOVE', '%s from %s', name, os.path.dirname(path)) + try: + _remove_tree(path) + except OSError: + pass diff --git a/python_appimage/local.py b/python_appimage/local.py new file mode 100644 index 0000000..9126a62 --- /dev/null +++ b/python_appimage/local.py @@ -0,0 +1,40 @@ +import glob +import os +import shutil + +from .build import build_appimage +from .relocate import relocate_python +from .tmp import TemporaryDirectory + + +__all__ = ['build'] + + +def _unpack_args(args): + '''Unpack command line arguments + ''' + return args.python, args.destination + + +def build(python=None, destination=None): + '''Build a Python AppImage using a local installation + ''' + pwd = os.getcwd() + with TemporaryDirectory() as tmpdir: + relocate_python(python) + + dirname, pattern = None, None + if destination is not None: + dirname, destination = os.path.split(destination) + pattern = destination + if pattern is None: + pattern = 'python*.AppImage' + build_appimage(destination=destination) + appimage = glob.glob(pattern)[0] + if dirname is None: + dirname = pwd + else: + os.chdir(pwd) + dirname = os.path.abspath(dirname) + os.chdir(tmpdir) + shutil.move(appimage, os.path.join(dirname, appimage)) diff --git a/python_appimage/log.py b/python_appimage/log.py new file mode 100644 index 0000000..1151791 --- /dev/null +++ b/python_appimage/log.py @@ -0,0 +1,23 @@ +import logging + + +__all__ = ['debug', 'log'] + + +# Configure the logger +logging.basicConfig( + format='[%(asctime)s] %(message)s', + level=logging.INFO +) + + +def log(task, fmt, *args): + '''Log a standard message + ''' + logging.info('%-8s ' + fmt, task, *args) + + +def debug(task, fmt, *args): + '''Report some debug information + ''' + logging.debug('%-8s ' + fmt, task, *args) diff --git a/python_appimage/manylinux.py b/python_appimage/manylinux.py new file mode 100644 index 0000000..f08b2aa --- /dev/null +++ b/python_appimage/manylinux.py @@ -0,0 +1,94 @@ +import glob +import os +import platform +import shutil +import sys + +from .build import build_appimage +from .docker import docker_run +from .fs import copy_tree +from .relocate import relocate_python +from .tmp import TemporaryDirectory + + +__all__ = ['build'] + + +def _unpack_args(args): + '''Unpack command line arguments + ''' + return args.tag, args.abi, args.contained + + +def _get_appimage_name(abi, tag): + '''Format the Python AppImage name using the ABI and OS tags + ''' + # Read the Python version from the desktop file + desktop = glob.glob('AppDir/python*.desktop')[0] + fullversion = desktop[13:-8] + + # Finish building the AppImage on the host. See below. + return 'python{:}-{:}-manylinux{:}.AppImage'.format( + fullversion, abi, tag) + + +def build(tag, abi, contained=False): + '''Build a Python AppImage using a manylinux docker image + ''' + + if not contained: + # Forward the build to a Docker image + image = 'quay.io/pypa/manylinux' + tag + python = '/opt/python/' + abi + '/bin/python' + + pwd = os.getcwd() + dirname = os.path.abspath(os.path.dirname(__file__)) + with TemporaryDirectory() as tmpdir: + copy_tree(dirname, 'python_appimage') + + argv = ' '.join(sys.argv[1:]) + script = ( + 'yum --disablerepo="*" --enablerepo=base install -q -y tk', + python + ' -m python_appimage ' + argv + ' --contained', + '' + ) + docker_run(image, script) + + appimage_name = _get_appimage_name(abi, tag) + + if tag.startswith('1_'): + # appimagetool does not run on manylinux1 (CentOS 5). Below is + # a patch for this specific case. + arch = tag.split('_', 1)[-1] + if arch == platform.machine(): + # Pack the image directly from the host + build_appimage(destination=appimage_name) + else: + # Use a manylinux2010 Docker image (CentOS 6) in order to + # pack the image. + script = ( + python + ' -m python_appimage ' + argv + ' --contained', + '' + ) + docker_run('quay.io/pypa/manylinux2010_' + arch, script) + + shutil.move(appimage_name, os.path.join(pwd, appimage_name)) + + else: + # We are running within a manylinux Docker image + is_manylinux1 = tag.startswith('1_') + + if not os.path.exists('AppDir'): + # Relocate the targeted manylinux Python installation + relocate_python() + else: + # This is a second stage build. The Docker image has actually been + # overriden (see above). + is_manylinux1 = False + + if is_manylinux1: + # Build only the AppDir when running within a manylinux1 Docker + # image because appimagetool does not support CentOS 5. + pass + else: + build_appimage(destination=_get_appimage_name(abi, tag)) diff --git a/python_appimage/relocate.py b/python_appimage/relocate.py new file mode 100644 index 0000000..3551cb7 --- /dev/null +++ b/python_appimage/relocate.py @@ -0,0 +1,268 @@ +import glob +import os +import re +import shutil +import sys + +from .deps import EXCLUDELIST, PATCHELF, PREFIX, ensure_excludelist, \ + ensure_patchelf +from .fs import make_tree, copy_file, copy_tree, remove_file, remove_tree +from .log import debug, log +from .system import ldd, system + + +__all__ = ["patch_binary", "relocate_python"] + + +_template_pattern = re.compile('[{][{]([^{}]+)[}][}]') + + +def _copy_template(name, destination, **kwargs): + '''Copy a template file and substitue keywords + ''' + debug('COPY', '%s as %s', name, destination) + source = os.path.join(PREFIX, 'data', name) + with open(source) as f: + template = f.read() + + def matcher(m): + return kwargs[m.group(1)] + + txt = _template_pattern.sub(matcher, template) + + with open(destination, 'w') as f: + f.write(txt) + + shutil.copymode(source, destination) + + +_excluded_libs = None +'''Appimage excluded libraries, i.e. assumed to be installed on the host +''' + + +def patch_binary(path, libdir, recursive=True): + '''Patch the RPATH of a binary and and fetch its dependencies + ''' + global _excluded_libs + + if _excluded_libs is None: + ensure_excludelist() + excluded = [] + with open(EXCLUDELIST) as f: + for line in f: + line = line.strip() + if (not line) or line.startswith('#'): + continue + excluded.append(line.split(' ', 1)[0]) + _excluded_libs = excluded + else: + excluded = _excluded_libs + + ensure_patchelf() + rpath = '\'' + system(PATCHELF, '--print-rpath', path) + '\'' + relpath = os.path.relpath(libdir, os.path.dirname(path)) + relpath = '' if relpath == '.' else '/' + relpath + expected = '\'$ORIGIN' + relpath + '\'' + if rpath != expected: + system(PATCHELF, '--set-rpath', expected, path) + + deps = ldd(path) + for dep in deps: + name = os.path.basename(dep) + if name in excluded: + continue + target = libdir + '/' + name + if not os.path.exists(target): + libname = os.path.basename(dep) + copy_file(dep, target) + if recursive: + patch_binary(target, libdir, recursive=True) + + +def relocate_python(python=None, appdir=None): + '''Bundle a Python install inside an AppDir + ''' + + if python is not None: + if not os.path.exists(python): + raise ValueError('could not access ' + python) + + if appdir is None: + appdir = 'AppDir' + + + # Set some key variables & paths + if python: + FULLVERSION = system(python, '-c', + '"import sys; print(\'{:}.{:}.{:}\'.format(*sys.version_info[:3]))"') + FULLVERSION = FULLVERSION.strip() + else: + FULLVERSION = '{:}.{:}.{:}'.format(*sys.version_info[:3]) + VERSION = '.'.join(FULLVERSION.split('.')[:2]) + PYTHON_X_Y = 'python' + VERSION + + APPDIR = os.path.abspath(appdir) + APPDIR_BIN = APPDIR + '/usr/bin' + APPDIR_LIB = APPDIR + '/usr/lib' + APPDIR_SHARE = APPDIR + '/usr/share' + + if python: + HOST_PREFIX = system( + python, '-c', '"import sys; print(sys.prefix)"').strip() + else: + HOST_PREFIX = sys.prefix + HOST_BIN = HOST_PREFIX + '/bin' + HOST_INC = HOST_PREFIX + '/include/' + PYTHON_X_Y + if not os.path.exists(HOST_INC): + HOST_INC += 'm' + HOST_LIB = HOST_PREFIX + '/lib' + HOST_PKG = HOST_LIB + '/' + PYTHON_X_Y + + PYTHON_PREFIX = APPDIR + '/opt/' + PYTHON_X_Y + PYTHON_BIN = PYTHON_PREFIX + '/bin' + PYTHON_INC = PYTHON_PREFIX + '/include/' + PYTHON_X_Y + PYTHON_LIB = PYTHON_PREFIX + '/lib' + PYTHON_PKG = PYTHON_LIB + '/' + PYTHON_X_Y + + + # Copy the running Python's install + log('CLONE', '%s from %s', PYTHON_X_Y, HOST_PREFIX) + + source = HOST_BIN + '/' + PYTHON_X_Y + if not os.path.exists(source): + raise ValueError('could not find {0:} executable'.format(PYTHON_X_Y)) + make_tree(PYTHON_BIN) + target = PYTHON_BIN + '/' + PYTHON_X_Y + copy_file(source, target, update=True) + + copy_tree(HOST_PKG, PYTHON_PKG) + copy_tree(HOST_INC, PYTHON_INC) + + + # Remove unrelevant files + log('PRUNE', '%s packages', PYTHON_X_Y) + + remove_file(PYTHON_LIB + '/lib' + PYTHON_X_Y + '.a') + remove_tree(PYTHON_PKG + '/test') + remove_file(PYTHON_PKG + '/dist-packages') + matches = glob.glob(PYTHON_PKG + '/config-*-linux-*') + for path in matches: + remove_tree(path) + + + # Wrap the Python executable + log('WRAP', '%s executable', PYTHON_X_Y) + + with open(PREFIX + '/data/python-wrapper.sh') as f: + text = f.read() + text = text.replace('{{PYTHON}}', PYTHON_X_Y) + + make_tree(APPDIR_BIN) + target = APPDIR_BIN + '/' + PYTHON_X_Y + with open(target, 'w') as f: + f.write(text) + shutil.copymode(PYTHON_BIN + '/' + PYTHON_X_Y, target) + + + # Set a hook in Python for cleaning the path detection + log('HOOK', '%s site packages', PYTHON_X_Y) + + sitepkgs = PYTHON_PKG + '/site-packages' + make_tree(sitepkgs) + copy_file(PREFIX + '/data/sitecustomize.py', sitepkgs) + + + # Set RPATHs and bundle external libraries + log('LINK', '%s C-extensions', PYTHON_X_Y) + + make_tree(APPDIR_LIB) + patch_binary(PYTHON_BIN + '/' + PYTHON_X_Y, APPDIR_LIB, recursive=False) + for root, dirs, files in os.walk(PYTHON_PKG + '/lib-dynload'): + for file_ in files: + if not file_.endswith('.so'): + continue + patch_binary(os.path.join(root, file_), APPDIR_LIB, recursive=False) + + for file_ in glob.iglob(APPDIR_LIB + '/lib*.so*'): + patch_binary(file_, APPDIR_LIB, recursive=True) + + + # Copy shared data for TCl/Tk + tkinter = glob.glob(PYTHON_PKG + '/lib-dynload/_tkinter*.so') + if tkinter: + tkinter = tkinter[0] + for dep in ldd(tkinter): + name = os.path.basename(dep) + if name.startswith('libtk'): + match = re.search('libtk([0-9]+[.][0-9]+)', name) + tk_version = match.group(1) + break + else: + raise RuntimeError('could not guess Tcl/Tk version') + + tcltkdir = APPDIR_SHARE + '/tcltk' + if (not os.path.exists(tcltkdir + '/tcl' + tk_version)) or \ + (not os.path.exists(tcltkdir + '/tk' + tk_version)): + hostdir = '/usr/share/tcltk' + if os.path.exists(hostdir): + make_tree(APPDIR_SHARE) + copy_tree(hostdir, tcltkdir) + else: + make_tree(tcltkdir) + tclpath = '/usr/share/tcl' + tk_version + if not tclpath: + raise ValueError('could not find ' + tclpath) + copy_tree(tclpath, tcltkdir + '/tcl' + tk_version) + + tkpath = '/usr/share/tk' + tk_version + if not tkpath: + raise ValueError('could not find ' + tkpath) + copy_tree(tkpath, tcltkdir + '/tk' + tk_version) + + + # Bundle the entry point + apprun = APPDIR + '/AppRun' + if not os.path.exists(apprun): + log('INSTALL', 'AppRun') + _copy_template('apprun.sh', apprun, version=VERSION) + + + # Bundle the desktop file + desktop_name = 'python{:}.desktop'.format(FULLVERSION) + desktop = os.path.join(APPDIR, desktop_name) + if not os.path.exists(desktop): + log('INSTALL', desktop_name) + apps = 'usr/share/applications' + appfile = '{:}/{:}/python{:}.desktop'.format(APPDIR, apps, FULLVERSION) + if not os.path.exists(appfile): + make_tree(os.path.join(APPDIR, apps)) + _copy_template('python.desktop', appfile, version=VERSION, + fullversion=FULLVERSION) + os.symlink(os.path.join(apps, desktop_name), desktop) + + + # Bundle icons + icons = 'usr/share/icons/hicolor/256x256/apps' + icon = os.path.join(APPDIR, 'python.png') + if not os.path.exists(icon): + log('INSTALL', 'python.png') + make_tree(os.path.join(APPDIR, icons)) + copy_file(PREFIX + '/data/python.png', + os.path.join(APPDIR, icons, 'python.png')) + os.symlink(os.path.join(icons, 'python.png'), icon) + + diricon = os.path.join(APPDIR, '.DirIcon') + if not os.path.exists(diricon): + os.symlink('python.png', diricon) + + + # Bundle metadata + meta_name = 'python{:}.appdata.xml'.format(FULLVERSION) + meta_dir = os.path.join(APPDIR, 'usr/share/metainfo') + meta_file = os.path.join(meta_dir, meta_name) + if not os.path.exists(meta_file): + log('INSTALL', meta_name) + make_tree(meta_dir) + _copy_template('python.appdata.xml', meta_file, version=VERSION, + fullversion=FULLVERSION) diff --git a/python_appimage/system.py b/python_appimage/system.py new file mode 100644 index 0000000..8b6cbb2 --- /dev/null +++ b/python_appimage/system.py @@ -0,0 +1,46 @@ +import os +import re +import subprocess + +from .log import debug + + +__all__ = ['ldd', 'system'] + + +def _decode(s): + '''Decode Python 3 bytes as str + ''' + try: + return s.decode() + except AttributeError: + return s + + +def system(*args): + '''System call with capturing output + ''' + cmd = ' '.join(args) + debug('SYSTEM', cmd) + + p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + out, err = p.communicate() + if err: + err = _decode(err) + stripped = [line for line in err.split(os.linesep) + if line and not line.startswith('fuse: warning:')] + if stripped: + raise RuntimeError(err) + + return str(_decode(out).strip()) + + +_ldd_pattern = re.compile('=> (.+) [(]0x') + + +def ldd(path): + '''Get dependencies list of dynamic libraries + ''' + out = system('ldd', path) + return _ldd_pattern.findall(out) diff --git a/python_appimage/tmp.py b/python_appimage/tmp.py new file mode 100644 index 0000000..842b3c8 --- /dev/null +++ b/python_appimage/tmp.py @@ -0,0 +1,24 @@ +from contextlib import contextmanager as contextmanager +import os +import tempfile + +from .fs import remove_tree +from .log import debug + + +__all__ = ['TemporaryDirectory'] + + +@contextmanager +def TemporaryDirectory(): + '''Create a temporary directory (Python 2 wrapper) + ''' + tmpdir = tempfile.mkdtemp(prefix='python-appimage-') + debug('MKDIR', tmpdir) + pwd = os.getcwd() + os.chdir(tmpdir) + try: + yield tmpdir + finally: + os.chdir(pwd) + remove_tree(tmpdir) diff --git a/python_appimage/url.py b/python_appimage/url.py new file mode 100644 index 0000000..59c3cf7 --- /dev/null +++ b/python_appimage/url.py @@ -0,0 +1,28 @@ +import os +try: + from urllib.request import urlretrieve as _urlretrieve +except ImportError: + import urllib2 + _urlretrieve = None + +from .log import debug + + +__all__ = ['urlretrieve'] + + +def urlretrieve(url, filename=None): + '''Download a file to disk + ''' + if filename is None: + filename = os.path.basename(url) + debug('DOWNLOAD', '%s from %s', name, os.path.dirname(url)) + else: + debug('DOWNLOAD', '%s as %s', url, filename) + + if _urlretrieve is None: + data = urllib2.urlopen(url).read() + with open(filename, 'w') as f: + f.write(data) + else: + _urlretrieve(url, filename)