diff --git a/.gitignore b/.gitignore index 72364f9..7e15e02 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,15 @@ +*~ + +# Local config stores +*.dat +*.ini + +# Kivy/buildozer related folders +bin/* +.buildozer/ + +# Default .gitignore entries generated by github for Python projects + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/README.md b/README.md index afa5061..d7b4094 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,77 @@ -# GrinnellPlans-kivy -A Kivy app for interfacing with GrinnellPlans +GrinnellPlans-kivy +================== + +A [Kivy app](https://www.kivy.org "Kivy's Homepage") for interfacing with [GrinnellPlans](https://github.com/grinnellplans/grinnellplans-php/ "GrinnellPlan's Code Repo") + +Liscensing +---------- + +Following the current Plans codebase, this code is released under [GPL v. 3](http://www.gnu.org/licenses/gpl.txt): + +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 . + +Roadmap +------- + + + +Contributing +------------ + +Submit bugs and ideas to `[heider]` on Plans or via [this repo's issues page](https://github.com/paulheider/GrinnellPlans-kivy/issues) + +Building from Source +-------------------- + +### Android + +Android compatible versions can be built with [Buildozer](https://github.com/kivy/buildozer "Buildozer's Code Repo") using the included `buildozer.spec` file: + +```bash +## Build a deployable APK +buildozer android_new debug + +## Build and deploy an APK to a connected device +buildozer android_new debug deploy + +## Build, deploy, and run an APK to a connected device +buildozer android_new debug deploy run +``` + +#### Permissions + +1. Internet + + Internet access is necessary to login, pull the autofinger lists, and pull plans from the Plans database + +2. USB Storage + + The app saves configuration details locally, which requires read/modify/delete permissions. + + +### iOS + +(untested) + +### Linux + +The application can be run from the terminal on a linux machine: + +```bash +python main.py +``` + +### Windows + +(untested) diff --git a/gpl.txt b/gpl.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/gpl.txt @@ -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/main.kv b/main.kv new file mode 100644 index 0000000..394e063 --- /dev/null +++ b/main.kv @@ -0,0 +1,311 @@ +ScreenManagement: + ## TODO: add transition screens + ##transition: FadeTransition + LoginScreen: + LoadingPage: + LandingPage: + ReadPlan: + EditPlan: + +: + ## TODO: add logo to bottom of screen + name: 'login' + title: 'Login' + FloatLayout: + size_hint: 1,1 + Label: + text: 'User Name' + size_hint: 0.25,0.1 + pos_hint: {'center_x': (self.parent.width - 5 - 0.5*(self.parent.width*0.25) - (self.parent.width/2)) / self.parent.width , 'top': (self.parent.height + 3*(5 + self.parent.height*0.1) - (self.parent.height/2)) / self.parent.height } + TextInput: + id: username + size_hint: 0.25,0.1 + pos_hint: {'center_x': (self.parent.width + 5 + 0.5*(self.parent.width*0.25) - (self.parent.width/2)) / self.parent.width, 'top': (self.parent.height + 3*(5 + self.parent.height*0.1) - (self.parent.height/2)) / self.parent.height } + multiline: False + Label: + text: 'Password' + size_hint: 0.25,0.1 + pos_hint: {'center_x': (self.parent.width - 5 - 0.5*(self.parent.width*0.25) - (self.parent.width/2)) / self.parent.width, 'top': (self.parent.height + 2*(5 + self.parent.height*0.1) - (self.parent.height/2)) / self.parent.height } + TextInput: + id: password + password: True + size_hint: 0.25,0.1 + pos_hint: {'center_x': (self.parent.width + 5 + 0.5*(self.parent.width*0.25) - (self.parent.width/2)) / self.parent.width, 'top': (self.parent.height + 2*(5 + self.parent.height*0.1) - (self.parent.height/2)) / self.parent.height } + multiline: False + Button: + text: 'Login' + size_hint: 0.5,0.1 + pos_hint: {'center_x': 0.5 , 'top': (self.parent.height + 1*(5 + self.parent.height*0.1) - (self.parent.height/2)) / self.parent.height } + on_press: root.logInTask( username.text , password.text ) + ## TODO: add guest access + ## Button: + ## text: 'Guest' + ## size_hint: 0.25,0.1 + ## pos_hint: {'center_x': (self.parent.width + 5 + 0.5*(self.parent.width*0.25) - (self.parent.width/2)) / self.parent.width, 'top': (self.parent.height + 1*(5 + self.parent.height*0.1) - (self.parent.height/2)) / self.parent.height } + ## on_press: root.guestAuth( username.text , password.text ) + + +## : +## name: 'loading_page' +## +## LabelB: +## id: loading_page_logs +## text: '' +## bcolor: 0,0,0,0.5 +## text_size: self.size +## size_hint: (1,1) +## +## Label: +## text: 'Loading....' +## font_size: 50 + +: + name: 'landing_page' + + BoxLayout: + size_hint: 1, 1 + orientation: 'horizontal' + + BoxLayout: + size_hint: 0.9, 1 + orientation: 'horizontal' + + ScrollView: + + GridLayout: + id: level_1 + cols: 1 + padding: 10 + spacing: 10 + size_hint: 1, None + height: self.minimum_height + + ScrollView: + + GridLayout: + id: level_2 + cols: 1 + padding: 10 + spacing: 10 + size_hint: 1, None + height: self.minimum_height + + ScrollView: + + GridLayout: + id: level_3 + cols: 1 + padding: 10 + spacing: 10 + size_hint: 1, None + height: self.minimum_height + + FloatLayout: + size_hint: 0.1,1 + + Button: + ## TODO: find icon set + id: 'home_button' + text: 'home' + size_hint: 0.75,None + height: self.width + pos_hint: {'center_x': 0.5, 'top': (self.parent.height-0*(self.parent.width*0.75)-(self.parent.width*0.25)/2)/self.parent.height } + on_release: app.root.screens[ 3 ].readFromHomeButton() + + ## Button: + ## id: 'edit_plan_button' + ## text: 'edit' + ## disabled: True + ## size_hint: 0.75,None + ## height: self.width + ## pos_hint: {'center_x': 0.5, 'top': (self.parent.height-1*(self.parent.width*0.875)-(self.parent.width*0.25)/2)/self.parent.height } + + Button: + id: 'autofinger_list_button' + text: 'fi' + size_hint: 0.75,None + height: self.width + pos_hint: {'center_x': 0.5, 'top': (self.parent.height-1*(self.parent.width*0.875)-(self.parent.width*0.25)/2)/self.parent.height } + on_release: app.root.current = 'landing_page' + + ## Button: + ## id: 'settings_button' + ## text: 'settings' + ## disabled: True + ## size_hint: 0.75,None + ## height: self.width + ## pos_hint: {'center_x': 0.5, 'top': (2*(self.parent.width*0.95)-(self.parent.width*0.25)/2)/self.parent.height } + ## on_release: app.root.current = 'loading_page' + + ## Button: + ## ## TODO: add logout to API? + ## id: 'logout_button' + ## text: 'logout' + ## disabled: True + ## size_hint: 0.75,None + ## height: self.width + ## pos_hint: {'center_x': 0.5, 'top': (1*(self.parent.width)-(self.parent.width*0.25)/2)/self.parent.height } + ## on_release: app.root.current = 'loading_page' + + +: + name: 'read_plan' + + BoxLayout: + size_hint: 1, 1 + orientation: 'horizontal' + + ScrollView: + + GridLayout: + cols: 1 + padding: 10 + spacing: 10 + size_hint: 1, None + height: self.minimum_height + + GridLayout: + size_hint: (1,None) + height: 3 * root.height * 0.08 + 2 * 20 + cols: 4 + padding: 10 + spacing: 10 + Label: + Label: + TextInput: + id: finger + multiline: False + size_hint_y: None + height: root.height * 0.08 + Button: + text: 'Read' + size_hint_y: None + height: root.height * 0.08 + on_release: app.root.screens[ 3 ].readFromFingerButton() + Label: + text: 'Username' + size_hint_y: None + height: root.height * 0.08 + Label: + id: username + Label: + text: 'Name' + size_hint_y: None + height: root.height * 0.08 + Label: + id: psuedo + Label: + text: 'Last Updated:' + size_hint_y: None + height: root.height * 0.08 + Label: + id: last_updated + Label: + text: 'Last Login:' + size_hint_y: None + height: root.height * 0.08 + Label: + id: last_login + + ## LabelB: + ## id: header + ## text_size: self.size + ## size_hint: (1,None) + ## height: self.texture_size[1] + ## bcolor: 0,0,1,1 + ## halign: 'center' + ## valign: 'middle' + ## markup: True + ## text: '...header...' + + Label: + id: plan + text_size: self.size + size_hint: (1,None) + height: 1600 + color: 1,1,1,1 + ##bcolor: 0,0,0,1 + halign: 'left' + valign: 'top' + markup: True + text: 'Hello &bl;[ref=world][color=0000ff]World[/color][/ref]&br;' + ## TODO: add on_long_press send to clipboard + on_ref_press: app.root.screens[ 3 ].readFromRef( args[ 1 ] ) + + ## LabelB: + ## id: footer + ## text_size: self.size + ## ##height: self.texture_size[1] + ## size_hint: (1,None) + ## height: self.texture_size[1] + ## bcolor: 0,1,0,1 + ## halign: 'center' + ## valign: 'middle' + ## markup: True + ## text: '...footer...' + + FloatLayout: + size_hint: 0.1,1 + + Button: + id: 'home_button' + text: 'home' + size_hint: 0.75,None + height: self.width + pos_hint: {'center_x': 0.5, 'top': (self.parent.height-0*(self.parent.width*0.75)-(self.parent.width*0.25)/2)/self.parent.height } + on_release: root.readFromHomeButton() + + ## Button: + ## id: 'edit_plan_button' + ## text: 'edit' + ## disabled: True + ## size_hint: 0.75,None + ## height: self.width + ## pos_hint: {'center_x': 0.5, 'top': (self.parent.height-1*(self.parent.width*0.875)-(self.parent.width*0.25)/2)/self.parent.height } + + Button: + id: 'autofinger_list_button' + text: 'fi' + size_hint: 0.75,None + height: self.width + pos_hint: {'center_x': 0.5, 'top': (self.parent.height-1*(self.parent.width*0.875)-(self.parent.width*0.25)/2)/self.parent.height } + on_release: app.root.current = 'landing_page' + + ## Button: + ## id: 'settings_button' + ## text: 'settings' + ## disabled: True + ## size_hint: 0.75,None + ## height: self.width + ## pos_hint: {'center_x': 0.5, 'top': (2*(self.parent.width*0.95)-(self.parent.width*0.25)/2)/self.parent.height } + ## color: 0,0,1,0.5 + ## on_release: app.root.current = 'loading_page' + + ## Button: + ## id: 'logout_button' + ## text: 'logout' + ## disabled: True + ## size_hint: 0.75,None + ## height: self.width + ## pos_hint: {'center_x': 0.5, 'top': (1*(self.parent.width*1)-(self.parent.width*0.25)/2)/self.parent.height } + +: + name: 'edit_plan' + + Button: + on_release: app.root.current = 'read_plan' + text: 'Edit Plan' + font_size: 50 + +: + pop_up_text: _pop_up_text + size_hint: .5, .5 + auto_dismiss: True + title: 'Status' + + BoxLayout: + orientation: "vertical" + Label: + id: _pop_up_text + text: '' + diff --git a/main.py b/main.py new file mode 100644 index 0000000..ae29e27 --- /dev/null +++ b/main.py @@ -0,0 +1,531 @@ +from __future__ import print_function + +import sys +reload(sys) +sys.setdefaultencoding('utf8') + +## Allow labels to have background colors +#import LabelB + +import inspect + +import time +import datetime +import requests +#import urllib +#import base64 +#import urllib2 + +import re + +##from html2rest import html2rest +##import StringIO +from HTMLParser import HTMLParser +#from bs4 import BeautifulSoup + +import webbrowser + +import kivy + +kivy.require('1.9.1') + +## TODO: integrate a config file +##from kivy.config import Config +from kivy.logger import Logger + +from kivy.app import App +from kivy.lang import Builder +from kivy.uix.popup import Popup +from kivy.factory import Factory + +from kivy.properties import ObjectProperty + +from kivy.uix.screenmanager import ScreenManager, Screen, FadeTransition + +from kivy.uix.gridlayout import GridLayout +from kivy.uix.button import Button +from kivy.uix.label import Label +from kivy.uix.textinput import TextInput +from kivy.uix.scrollview import ScrollView + +from kivy.utils import escape_markup + +from kivy.storage.jsonstore import JsonStore +from kivy.storage.dictstore import DictStore + +def this_line(): + callerframerecord = inspect.stack()[1] + ## 0 represents this line + ## 1 represents line at caller + frame = callerframerecord[0] + info = inspect.getframeinfo(frame) + return info.lineno + +## We use a very strict regex pattern because of how we treat +## planlove as a special form of URL to be parsed +## read.php?searchname=gspelvin +planlove_re = re.compile( "^read\.php\?searchname=([a-zA-Z0-9]+)$" ) +autofinger_level_re = re.compile( "^level_[0-9]$" ) + +plan_name_parser = HTMLParser() + +class PlansHTMLParser(HTMLParser): + plan_buffer = '' + + def handle_starttag(self, tag, attrs): + ## TODO: add support for
,
+        ## https://www.grinnellplans.com/documents/faq.html#htmltags
+        ## https://github.com/kivy/kivy/tree/master/kivy/data/fonts
+        if( tag == 'a' ):
+            href_content = None
+            class_type = None
+            for attr in attrs:
+                if( attr[ 0 ] == 'href' ):
+                    href_content = attr[ 1 ]
+                elif( attr[ 0 ] == 'class' ):
+                    class_type = attr[ 1 ]
+            self.plan_buffer = ''.join( ( self.plan_buffer ,
+                                          '[ref=' ,
+                                          href_content ,
+                                          ']' ) )
+            if( class_type == 'planlove' ):
+                ##print( '{} -> {}'.format( href_content ,
+                ##                          planlove_re.findall(href_content)))
+                ##planlove_target = planlove_re.findall( href_content )[ 0 ]
+                self.plan_buffer = ''.join( ( self.plan_buffer ,
+                                              '[color=0000ff]' ) )
+            elif( class_type == 'onplan' ):
+                self.plan_buffer = ''.join( ( self.plan_buffer ,
+                                              '[color=00ff00]' ) )
+        elif( tag == 'pre' ):
+            ## TODO:  Make mono font configurable
+            mono_font = 'RobotoMono-Regular'
+            self.plan_buffer = ''.join( ( self.plan_buffer ,
+                                          '[font=' ,
+                                          mono_font ,
+                                          ']' ) )
+        elif( tag == 'b' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[b]' ) )
+        elif( tag == 'i' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[i]' ) )
+        elif( tag == 'u' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[u]' ) )
+        elif( tag == 'strike' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[s]' ) )
+
+        
+    def handle_endtag(self, tag):
+        if( tag == 'a' ):
+            ## TODO: deal with nested tags
+            self.plan_buffer = ''.join( ( self.plan_buffer ,
+                                          '[/color][/ref]' ) )
+        elif( tag == 'pre' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[/font]' ) )
+        elif( tag == 'b' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[/b]' ) )
+        elif( tag == 'i' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[/i]' ) )
+        elif( tag == 'u' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[/u]' ) )
+        elif( tag == 'strike' ):
+            self.plan_buffer = ''.join( ( self.plan_buffer , '[/s]' ) )
+        
+    def handle_data(self, data):
+        self.plan_buffer = ''.join( ( self.plan_buffer ,
+                                      escape_markup( data ) ) )
+
+from kivy.utils import platform
+
+## Hack until this bug is fixed to launch native Android browser
+## https://github.com/kivy/python-for-android/issues/846
+## http://python-for-android.readthedocs.io/en/latest/apis/#using-android
+## TODO:  reorganize to preload to that the first URL isn't so slow
+def launch_webbrowser(url):
+    if platform == 'android':
+        from jnius import autoclass, cast
+        def open_url(url):
+            PythonActivity = autoclass('org.kivy.android.PythonActivity')
+            activity = PythonActivity.mActivity
+            Intent = autoclass('android.content.Intent')
+            Uri = autoclass('android.net.Uri')
+            browserIntent = Intent()
+            browserIntent.setAction(Intent.ACTION_VIEW)
+            browserIntent.setData(Uri.parse(url))
+            currentActivity = cast('android.app.Activity', activity)
+            currentActivity.startActivity(browserIntent)
+            
+        # Web browser support.
+        class AndroidBrowser(object):
+            def open(self, url, new=0, autoraise=True):
+                open_url(url)
+            def open_new(self, url):
+                open_url(url)
+            def open_new_tab(self, url):
+                open_url(url)
+                
+        webbrowser.register('android', AndroidBrowser, None, -1)
+        
+    webbrowser.open(url)
+## END hack
+        
+cookie_jar = DictStore( 'cookies.dat' )
+session = None
+
+autofinger_list = {}
+
+## TODO:  add remember username/password button
+def LLOOGG( message ):
+    ##plans_app.screens[ 1 ].ids[ 'loading_page_logs' ].text = message
+    Logger.info( message )
+
+
+class PopupBox(Popup):
+    pop_up_text = ObjectProperty()
+    
+    def update_pop_up_text(self, p_message):
+        self.pop_up_text.text = p_message
+
+
+class LoginScreen( Screen ):
+
+    def show_popup( self , message ):
+        LLOOGG( "{} - {}".format( this_line() ,
+                                  message ) )
+        self.pop_up = Factory.PopupBox()
+        self.pop_up.update_pop_up_text( message )
+        self.pop_up.open()
+
+    def update_autofinger( self , json_list ):
+        ## TODO:  call this for every page read
+        global autofinger_list
+        autofinger_list = {}
+        for level in json_list:
+            level_number = level[ u'level' ]
+            ##print( 'Level {}'.format( level_number ) )
+            autofinger_list[ 'level_{}'.format( level_number ) ] = []
+            ##autofinger_list[ 'level_{}'.format( level_number ) ] = ''
+            level_string = 'level_{}'.format( level_number )
+            for username in level[ u'usernames' ]:
+                autofinger_list[ level_string ].append( username )
+                ##print( "\t{}".format( username ) )
+
+    
+    def guestAuth( self , username , password ):
+        pass##print( '{} -> {}'.format( username , password ) )
+
+    
+    def logInTask( self , username , password ):
+        global session
+        self.show_popup( 'Logging in...' )
+        plans_app.current = 'landing_page'
+        LLOOGG( "{} - {}h {}w".format( this_line() ,
+                                       plans_app.height ,
+                                       plans_app.width ) )
+        try:
+            if( username == '' ):
+                LLOOGG( 'Username must not be empty.' )
+            elif( password == '' ):
+                LLOOGG( 'Password must not be empty.' )
+            else:
+                ##LLOOGG( "{} - {} {}".format( this_line() ,
+                ##                             username ,
+                ##                             password ) )
+                login_url = 'https://www.grinnellplans.com/api/1/index.php?task=login'
+                LLOOGG( "{} - {}".format( this_line() , login_url ) )
+                session = requests.Session()
+                LLOOGG( "{} - {}".format( this_line() , 'session created' ) )
+                response = session.post( login_url ,
+                                         data = { 'username': username ,
+                                                  'password': password } )
+                LLOOGG( "{} - {}".format( this_line() , 'response generated' ) )
+                jar = response.cookies
+                if( response.status_code == 200 ):
+                    cookie_jar.put( 'user_name' ,
+                                    username = username )
+                    ##cookie_jar.put( 'user_pass' ,
+                    ##                passwd = password )
+                    json_response = response.json()
+                    print( '{} - {}'.format( this_line() , json_response ) )
+                    self.update_autofinger( json_response[ 'autofingerList' ] )
+                    ##with open( '/tmp/autofinger_list.txt' , 'w' ) as f:
+                    ##    f.write( json_response[ 'autofingerList' ] )
+                    ##f.closed
+                    response.close()
+                    LLOOGG( 'Logged in.  Checking plan...' )
+                    ##plans_app.current = 'landing_page'
+                    self.pop_up.dismiss()
+                    LLOOGG( "{} - popup dismissed".format( this_line() ) )
+                else:
+                    LLOOGG( 'Failed to log in:  {}'.format( response.status_code ) )
+        except Exception as e:
+            st = datetime.datetime.fromtimestamp( time.time() ).strftime('%Y-%m-%d %H:%M:%S')
+            LLOOGG( 'Error:  {1}\n'.format( st , e ) )
+    
+    
+    def __init__(self , **kwargs ):
+        super(LoginScreen, self).__init__(**kwargs)
+
+
+class LoadingPage( Screen ):
+
+    def on_enter( self ):
+        pass
+
+    
+    def __init__(self , **kwargs ):
+        super(LoadingPage, self).__init__(**kwargs)
+
+
+class LandingPage( Screen ):
+    ## TODO:  random buttons for each person on your autoread list
+    ## https://kivy.org/docs/api-kivy.uix.floatlayout.html#module-kivy.uix.floatlayout
+    ## TODO:  add refresh button or pull at top to refresh
+    ## TODO:  on_enter pull new autofinger_list
+
+    def show_popup( self , message ):
+        if( message == None ):
+            message = 'Waiting for PlanGodot'
+        LLOOGG( "{} - {}".format( this_line() ,
+                                  message ) )
+        self.pop_up = Factory.PopupBox()
+        self.pop_up.update_pop_up_text( message )
+        self.pop_up.open()
+    
+    
+    def on_enter( self ):
+        global autofinger_list
+        self.show_popup( 'Loading autofinger levels...' )
+        #print( '{} -> {}'.format( username , password ) )
+        ##print( 'Children:' )
+        # level_name = 'level_1'
+        # plans_app.screens[ 2 ].ids[ level_name ].bind( minimum_height = plans_app.screens[ 2 ].ids[ level_name ].setter( 'height' ) )
+        # for i in range(100):
+        #     btn = Button( text = str(i) ,
+        #                   size = ( plans_app.width / 3 , 40 ) ,
+        #                   size_hint_y = None )
+        #     plans_app.screens[ 2 ].ids[ level_name ].add_widget(btn)        
+        button_width = 0.9 * plans_app.width / 3
+        button_height = plans_app.height * 0.5
+        
+        for level_name in plans_app.screens[ 2 ].ids:
+            level_matches = autofinger_level_re.findall( level_name )
+            if( len( level_matches ) == 0 ):
+                ## Ignore widgets that aren't named "level_[0-9]"
+                continue
+            ##print( "\t{}".format( level_name ) )
+            plans_app.screens[ 2 ].ids[ level_name ].clear_widgets()
+            ## TODO:  reformat
+            pretty_level_name = level_name[:1].upper() + \
+                                level_name[1:].replace( '_' , ' ' )
+            level_lbl = Label( id = '{}_lbl'.format( level_name ) ,
+                               size_y = button_height ,
+                               text = pretty_level_name )
+            plans_app.screens[ 2 ].ids[ level_name ].add_widget( level_lbl )
+            ## TODO:  is this line really necessary?
+            plans_app.screens[ 2 ].ids[ level_name ].bind( minimum_height = plans_app.screens[ 2 ].ids[ level_name ].setter( 'height' ) )
+            if( autofinger_list.has_key( level_name ) ):
+                for username in autofinger_list[ level_name ] :
+                    ##print( "\t\t{}".format( username ) )
+                    finger_btn = Button( text = username ,
+                                         size_x = button_width ,
+                                         size_y = button_height ,
+                                         size_hint_y = None )
+                    ##TODO:  bind readTask to this button
+                    finger_btn.bind( on_press = plans_app.screens[ 3 ].readFromLevels )
+                    plans_app.screens[ 2 ].ids[ level_name ].add_widget( finger_btn )
+        self.pop_up.dismiss()
+    
+
+    def __init__(self , **kwargs ):
+        super(LandingPage, self).__init__(**kwargs)
+
+
+class ReadPlan( Screen ):
+    ## TODO:  add a button to flag plan for comment/later and see all flagged
+    def show_popup( self , message ):
+        if( message == None ):
+            message = 'Waiting for PlanGodot'
+        LLOOGG( "{} - {}".format( this_line() ,
+                                  message ) )
+        self.pop_up = Factory.PopupBox()
+        self.pop_up.update_pop_up_text( message )
+        self.pop_up.open()
+    
+    
+    def on_enter( self ):
+        #with open( '/tmp/plan_body.html' , 'r' ) as f:
+        #    plan_body = self.cleanPlanBody( f.read() )
+        #f.closed
+        ##print( "{} - {}".format( this_line() , plan_body[ 0:250 ] ) )
+        LLOOGG( "{} - Original length = {}".format( this_line() ,
+        #                                               plans_app.screens[ 3 ].ids.plan.bcolor ,
+                                                       plans_app.screens[ 3 ].ids.plan.texture_size ) )
+        ## TODO:  Readjusting label size to match text size
+        ##   - https://blog.kivy.org/2014/07/wrapping-text-in-kivys-label/
+        #plans_app.screens[ 3 ].ids.plan.text = plan_body
+        ##plans_app.screens[ 3 ].ids.plan.text_size = ( 780 , 800 )
+        ##plans_app.screens[ 3 ].ids.plan.texture_size[ 1 ] )
+        ##plans_app.screens[ 3 ].ids.plan.texture_update()
+        ##plans_app.screens[ 3 ].ids.plan.height = plans_app.screens[ 3 ].ids.plan.texture_size[ 1 ]
+        ##plans_app.screens[ 3 ].ids.plan.size = plans_app.screens[ 3 ].ids.plan.texture_size
+        ##plans_app.screens[ 3 ].ids.plan.size = plans_app.screens[ 3 ].ids.plan.texture_size
+        ##text_size: self.width, None
+        ##height: self.texture_size[1]
+        #LLOOGG( "{} - Plan length = {} vs. {}".format( this_line() ,
+        #                                               len( plan_body ) ,
+        #                                               plans_app.screens[ 3 ].ids.plan.texture_size ) )
+        #
+
+    def guestAuth( self , username ):
+        print( '{} -|'.format( username ) )
+    
+    
+    def cleanPlanBody( self , plan_body , this_encoding = None ):
+        print( '{} - Cleaning plan body'.format( this_line() ) )
+        plans_parser = PlansHTMLParser()
+        if( this_encoding == None ):
+            plans_parser.feed( plan_body )
+        else:
+            plans_parser.feed( plan_body.encode( this_encoding ) )
+        return plans_parser.plan_buffer
+        ## TODO: maybe replace beatufil soup with HTMLParser
+        ## https://docs.python.org/2/library/htmlparser.html
+        #if( this_encoding == None ):
+        #    soup = BeautifulSoup( plan_body ,
+        #                          'html.parser' )
+        #else:
+        #    soup = BeautifulSoup( plan_body.decode( this_encoding ) ,
+        #                          'html.parser' )
+        #return soup.get_text()
+        if( this_encoding == None ):
+            return plan_body
+        ## Default
+        return plan_body.encode( this_encoding )
+    
+    
+    def cleanPlanName( self , plan_name , this_encoding ):
+        ##return html_parser.unescape( plan_name.encode( this_encoding ) )
+        return plan_name_parser.unescape( plan_name )
+
+    
+    ## TODO:  convert times to local timezone
+    ## TODO:  add local vs. UTC vs. other timezone display options
+    def adjustClock( self , timestamp ):
+        return timestamp
+    
+
+    def readFromHomeButton( self ):
+        username = plans_app.screens[ 0 ].ids.username.text
+        if( username != '' ):
+            self.show_popup( 'Loading plan...' )
+            self.readTask( username )
+            self.pop_up.dismiss()
+    
+            
+    def readFromFingerButton( self ):
+        username = plans_app.screens[ 3 ].ids.finger.text
+        if( username != '' ):
+            self.show_popup( 'Loading plan...' )
+            self.readTask( username )
+            self.pop_up.dismiss()
+
+    
+    def readFromLevels( self , button_instance ):
+        username = button_instance.text
+        if( username != '' ):
+            self.show_popup( 'Loading plan...' )
+            self.readTask( username )
+            self.pop_up.dismiss()
+
+    
+    def readFromRef( self , ref_string ):
+        planlove_matches = planlove_re.findall( ref_string )
+        if( len( planlove_matches ) == 0 ):
+            LLOOGG( 'readFromRef:  {} - generic url = {}'.format( this_line() , ref_string ) )
+            launch_webbrowser( ref_string )
+        else:
+            username = planlove_matches[ 0 ]
+            LLOOGG( 'readFromRef:  {} - {} from {}'.format( this_line() , username , ref_string ) )
+            self.show_popup( 'Loading plan...' )
+            self.readTask( username )
+            self.pop_up.dismiss()
+    
+    
+    def readTask( self , username ):
+        global session
+        ## TODO:  scroll back to top of page for new plan
+        plans_app.current = 'read_plan'
+        try:
+            url = 'https://www.grinnellplans.com/api/1/index.php?task=read'
+            response = session.post( url ,
+                                     data = { 'username': username } )
+            json_response = None
+            if( response.status_code == 200 ):
+                json_response = response.json()
+                ##print( 'Encoding = {}'.format( response.encoding ) )
+                ##plan_body = response.text.encode( response.encoding )
+                #### We don't actually need the grab the username because
+                #### it was passed to the original function
+                ##username = json_response[ 'plandata' ][ 'username' ]
+                plan_body = self.cleanPlanBody( json_response[ 'plandata' ][ 'plan' ] ,
+                                                response.encoding )
+                plan_name = self.cleanPlanName( json_response[ 'plandata' ][ 'pseudo' ] ,
+                                                response.encoding )
+                last_login = self.adjustClock( json_response[ 'plandata' ][ 'last_login' ] )
+                last_updated = self.adjustClock( json_response[ 'plandata' ][ 'last_updated' ] )
+                ##LLOOGG( '{}'.format( this_line() ) )
+                ##with open( '/tmp/plan_body.html' , 'w' ) as f:
+                ##    f.write( plan_body )
+                ##f.closed
+                response.close()
+                plans_app.screens[ 3 ].ids.username.text = username
+                plans_app.screens[ 3 ].ids.psuedo.text = plan_name
+                plans_app.screens[ 3 ].ids.last_login.text = last_login
+                plans_app.screens[ 3 ].ids.last_updated.text = last_updated
+                ##plans_app.screens[ 3 ].ids.plan.text = plan_body[ 0:250 ]##'asdf'
+                plans_app.screens[ 3 ].ids.plan.text = plan_body
+                ##plans_app.screens[ 3 ].ids.plan.text = 'Hello [ref=heider][color=0000ff]World[/color][/ref]'
+                ##plans_app.screens[ 3 ].ids.plan.width = plans_app.width
+                LLOOGG( "{} - {}h {}w".format( this_line() ,
+                                               plans_app.height ,
+                                               plans_app.width ) )
+                #print( '{}'.format( this_line() ) )
+                ## If we got here from clicking the read button, then empty out the data
+                plans_app.screens[ 3 ].ids.finger.text = ''
+        except Exception as e:
+            st = datetime.datetime.fromtimestamp( time.time() ).strftime('%Y-%m-%d %H:%M:%S')
+            LLOOGG( 'Error:  {1}\n'.format( st , e ) )
+
+    def __init__(self , **kwargs ):
+        super(ReadPlan, self).__init__(**kwargs)
+
+
+class EditPlan( Screen ):
+    pass
+
+class ScreenManagement( ScreenManager ):
+    pass
+            
+
+plans_app = Builder.load_file( "main.kv" )
+
+class GrinnellPlansApp(App):
+    
+    def build(self):
+        ## plans_app.screen_names[ 0 ]
+        ##print( '{}'.format( plans_app.screens[ 0 ].ids.password.text ) )
+        print( 'Screens:  {}'.format( plans_app.screens ) )
+        if( cookie_jar.exists( 'user_name' ) ):
+            ##cookie_jar.exists( 'user_pass' ) ):
+            ## TODO:  make this a robust look-up rather than hard-coded index
+            plans_app.screens[ 0 ].ids.username.text = cookie_jar.get( 'user_name' )[ 'username' ]
+            ##plans_app.screens[ 0 ].ids.password.text = cookie_jar.get( 'user_pass' )[ 'passwd' ]
+        plans_app.current = 'login'
+        ##plans_app.current = 'landing_page'
+        ##plans_app.current = 'loading_page'
+        ##plans_app.current = 'read_plan'
+        return plans_app
+    
+if __name__ == '__main__':
+    GrinnellPlansApp().run()
+    
diff --git a/resources/logo.png b/resources/logo.png
new file mode 100644
index 0000000..363b1f1
Binary files /dev/null and b/resources/logo.png differ
diff --git a/resources/logo_square.png b/resources/logo_square.png
new file mode 100644
index 0000000..2dc2e7a
Binary files /dev/null and b/resources/logo_square.png differ