diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /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 +. \ No newline at end of file diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..825415e --- /dev/null +++ b/Pipfile @@ -0,0 +1,13 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +build="*" +twine="*" + +[dev-packages] + +[requires] +python_version = "3.8" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..58d0bd0 --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,322 @@ +{ + "_meta": { + "hash": { + "sha256": "ffaa085c348b73257669751abb931bab84cb99c971d0b73b2fea68c21e9dcfbc" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.8" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "bleach": { + "hashes": [ + "sha256:0900d8b37eba61a802ee40ac0061f8c2b5dee29c1927dd1d233e075ebf5a71da", + "sha256:4d2651ab93271d1129ac9cbc679f524565cc8a1b791909c4a51eac4446a15994" + ], + "markers": "python_version >= '3.6'", + "version": "==4.1.0" + }, + "build": { + "hashes": [ + "sha256:1aaadcd69338252ade4f7ec1265e1a19184bf916d84c9b7df095f423948cb89f", + "sha256:21b7ebbd1b22499c4dac536abc7606696ea4d909fd755e00f09f3c0f2c05e3c8" + ], + "index": "pypi", + "version": "==0.7.0" + }, + "certifi": { + "hashes": [ + "sha256:78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872", + "sha256:d62a0163eb4c2344ac042ab2bdf75399a71a2d8c7d47eac2e2ee91b9d6339569" + ], + "version": "==2021.10.8" + }, + "cffi": { + "hashes": [ + "sha256:06c54a68935738d206570b20da5ef2b6b6d92b38ef3ec45c5422c0ebaf338d4d", + "sha256:0c0591bee64e438883b0c92a7bed78f6290d40bf02e54c5bf0978eaf36061771", + "sha256:19ca0dbdeda3b2615421d54bef8985f72af6e0c47082a8d26122adac81a95872", + "sha256:22b9c3c320171c108e903d61a3723b51e37aaa8c81255b5e7ce102775bd01e2c", + "sha256:26bb2549b72708c833f5abe62b756176022a7b9a7f689b571e74c8478ead51dc", + "sha256:33791e8a2dc2953f28b8d8d300dde42dd929ac28f974c4b4c6272cb2955cb762", + "sha256:3c8d896becff2fa653dc4438b54a5a25a971d1f4110b32bd3068db3722c80202", + "sha256:4373612d59c404baeb7cbd788a18b2b2a8331abcc84c3ba40051fcd18b17a4d5", + "sha256:487d63e1454627c8e47dd230025780e91869cfba4c753a74fda196a1f6ad6548", + "sha256:48916e459c54c4a70e52745639f1db524542140433599e13911b2f329834276a", + "sha256:4922cd707b25e623b902c86188aca466d3620892db76c0bdd7b99a3d5e61d35f", + "sha256:55af55e32ae468e9946f741a5d51f9896da6b9bf0bbdd326843fec05c730eb20", + "sha256:57e555a9feb4a8460415f1aac331a2dc833b1115284f7ded7278b54afc5bd218", + "sha256:5d4b68e216fc65e9fe4f524c177b54964af043dde734807586cf5435af84045c", + "sha256:64fda793737bc4037521d4899be780534b9aea552eb673b9833b01f945904c2e", + "sha256:6d6169cb3c6c2ad50db5b868db6491a790300ade1ed5d1da29289d73bbe40b56", + "sha256:7bcac9a2b4fdbed2c16fa5681356d7121ecabf041f18d97ed5b8e0dd38a80224", + "sha256:80b06212075346b5546b0417b9f2bf467fea3bfe7352f781ffc05a8ab24ba14a", + "sha256:818014c754cd3dba7229c0f5884396264d51ffb87ec86e927ef0be140bfdb0d2", + "sha256:8eb687582ed7cd8c4bdbff3df6c0da443eb89c3c72e6e5dcdd9c81729712791a", + "sha256:99f27fefe34c37ba9875f224a8f36e31d744d8083e00f520f133cab79ad5e819", + "sha256:9f3e33c28cd39d1b655ed1ba7247133b6f7fc16fa16887b120c0c670e35ce346", + "sha256:a8661b2ce9694ca01c529bfa204dbb144b275a31685a075ce123f12331be790b", + "sha256:a9da7010cec5a12193d1af9872a00888f396aba3dc79186604a09ea3ee7c029e", + "sha256:aedb15f0a5a5949ecb129a82b72b19df97bbbca024081ed2ef88bd5c0a610534", + "sha256:b315d709717a99f4b27b59b021e6207c64620790ca3e0bde636a6c7f14618abb", + "sha256:ba6f2b3f452e150945d58f4badd92310449876c4c954836cfb1803bdd7b422f0", + "sha256:c33d18eb6e6bc36f09d793c0dc58b0211fccc6ae5149b808da4a62660678b156", + "sha256:c9a875ce9d7fe32887784274dd533c57909b7b1dcadcc128a2ac21331a9765dd", + "sha256:c9e005e9bd57bc987764c32a1bee4364c44fdc11a3cc20a40b93b444984f2b87", + "sha256:d2ad4d668a5c0645d281dcd17aff2be3212bc109b33814bbb15c4939f44181cc", + "sha256:d950695ae4381ecd856bcaf2b1e866720e4ab9a1498cba61c602e56630ca7195", + "sha256:e22dcb48709fc51a7b58a927391b23ab37eb3737a98ac4338e2448bef8559b33", + "sha256:e8c6a99be100371dbb046880e7a282152aa5d6127ae01783e37662ef73850d8f", + "sha256:e9dc245e3ac69c92ee4c167fbdd7428ec1956d4e754223124991ef29eb57a09d", + "sha256:eb687a11f0a7a1839719edd80f41e459cc5366857ecbed383ff376c4e3cc6afd", + "sha256:eb9e2a346c5238a30a746893f23a9535e700f8192a68c07c0258e7ece6ff3728", + "sha256:ed38b924ce794e505647f7c331b22a693bee1538fdf46b0222c4717b42f744e7", + "sha256:f0010c6f9d1a4011e429109fda55a225921e3206e7f62a0c22a35344bfd13cca", + "sha256:f0c5d1acbfca6ebdd6b1e3eded8d261affb6ddcf2186205518f1428b8569bb99", + "sha256:f10afb1004f102c7868ebfe91c28f4a712227fe4cb24974350ace1f90e1febbf", + "sha256:f174135f5609428cc6e1b9090f9268f5c8935fddb1b25ccb8255a2d50de6789e", + "sha256:f3ebe6e73c319340830a9b2825d32eb6d8475c1dac020b4f0aa774ee3b898d1c", + "sha256:f627688813d0a4140153ff532537fbe4afea5a3dffce1f9deb7f91f848a832b5", + "sha256:fd4305f86f53dfd8cd3522269ed7fc34856a8ee3709a5e28b2836b2db9d4cd69" + ], + "version": "==1.14.6" + }, + "charset-normalizer": { + "hashes": [ + "sha256:e019de665e2bcf9c2b64e2e5aa025fa991da8720daa3c1138cadd2fd1856aed0", + "sha256:f7af805c321bfa1ce6714c51f254e0d5bb5e5834039bc17db7ebe3a4cec9492b" + ], + "markers": "python_version >= '3'", + "version": "==2.0.7" + }, + "click": { + "hashes": [ + "sha256:353f466495adaeb40b6b5f592f9f91cb22372351c84caeb068132442a4518ef3", + "sha256:410e932b050f5eed773c4cda94de75971c89cdb3155a72a0831139a79e5ecb5b" + ], + "index": "pypi", + "version": "==8.0.3" + }, + "colorama": { + "hashes": [ + "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b", + "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", + "version": "==0.4.4" + }, + "cryptography": { + "hashes": [ + "sha256:07bb7fbfb5de0980590ddfc7f13081520def06dc9ed214000ad4372fb4e3c7f6", + "sha256:18d90f4711bf63e2fb21e8c8e51ed8189438e6b35a6d996201ebd98a26abbbe6", + "sha256:1ed82abf16df40a60942a8c211251ae72858b25b7421ce2497c2eb7a1cee817c", + "sha256:22a38e96118a4ce3b97509443feace1d1011d0571fae81fc3ad35f25ba3ea999", + "sha256:2d69645f535f4b2c722cfb07a8eab916265545b3475fdb34e0be2f4ee8b0b15e", + "sha256:4a2d0e0acc20ede0f06ef7aa58546eee96d2592c00f450c9acb89c5879b61992", + "sha256:54b2605e5475944e2213258e0ab8696f4f357a31371e538ef21e8d61c843c28d", + "sha256:7075b304cd567694dc692ffc9747f3e9cb393cc4aa4fb7b9f3abd6f5c4e43588", + "sha256:7b7ceeff114c31f285528ba8b390d3e9cfa2da17b56f11d366769a807f17cbaa", + "sha256:7eba2cebca600a7806b893cb1d541a6e910afa87e97acf2021a22b32da1df52d", + "sha256:928185a6d1ccdb816e883f56ebe92e975a262d31cc536429041921f8cb5a62fd", + "sha256:9933f28f70d0517686bd7de36166dda42094eac49415459d9bdf5e7df3e0086d", + "sha256:a688ebcd08250eab5bb5bca318cc05a8c66de5e4171a65ca51db6bd753ff8953", + "sha256:abb5a361d2585bb95012a19ed9b2c8f412c5d723a9836418fab7aaa0243e67d2", + "sha256:c10c797ac89c746e488d2ee92bd4abd593615694ee17b2500578b63cad6b93a8", + "sha256:ced40344e811d6abba00295ced98c01aecf0c2de39481792d87af4fa58b7b4d6", + "sha256:d57e0cdc1b44b6cdf8af1d01807db06886f10177469312fbde8f44ccbb284bc9", + "sha256:d99915d6ab265c22873f1b4d6ea5ef462ef797b4140be4c9d8b179915e0985c6", + "sha256:eb80e8a1f91e4b7ef8b33041591e6d89b2b8e122d787e87eeb2b08da71bb16ad", + "sha256:ebeddd119f526bcf323a89f853afb12e225902a24d29b55fe18dd6fcb2838a76" + ], + "markers": "python_version >= '3.6'", + "version": "==35.0.0" + }, + "docutils": { + "hashes": [ + "sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125", + "sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", + "version": "==0.17.1" + }, + "idna": { + "hashes": [ + "sha256:14475042e284991034cb48e06f6851428fb14c4dc953acd9be9a5e95c7b6dd7a", + "sha256:467fbad99067910785144ce333826c71fb0e63a425657295239737f7ecd125f3" + ], + "markers": "python_version >= '3'", + "version": "==3.2" + }, + "importlib-metadata": { + "hashes": [ + "sha256:b618b6d2d5ffa2f16add5697cf57a46c76a56229b0ed1c438322e4e95645bd15", + "sha256:f284b3e11256ad1e5d03ab86bb2ccd6f5339688ff17a4d797a0fe7df326f23b1" + ], + "markers": "python_version >= '3.6'", + "version": "==4.8.1" + }, + "jeepney": { + "hashes": [ + "sha256:1b5a0ea5c0e7b166b2f5895b91a08c14de8915afda4407fb5022a195224958ac", + "sha256:fa9e232dfa0c498bd0b8a3a73b8d8a31978304dcef0515adc859d4e096f96f4f" + ], + "markers": "sys_platform == 'linux'", + "version": "==0.7.1" + }, + "keyring": { + "hashes": [ + "sha256:6334aee6073db2fb1f30892697b1730105b5e9a77ce7e61fca6b435225493efe", + "sha256:bd2145a237ed70c8ce72978b497619ddfcae640b6dcf494402d5143e37755c6e" + ], + "markers": "python_version >= '3.6'", + "version": "==23.2.1" + }, + "packaging": { + "hashes": [ + "sha256:7dc96269f53a4ccec5c0670940a4281106dd0bb343f47b7471f779df49c2fbe7", + "sha256:c86254f9220d55e31cc94d69bade760f0847da8000def4dfe1c6b872fd14ff14" + ], + "markers": "python_version >= '3.6'", + "version": "==21.0" + }, + "pep517": { + "hashes": [ + "sha256:3fa6b85b9def7ba4de99fb7f96fe3f02e2d630df8aa2720a5cf3b183f087a738", + "sha256:e1ba5dffa3a131387979a68ff3e391ac7d645be409216b961bc2efe6468ab0b2" + ], + "version": "==0.11.0" + }, + "pkginfo": { + "hashes": [ + "sha256:37ecd857b47e5f55949c41ed061eb51a0bee97a87c969219d144c0e023982779", + "sha256:e7432f81d08adec7297633191bbf0bd47faf13cd8724c3a13250e51d542635bd" + ], + "version": "==1.7.1" + }, + "pycparser": { + "hashes": [ + "sha256:2d475327684562c3a96cc71adf7dc8c4f0565175cf86b6d7a404ff4c771f15f0", + "sha256:7582ad22678f0fcd81102833f60ef8d0e57288b6b5fb00323d101be910e35705" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==2.20" + }, + "pygments": { + "hashes": [ + "sha256:b8e67fe6af78f492b3c4b3e2970c0624cbf08beb1e493b2c99b9fa1b67a20380", + "sha256:f398865f7eb6874156579fdf36bc840a03cab64d1cde9e93d68f46a425ec52c6" + ], + "markers": "python_version >= '3.5'", + "version": "==2.10.0" + }, + "pyparsing": { + "hashes": [ + "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1", + "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b" + ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==2.4.7" + }, + "readme-renderer": { + "hashes": [ + "sha256:3286806450d9961d6e3b5f8a59f77e61503799aca5155c8d8d40359b4e1e1adc", + "sha256:8299700d7a910c304072a7601eafada6712a5b011a20139417e1b1e9f04645d8" + ], + "version": "==30.0" + }, + "requests": { + "hashes": [ + "sha256:6c1246513ecd5ecd4528a0906f910e8f0f9c6b8ec72030dc9fd154dc1a6efd24", + "sha256:b8aa58f8cf793ffd8782d3d8cb19e66ef36f7aba4353eec859e74678b01b07a7" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", + "version": "==2.26.0" + }, + "requests-toolbelt": { + "hashes": [ + "sha256:380606e1d10dc85c3bd47bf5a6095f815ec007be7a8b69c878507068df059e6f", + "sha256:968089d4584ad4ad7c171454f0a5c6dac23971e9472521ea3b6d49d610aa6fc0" + ], + "version": "==0.9.1" + }, + "rfc3986": { + "hashes": [ + "sha256:270aaf10d87d0d4e095063c65bf3ddbc6ee3d0b226328ce21e036f946e421835", + "sha256:a86d6e1f5b1dc238b218b012df0aa79409667bb209e58da56d0b94704e712a97" + ], + "version": "==1.5.0" + }, + "secretstorage": { + "hashes": [ + "sha256:422d82c36172d88d6a0ed5afdec956514b189ddbfb72fefab0c8a1cee4eaf71f", + "sha256:fd666c51a6bf200643495a04abb261f83229dcb6fd8472ec393df7ffc8b6f195" + ], + "markers": "sys_platform == 'linux'", + "version": "==3.3.1" + }, + "six": { + "hashes": [ + "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", + "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.16.0" + }, + "tomli": { + "hashes": [ + "sha256:8dd0e9524d6f386271a36b41dbf6c57d8e32fd96fd22b6584679dc569d20899f", + "sha256:a5b75cb6f3968abb47af1b40c1819dc519ea82bcc065776a866e8d74c5ca9442" + ], + "markers": "python_version >= '3.6'", + "version": "==1.2.1" + }, + "tqdm": { + "hashes": [ + "sha256:8dd278a422499cd6b727e6ae4061c40b48fce8b76d1ccbf5d34fca9b7f925b0c", + "sha256:d359de7217506c9851b7869f3708d8ee53ed70a1b8edbba4dbcb47442592920d" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==4.62.3" + }, + "twine": { + "hashes": [ + "sha256:087328e9bb405e7ce18527a2dca4042a84c7918658f951110b38bc135acab218", + "sha256:4caec0f1ed78dc4c9b83ad537e453d03ce485725f2aea57f1bb3fdde78dae936" + ], + "index": "pypi", + "version": "==3.4.2" + }, + "urllib3": { + "hashes": [ + "sha256:4987c65554f7a2dbf30c18fd48778ef124af6fab771a377103da0585e2336ece", + "sha256:c4fdf4019605b6e5423637e01bc9fe4daef873709a7973e195ceba0a62bbc844" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'", + "version": "==1.26.7" + }, + "webencodings": { + "hashes": [ + "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78", + "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923" + ], + "version": "==0.5.1" + }, + "zipp": { + "hashes": [ + "sha256:71c644c5369f4a6e07636f0aa966270449561fcea2e3d6747b8d23efaa9d7832", + "sha256:9fe5ea21568a0a70e50f273397638d39b03353731e6cbbb3fd8502a33fec40bc" + ], + "markers": "python_version >= '3.6'", + "version": "==3.6.0" + } + }, + "develop": {} +} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..b5a3c46 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=42", + "wheel" +] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..e8afe96 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,34 @@ +[metadata] +name = viur_cli +version = 0.2.0 +author = Andreas H. Kelch +author_email = ak@mausbrand.de +description = A CLI to do everyday tasks +long_description = file: README.md +long_description_content_type = text/markdown +# url = https://github.com/pypa/sampleproject +# project_urls = +# Bug Tracker = https://github.com/pypa/sampleproject/issues +classifiers = + Programming Language :: Python :: 3 + Operating System :: OS Independent + +[options] +package_dir = + = src +packages = find: +python_requires = >=3.7 +install_requires = + watchgod==0.7 + python-minifier==2.4.2 + app_server==0.7 + click + +[options.packages.find] +where = src + +[options.entry_points] +console_scripts = + viur-cli = viur_cli:cli + flare = viur_cli.flare:main + get-pyodide = viur_cli.get_pyodide:main \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..c1057cf --- /dev/null +++ b/setup.py @@ -0,0 +1,3 @@ +import setuptools + +setuptools.setup() \ No newline at end of file diff --git a/src/viur_cli/__init__.py b/src/viur_cli/__init__.py new file mode 100644 index 0000000..d5ab9fb --- /dev/null +++ b/src/viur_cli/__init__.py @@ -0,0 +1,212 @@ +import os, click, json + +projectConfig = None +projectConfigFilePath = "./project.json" + + +def echoError(msg): + click.echo(click.style(msg, fg="red")) + +def echoInfo(msg): + click.echo(click.style(msg, fg="cyan")) + +def loadConfig(): + global projectConfig + + try: + f = open(projectConfigFilePath, "r") + projectConfig = json.loads(f.read()) + except: + echoError("no project.json found") + + return projectConfig + +def writeConfig(conf): + global projectConfig + + projectConfig = conf + + f = open(projectConfigFilePath, "w") + f.write(json.dumps(conf, indent=4, sort_keys=True)) + f.close() + +def addToConfig(): + global projectConfig + if not projectConfig: + return + + projectConfig.update({click.prompt('name'): { + "application_name": click.prompt('application name'), + "version": click.prompt('develop version name') + }}) + + writeConfig(projectConfig) + +def removeFromConfig(): + global projectConfig + configname = click.prompt('name') + try: + del projectConfig[configname] + writeConfig(projectConfig) + except: + raise click.ClickException(click.style(f"{configname} not found", fg="red")) + +def addToFlareConfig(projectconf): + if "default" not in projectconf: + raise click.ClickException(click.style("default entry is missing", fg="red")) + + if not "flare" in projectconf["default"]: + projectconf["default"].update({"flare": {}}) + + projectconf["default"]["flare"].update({ + click.prompt('name'): { + "source": click.prompt('source'), + "target": click.prompt('target') + } + }) + + return projectconf + +def removeFromFlareConfig(flareAppName): + global projectConfig + try: + del projectConfig["default"]["flare"][flareAppName] + writeConfig(projectConfig) + except: + raise click.ClickException(click.style(f"{flareAppName} not found", fg="red")) + +def createNewProject(projectName): pass + + +def createNewConfig(): + _projectconf = { + "default": { + "distribution_folder": click.prompt('distribution folder', default="./deploy"), + "sources_folder": click.prompt('sources folder', default="./sources"), + "flare": {} + }, + + "develop": { + "application_name": click.prompt('application name'), + "version": click.prompt('develop version name') + } + } + + if click.confirm("Do you want to configure a flare application?"): + _projectconf = addToFlareConfig(_projectconf) + + writeConfig(_projectconf) + + +@click.group(invoke_without_command=True) +def cli(): + """prints info""" + click.echo("Welcome to ViUR-CLI") + loadConfig() + global projectConfig + +@cli.command() +def init(): + """initialize project.json""" + global projectConfig + try: + f = open(projectConfigFilePath) + if click.confirm("project.json already exists, do you want to delete it?"): + os.remove(projectConfigFilePath) + except: + + if not projectConfig: + if click.confirm("Do you want to create a new project.json file?"): + createNewConfig() + +@cli.command() +@click.argument("action", type=click.Choice(['add', 'remove', "info"])) +def config(action): + """manage project.json and generate if missing""" + global projectConfig + if action == "add": + addToConfig() + elif action == "remove": + removeFromConfig() + elif action == "info": + click.echo(click.style(json.dumps(projectConfig, indent=4, sort_keys=True), fg="cyan")) + +@cli.command(context_settings={"ignore_unknown_options": True}) +@click.argument("name") +@click.argument("additional_args", nargs=-1) +def deploy(name,additional_args): + """deploy your application""" + global projectConfig + if name not in projectConfig: + echoError(f"{name} is not a vadid config name.") + return + + conf = projectConfig["default"].copy() + conf.update(projectConfig[name]) + + os.system(f'gcloud app deploy --project={conf["application_name"]} --version={conf["version"]} --no-promote {" ".join(additional_args)} {conf["distribution_folder"]}') + +@cli.command(context_settings={"ignore_unknown_options": True}) +@click.argument("name") +@click.argument("additional_args", nargs=-1) +def index(name,additional_args): + """update your application index""" + global projectConfig + if name not in projectConfig: + echoError(f"{name} is not a vadid config name.") + return + + conf = projectConfig["default"].copy() + conf.update(projectConfig[name]) + + os.system( + f'gcloud app deploy --project={conf["application_name"]} {" ".join(additional_args)} {conf["distribution_folder"]}/index.yaml') + +@cli.command(context_settings={"ignore_unknown_options": True}) +@click.argument("name", default='develop') +@click.argument("additional_args", nargs=-1) +def run(name, additional_args): + """start your application locally""" + global projectConfig + if name not in projectConfig: + echoError(f"{name} is not a vadid config name.") + return + + conf = projectConfig["default"].copy() + conf.update(projectConfig[name]) + + os.system(f'app_server -A={conf["application_name"]} {conf["distribution_folder"]} {" ".join(additional_args)}') + +@cli.command(context_settings={"ignore_unknown_options": True}) +@click.argument("name") +@click.argument("action") +@click.argument("additional_args", nargs=-1) +def flare(action,name,additional_args): + """build or watch a flare fontend""" + additional_args = list(additional_args) + + if action =="release": + additional_args = ["-mzc"] + elif action =="debug": + pass + elif action =="watch": + additional_args = ["-w"] + + global projectConfig + + if name not in projectConfig["default"]["flare"]: + echoError(f"{name} is not a vadid flare app name.") + return + + conf = projectConfig["default"].copy() + + os.system(f'flare -n={name} -s={conf["flare"][name]["source"]} -t={conf["flare"][name]["target"]} {" ".join(additional_args)}') + +@cli.command() +def check(): + """check environment""" + pass + +@cli.command() +def create(): + """create a new viur project, > in addition it runs config, flare config and check""" \ No newline at end of file diff --git a/src/viur_cli/flare.py b/src/viur_cli/flare.py new file mode 100644 index 0000000..499513a --- /dev/null +++ b/src/viur_cli/flare.py @@ -0,0 +1,298 @@ +#!/usr/bin/env python3 +""" +flare application packager and build tool +""" + +import os, shutil, json, argparse, pathlib + +PATHBLACKLIST = ["assets", "docs", "examples", "test", "tools"] + + +def cleanString(str): + """Replace characters from string which could brake the commands. + actual used to clean the environment workspace variable + """ + return str.replace('"', "").replace("'", "") + + +def copySourcePy(source, target): + """Copy python source files to destination respecting the folder structure.""" + cwd = os.getcwd() + os.chdir(os.path.join(cwd, source)) + absTarget = os.path.join(cwd, target) + + os.system(f'find "." -name "*.py" -exec rsync -Rq \\{{\\}} "{absTarget}" \;') + os.chdir(cwd) + + cleanSources(target) + copyflareAssets(source, target) + copypackageAssets(source, target) + + +def cleanSources(target): + cwd = os.getcwd() + absTarget = os.path.join(cwd, target) + + for folder in ["bin", "docs", "examples", "scripts", "test"]: + target = os.path.join(absTarget, "flare", folder) + os.system(f"rm -rf {target}") + + +def minifyPy(target): + """Minifies oll py files and strips comments and documentation.""" + os.system( + f'for py in `find {target} -name "*.py"`; do echo "Minifying ${{py}}..."; pyminify --remove-literal-statements ${{py}} > ${{py}}.min; mv ${{py}}.min ${{py}}; done' + ) + + +def compilePy(target): + """Compiles py files to pyc and removes all py files at the end.""" + import compileall + + compileall.compile_dir(target, force=True, legacy=True) + os.system(f'find "{target}" -name "*.py" -type f -delete') + + +def movingFlareBeforeZip(target, packagename): + """If we deliver this app as zip and a flare submodule exists move it to the root directory.""" + cwd = os.getcwd() + flareFolder = os.path.join(cwd, packagename, "flare") + if os.path.exists(flareFolder): + os.rename(flareFolder, flareFolder + "_") + shutil.copytree( + os.path.join(flareFolder + "_", "flare"), os.path.join(cwd, "flare") + ) + shutil.rmtree(flareFolder + "_") + + +def movingPackagesBeforeZip(target, packagename): + """If we deliver this app as zip and all files of the packages foldermusst be moved to the root directory.""" + cwd = os.getcwd() + packagesFolder = os.path.join(cwd, packagename, "packages") + if os.path.exists(packagesFolder): + shutil.copytree(packagesFolder, cwd, dirs_exist_ok=True) + shutil.rmtree(packagesFolder) + + +def zipPy(target, packagename): + """Zips all files in target folder.""" + cwd = os.getcwd() + targetpath = os.path.join(cwd, target) + packagepath = os.path.join(targetpath, packagename) + + if not os.path.exists(packagepath): + os.makedirs(packagepath) + + os.system( + f'find {targetpath} -maxdepth 1 -not -name {packagename} -exec mv \\{{\\}} "{packagepath}" \;' + ) + + os.chdir(targetpath) # switch to root folder + + movingFlareBeforeZip(target, packagename) + movingPackagesBeforeZip(target, packagename) + os.system("rm -f files.zip") # remove old zip if exists + os.system(f"zip files.zip -r ./*") # zip this folder + + # remove everything thats not files.zip + _ = [ + os.system(f"rm -rf {i}") + for i in os.listdir(os.path.join(cwd, target)) + if i != "files.zip" + ] + + os.chdir(cwd) # switch back + + +def copyAssets(source, target): + """Copy assets to targetfolder. + if flare exists copy assets first, so that they can be replaced by project + """ + flarefolder = os.path.join(source, "flare", "assets") + if os.path.exists(flarefolder): + shutil.copytree( + flarefolder, os.path.join(target, "public", "flare"), dirs_exist_ok=True + ) + + assetfolder = os.path.join(source, "public") + if os.path.exists(assetfolder): + shutil.copytree(assetfolder, os.path.join(target, "public"), dirs_exist_ok=True) + + toplevelFiles = (".html", ".js", ".webmanifest", ".json") + + _ = [ + shutil.copyfile(os.path.join(source, i), os.path.join(target, i)) + for i in os.listdir(source) + if i.endswith(toplevelFiles) + ] + + +def copyflareAssets(source, target): + flarefolder = os.path.join(source, "flare") + if os.path.exists(flarefolder): + shutil.copy( + os.path.join(flarefolder, "flare", "files.json"), + os.path.join(target, "flare", "flare", "files.json"), + ) + +def copyWebworkerScripts(source, target): + flarefolder = os.path.join( source, "flare", "flare", "webworker") + if os.path.exists( flarefolder ): + shutil.copytree( + flarefolder, os.path.join( target, "webworker" ), dirs_exist_ok = True + ) + + appfolder = os.path.join(source, "webworker") + if os.path.exists( appfolder ): + shutil.copytree( + appfolder, os.path.join( target, "webworker" ), dirs_exist_ok = True + ) + + + +def copypackageAssets(source, target): + packagesFolder = os.path.join(source, "packages") + if os.path.exists(packagesFolder): + shutil.copy( + os.path.join(packagesFolder, "files.json"), + os.path.join(target, "packages", "files.json"), + ) + + +def clearTarget(target): + """Clear target folder.""" + if not os.path.exists(target): + os.makedirs(target) + os.system(f"rm -rf {target}/*") + + +def generateFilesJson(source): + """Walks over the source app directory hierarchy and collects all _wanted_ and _needed_ python files. + This should work for all of Linux, MacOS and Windows and uses posix compliant path structure. + """ + files = [] + + walkObj = os.walk(source) + for root, dirnames, filenames in walkObj: + for f in filenames: + pathObject = pathlib.Path(root).joinpath(f) + pathParts = pathObject.parts + if ( + f.endswith(".py") + and "(" not in f + and not any([f.startswith(i) for i in ["get-", "gen-", "test-"]]) # this might be unnecessary... + and not any([p in PATHBLACKLIST for p in pathParts]) # ignore folders from blacklist + ): + f = pathObject.as_posix().rstrip("./") + #print(f) + files.append(f) + + with open("files.json", "w") as outputFile: + json.dump(sorted(files), outputFile, indent=2) + print("", file=outputFile) # append line break + + +def main(): + # parse command-line arguments + ap = argparse.ArgumentParser( + description="Flare application packager and build tool" + ) + + ap.add_argument("-s", "--source", required=True, type=pathlib.Path, + help="Path to source folder of the flare application") + ap.add_argument("-t", "--target", required=True, type=pathlib.Path, + help="Path to output folder of the packaged flare application") + + ap.add_argument("-n", "--name", type=str, help="Name of the target package", default="app") + ap.add_argument("-m", "--minify", help="Minify source by removing docstrings", action="store_true", default=False) + ap.add_argument("-c", "--compile", help="Compile into pre-compiled .PYC-files", action="store_true", default=False) + ap.add_argument("-z", "--zip", help="Create zipped package to decreased number of download requests", + action="store_true", default=False) + ap.add_argument("-w", "--watch", help="Run in watch mode, re-compile target on any changes in source", + action="store_true", default=False) + + args = ap.parse_args() + + if args.source == args.target: + raise ValueError("You may not set source and target to the same directories") + + if args.watch: + print("starting initial build") + + os.chdir(cleanString(os.environ.get("PROJECT_WORKSPACE", "."))) + + clearTarget(args.target) + copySourcePy(args.source, args.target) + + if args.minify: + minifyPy(args.target) + + if args.compile: + compilePy(args.target) + + if args.zip: + zipPy(args.target, args.name) + + copyWebworkerScripts(args.source, args.target) + if args.minify: + minifyPy(os.path.join(args.target,"webworker")) + #if args.compile: + # compilePy(os.path.join(args.target,"webworker")) + + copyAssets(args.source, args.target) + + if args.watch: + print("watching for changes...") + + from watchgod import watch, PythonWatcher + from watchgod.watcher import Change + + for changes in watch(args.source, watcher_cls=PythonWatcher): + changes = list(changes) + + # dont copy py files from blacklisted folders + if any(map(changes[0][1].__contains__, [f"/{p}/" for p in PATHBLACKLIST])): + continue + + recreateFilesJson = False + + if changes[0][0] == Change.added: + print(f"{changes[0][1]} added") + recreateFilesJson = True + elif changes[0][0] == Change.deleted: + print(f"{changes[0][1]} deleted") + recreateFilesJson = True + else: + print(f"{changes[0][1]} modified") + + if recreateFilesJson: + print("regenerating files.json") + generateFilesJson(args.source) + + filepath = changes[0][1].replace(str(args.source) + "/", "") + + if not args.zip: + if changes[0][0] == Change.deleted: + os.remove(os.path.join(args.target, filepath)) + else: + # copy changed or added file + shutil.copy(changes[0][1], os.path.join(args.target, filepath)) + + if recreateFilesJson: + shutil.copy(os.path.join(args.source, "files.json"), os.path.join(args.target, "files.json")) + + else: + clearTarget(args.target) + copySourcePy(args.source, args.target) + + if args.minify: + minifyPy(args.target) + + if args.compile: + compilePy(args.target) + + if args.zip: + zipPy(args.target, args.name) + copyAssets(args.source, args.target) + + diff --git a/src/viur_cli/get_pyodide.py b/src/viur_cli/get_pyodide.py new file mode 100644 index 0000000..86e0ab1 --- /dev/null +++ b/src/viur_cli/get_pyodide.py @@ -0,0 +1,161 @@ +#!/usr/bin/env python3 +import io, os, sys, json, shutil, argparse, pathlib, zipfile +from urllib.request import urlopen +from urllib.error import HTTPError + +def main(): + SUPPORTED=[ + # Full Pyodide releases + "v0.18.0", + "v0.18.1", + # Current development version of the Pyodide standard + "dev", + # Pyodide-nano is shipped as a zip-file + "v0.18.0-nano", + "v0.18.1-nano", + ] + + # Defaults + VERSION = SUPPORTED[0] + CDN = "https://cdn.jsdelivr.net/pyodide" + URL = "{CDN}/{VERSION}/full/{file}" + FILES = [ + "pyodide.asm.data", + "pyodide.asm.js", + "pyodide.asm.wasm", + "pyodide.js" + ] + PACKAGES = [ + "distlib", + "distutils", + "micropip", + "packaging", + "pyparsing", + "setuptools" + ] + + # Parse command line arguments + ap = argparse.ArgumentParser( + description="Service program to obtain self-hosted, stripped copy of Pyodide from CDN" + ) + ap.add_argument( + "-v", "--pyodide", dest="version", default=VERSION, choices=SUPPORTED, help="Pyodide version to download" + ) + ap.add_argument("-p", "--packages", nargs="*", help="Further packages to download") + ap.add_argument("-t", "--target", type=pathlib.Path, default="pyodide", help="Target folder") + args = ap.parse_args() + + if is_nano := args.version.endswith("-nano"): + PACKAGES = [] + + # Allow to install additional Pyodide pre-built packages by command-line arguments + packages = PACKAGES + (args.packages or []) + + if is_nano and packages: + raise EnvironmentError("Pyodide-nano does not support additionaly packages currently!") + + for package in packages: + FILES.extend( + [ + f"{package}.data", + f"{package}.js", + ] + ) + + # Remove old target folder first + if os.path.dirname(args.target) not in [".", ".."] and os.path.isdir(args.target): + sys.stdout.write(f"Removing {args.target}/...") + sys.stdout.flush() + + shutil.rmtree(args.target) + print("Done") + + sys.stdout.write(f"Creating {args.target}/...") + sys.stdout.flush() + + os.mkdir(args.target) + + # Write version info + open(os.path.join(args.target, f"""{args.version}"""), "a").close() + + print("Done") + + print(f"Installing Pyodide {args.version}:") + + if is_nano: + # Pyodide Nano is just downloaded from a ZIP-File + version = args.version.removeprefix("v").removesuffix("-nano") + url = f"""https://github.com/phorward/pyodide/releases/download/{version}-nano/pyodide-nano-{version}.zip""" + + # Download ZIP-file into memory + sys.stdout.write(f">>> {url}...") + sys.stdout.flush() + + zip = urlopen(url).read() + + print("Done") + + # Unpack ZIP file from memory + sys.stdout.write(f"Unpacking...") + sys.stdout.flush() + + zip = zipfile.ZipFile(io.BytesIO(zip)) + zip.extractall(args.target) + zip.close() + + print("Done") + + print(f"Done installing Pyodide {args.version}") + sys.exit(0) + + # Normal install of CDN version + + for file in FILES: + url = URL.format(file=file, CDN=CDN, VERSION=args.version) + file = os.path.join(args.target, file) + + sys.stdout.write(f">>> {url}...") + sys.stdout.flush() + + r = urlopen(url).read() + + with open(file, "wb") as f: + f.write(r) + + print("Done") + + # Patch pyodide.js to only use "/pyodide/" + file = os.path.join(args.target, "pyodide.js") + sys.stdout.write(f"Patching {file}...") + sys.stdout.flush() + + with open(file, "r") as f: + content = f.read() + + with open(file, "w") as f: + f.write( + content.replace('config.indexURL || "./"', 'config.indexURL || "./pyodide/"') + ) + + print("Done") + + # Write a minimal packages.json with micropip, setuptools and distlibs pre-installed. + file = os.path.join(args.target, "packages.json") + sys.stdout.write(f"Rewriting {file}...") + sys.stdout.flush() + + packages = json.loads(urlopen(URL.format(file="packages.json", CDN=CDN, VERSION=args.version)).read()) + + for k in list(packages["packages"].keys()): + if k not in PACKAGES: + del packages["packages"][k] + + with open(file, "w") as f: + f.write(json.dumps(packages)) + + print("Done") + + print(f"Done installing Pyodide {args.version}") + +if __name__ == "__main__": + main() \ No newline at end of file