diff --git a/.gitignore b/.gitignore index 7f20b71..98ca521 100644 --- a/.gitignore +++ b/.gitignore @@ -34,5 +34,6 @@ nosetests.xml .project .pydevproject -*.bak -verda.txt \ No newline at end of file +# Sublime Text +*.sublime-project +*.sublime-workspace \ No newline at end of file diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING.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/README.md b/README.md deleted file mode 100644 index 69c1781..0000000 --- a/README.md +++ /dev/null @@ -1,56 +0,0 @@ -python-yr -================= -Library for the norwegian wheather service yr.no in python. - -Pull requests are very welcomed! :-) - -### Usage -```python -from yr.libyr import Yr - -weather = Yr('Norge/Telemark/Skien/Skien') -now_json = weather.now(as_json=True) -# now = weather.now() # returns a dict - -print now_json -``` - -### This returns -```json -{ - "time": { - "@from": "2014-02-08T21:00:00", - "@period": "3", - "@to": "2014-02-09T00:00:00", - "symbol": { - "@name": "Rain", - "@number": "9", - "@var": "09" - }, - "precipitation": { - "@maxvalue": "6.2", - "@minvalue": "3.0", - "@value": "4.6" - }, - "winddirection": { - "@code": "SSE", - "@deg": "148.4", - "@name": "South-southeast" - }, - "windspeed": { - "@mps": "6.6", - "@name": "Moderate breeze" - }, - "temperature": { - "@unit": "celsius", - "@value": "3" - }, - "pressure": { - "@unit": "hPa", - "@value": "983.0" - } - } -} -``` - -More to come! diff --git a/README.rst b/README.rst new file mode 100755 index 0000000..6249fbb --- /dev/null +++ b/README.rst @@ -0,0 +1,62 @@ +========= +python-ayr +========= + +Asynchronous library for the norwegian weather service YR.no_ in Python_. Forked from python-yr_ by wkcd_. + +Usage +===== + +.. code:: python + + from ayr.libayr import Yr + + weather = Yr(location_name='Norge/Telemark/Skien/Skien') + now = await weather.now(as_json=True) + + print(now) + +This returns +============ + +.. code:: json + + { + "@from": "2014-06-04T08:00:00", + "@to": "2014-06-04T12:00:00", + "@period": "1", + "symbol": { + "@number": "3", + "@numberEx": "3", + "@name": "Partly cloudy", + "@var": "03d" + }, + "precipitation": { + "@value": "0", + "@minvalue": "0", + "@maxvalue": "0.1" + }, + "windDirection": { + "@deg": "159.4", + "@code": "SSE", + "@name": "South-southeast" + }, + "windSpeed": { + "@mps": "1.3", + "@name": "Light air" + }, + "temperature": { + "@unit": "celsius", + "@value": "13" + }, + "pressure": { + "@unit": "hPa", + "@value": "1012.1" + } + } + + +.. _YR.no: http://www.yr.no/ +.. _Python: http://www.python.org/ +.. _python-yr: https://github.com/wckd/python-yr/ +.. -wkcd: https://github.com/wckd/python-yr/ diff --git a/yr/__init__.py b/ayr/__init__.py similarity index 100% rename from yr/__init__.py rename to ayr/__init__.py diff --git a/ayr/examples/credit.py b/ayr/examples/credit.py new file mode 100644 index 0000000..9007e11 --- /dev/null +++ b/ayr/examples/credit.py @@ -0,0 +1,7 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') + +print(weather.credit) diff --git a/ayr/examples/dictionary.py b/ayr/examples/dictionary.py new file mode 100644 index 0000000..d9e0e2d --- /dev/null +++ b/ayr/examples/dictionary.py @@ -0,0 +1,7 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') + +print(weather.dictionary) diff --git a/ayr/examples/forecast.py b/ayr/examples/forecast.py new file mode 100644 index 0000000..3db38c1 --- /dev/null +++ b/ayr/examples/forecast.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') + +for forecast in weather.forecast(): + print(forecast) diff --git a/ayr/examples/forecast_hour_by_hour.py b/ayr/examples/forecast_hour_by_hour.py new file mode 100644 index 0000000..97dccbd --- /dev/null +++ b/ayr/examples/forecast_hour_by_hour.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norway/Rogaland/Stavanger/Stavanger', forecast_link='forecast_hour_by_hour') + +for forecast in weather.forecast(): + print(forecast) diff --git a/ayr/examples/forecast_hour_by_hour_json.py b/ayr/examples/forecast_hour_by_hour_json.py new file mode 100644 index 0000000..890483e --- /dev/null +++ b/ayr/examples/forecast_hour_by_hour_json.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norway/Rogaland/Stavanger/Stavanger', forecast_link='forecast_hour_by_hour') + +for forecast in weather.forecast(as_json=True): + print(forecast) diff --git a/ayr/examples/forecast_json.py b/ayr/examples/forecast_json.py new file mode 100644 index 0000000..1ff5d1a --- /dev/null +++ b/ayr/examples/forecast_json.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') + +for forecast in weather.forecast(as_json=True): + print(forecast) diff --git a/ayr/examples/forecast_xyz.py b/ayr/examples/forecast_xyz.py new file mode 100644 index 0000000..e0e1fd3 --- /dev/null +++ b/ayr/examples/forecast_xyz.py @@ -0,0 +1,9 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +#weather = Yr(location_name="Italy/Trentino_and_South-Tirol/San_Michele_all'Adige") +weather = Yr(location_xyz=(11.13358, 46.19291, 210)) # xyz for Italy/Trentino_and_South-Tirol/San_Michele_all'Adige + +for forecast in weather.forecast(as_json=True): + print(forecast) diff --git a/ayr/examples/now.py b/ayr/examples/now.py new file mode 100644 index 0000000..f50251a --- /dev/null +++ b/ayr/examples/now.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') +now = weather.now() + +print(now) diff --git a/ayr/examples/now_json.py b/ayr/examples/now_json.py new file mode 100644 index 0000000..e72cea4 --- /dev/null +++ b/ayr/examples/now_json.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') +now = weather.now(as_json=True) + +print(now) diff --git a/ayr/examples/wuurrd.py b/ayr/examples/wuurrd.py new file mode 100644 index 0000000..35f5dc6 --- /dev/null +++ b/ayr/examples/wuurrd.py @@ -0,0 +1,11 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') + +wind_speed = dict() +wind_speed['data'] = [{'from': forecast['@from'], 'to': forecast['@to'], 'speed': float(forecast['windSpeed']['@mps'])} for forecast in weather.forecast()] +wind_speed['credit'] = weather.credit + +print(wind_speed) diff --git a/ayr/examples/xml_source.py b/ayr/examples/xml_source.py new file mode 100644 index 0000000..ffbfaa3 --- /dev/null +++ b/ayr/examples/xml_source.py @@ -0,0 +1,7 @@ +#!/usr/bin/env python3 + +from yr.libyr import Yr + +weather = Yr(location_name='Norge/Telemark/Skien/Skien') + +print(weather.xml_source) diff --git a/ayr/internal/module_path.py b/ayr/internal/module_path.py new file mode 100644 index 0000000..cdd5f86 --- /dev/null +++ b/ayr/internal/module_path.py @@ -0,0 +1,6 @@ +#!/usr/bin/env python3 + +import yr.libyr +print('/home/pm/.local/lib/python3.4/site-packages/yr/libyr.py') # ~> is wrong! +print('/usr/local/lib/python3.4/dist-packages/yr/libyr.py') # ~> is ok! +print(yr.libyr.__file__) diff --git a/ayr/languages/en.json b/ayr/languages/en.json new file mode 100644 index 0000000..00280e5 --- /dev/null +++ b/ayr/languages/en.json @@ -0,0 +1,11 @@ +{ + "language": "en", + "place": "place", + "forecast": "forecast", + "forecast_hour_by_hour": "forecast_hour_by_hour", + "credit": + { + "text": "Weather forecast from yr.no, delivered by the Norwegian Meteorological Institute and the NRK", + "url": "http://www.yr.no/" + } +} diff --git a/ayr/languages/nb.json b/ayr/languages/nb.json new file mode 100644 index 0000000..4f4b44b --- /dev/null +++ b/ayr/languages/nb.json @@ -0,0 +1,11 @@ +{ + "language": "nb", + "place": "sted", + "forecast": "varsel", + "forecast_hour_by_hour": "varsel_time_for_time", + "credit": + { + "text": "Værvarsel fra yr.no, levert av Meteorologisk institutt og NRK", + "url": "http://www.yr.no/" + } +} diff --git a/ayr/languages/nn.json b/ayr/languages/nn.json new file mode 100644 index 0000000..f259b3e --- /dev/null +++ b/ayr/languages/nn.json @@ -0,0 +1,11 @@ +{ + "language": "nn", + "place": "stad", + "forecast": "varsel", + "forecast_hour_by_hour": "varsel_time_for_time", + "credit": + { + "text": "Vêrvarsel frå yr.no, levert av Meteorologisk institutt og NRK", + "url": "http://www.yr.no/" + } +} diff --git a/ayr/libayr.py b/ayr/libayr.py new file mode 100644 index 0000000..4f6d773 --- /dev/null +++ b/ayr/libayr.py @@ -0,0 +1,138 @@ +#!/usr/bin/env python3 + +import logging +import json +import xmltodict # <~ the only external dependency +from ayr.utils import Connect, Location, API_Locationforecast, Language, YrException +import asyncio + +class Yr: + + default_forecast_link = 'forecast' + default_language_name = 'en' + + def py2json(self, python): + return json.dumps(python, indent=4) + + def xml2dict(self, xml): + return xmltodict.parse(xml) + + def dict2xml(self, dictionary): + return xmltodict.unparse(dictionary, pretty=True) + + def py2result(self, python, as_json=False): # default is return result as dictionary ;) + if as_json: + return self.py2json(python) + else: + return python + + async def forecast(self, as_json=False): + data = await self.data() + if self.coordinates: + times = data['weatherdata']['product']['time'] + else: + times = data['weatherdata']['forecast']['tabular']['time'] + return [self.py2result(time, as_json) for time in times] + + async def now(self, as_json=False): + forecast = await self.forecast(as_json) + return forecast[0] + + def __init__( + self, + location_name=None, + coordinates=None, + location_xyz=None, + forecast_link=default_forecast_link, + language_name=default_language_name, + ): + self.forecast_link = forecast_link + self.language_name = language_name + self.language = Language(language_name=self.language_name) + + if location_xyz: + if len(location_xyz) > 2: + coordinates = (location_xyz[1], location_xyz[0], location_xyz[2]) + else: + coordinates = (location_xyz[1], location_xyz[0]) + self.location_xyz = location_xyz + + if location_name: + self.location_name = location_name + self.coordinates = None + self.location = Location( + location_name=self.location_name, + forecast_link=self.forecast_link, + language=self.language, + ) + elif coordinates: + self.location_name = None + self.coordinates = coordinates + if len(self.coordinates) > 2: + self.location = API_Locationforecast( + lat=self.coordinates[0], + lon=self.coordinates[1], + msl=self.coordinates[2], + language=self.language, + ) + else: + self.location = API_Locationforecast( + lat=self.coordinates[0], + lon=self.coordinates[1], + language=self.language, + ) + else: + raise YrException('location_name or location_xyz parameter must be set') + + self.connect = Connect(location=self.location) + self.xml_source = None + self.dictionary = None + self.credit = self.language.dictionary['credit'] + + async def data(self): + if self.dictionary is None: + self.xml_source = await self.connect.read() + self.dictionary = self.xml2dict(self.xml_source) + return self.dictionary + +async def main(): + logging.info('starting __main__') + + weatherdata = await Yr( + location_name='Czech_Republic/Prague/Prague', + forecast_link='forecast', + language_name='en', + ).now(as_json=True) + # print(weatherdata) + + weatherdata = await Yr( + location_name='Czech_Republic/Prague/Prague', + forecast_link='forecast_hour_by_hour', + language_name='en', + ).now(as_json=True) + # print(weatherdata) + + weatherdata = await Yr( + location_xyz=(14.4656239, 50.0596696, 11), + language_name='en', + ).now(as_json=True) + # print(weatherdata) + + weatherdata = await Yr( + coordinates=(50.0596696, 14.4656239, 11), + language_name='en', + ).now(as_json=True) + # print(weatherdata) + + weatherdata = await Yr( + coordinates=(63.4066631, 10.4426724, 10), + language_name='en' + ).now(as_json=True) + # print(weatherdata) + + logging.info('stopping __main__') + +if __name__ == '__main__': + logging.basicConfig(level=logging.DEBUG) + loop = asyncio.get_event_loop() + loop.run_until_complete(main()) \ No newline at end of file diff --git a/ayr/utils.py b/ayr/utils.py new file mode 100644 index 0000000..a6d53c8 --- /dev/null +++ b/ayr/utils.py @@ -0,0 +1,254 @@ +#!/usr/bin/env python3 + +import logging +import os.path +import json # Language +import tempfile # Cache +import datetime # Cache +import urllib.parse # Location +import xmltodict +import aiohttp + +log = logging.getLogger(__name__) + + +class YrObject: + + script_directory = os.path.dirname(os.path.abspath(__file__)) # directory of the script + encoding = 'utf-8' + + +class YrException(Exception): + + def __init__(self, message): + log.error(message) + raise + + +class Language(YrObject): + + directory = 'languages' + default_language_name = 'en' + extension = 'json' + + def __init__(self, language_name=default_language_name): + self.language_name = language_name + self.filename = os.path.join( + self.script_directory, + self.directory, + '{language_name}.{extension}'.format( + language_name=self.language_name, + extension=self.extension, + ), # basename of filename + ) + self.dictionary = self.get_dictionary() + + def get_dictionary(self): + try: + log.info('read language dictionary: {}'.format(self.filename)) + with open(self.filename, mode='r', encoding=self.encoding) as f: + return json.load(f) + except Exception as e: + raise YrException(e) + + +class Location(YrObject): + + base_url = 'http://www.yr.no/' + default_forecast_link = 'forecast' + forecast_links = [default_forecast_link, 'forecast_hour_by_hour'] + extension = 'xml' + + def __init__(self, location_name, forecast_link=default_forecast_link, language=False): + self.location_name = location_name + self.language = language if isinstance(language, Language) else Language() + + if forecast_link in self.forecast_links: # must be valid forecast_link + self.forecast_link = self.language.dictionary[forecast_link] + else: + self.forecast_link = self.default_forecast_link + + self.url = self.get_url() + self.hash = self.get_hash() + + def get_url(self): + return '{base_url}{place}/{location_name}/{forecast_link}.{extension}'.format( + base_url=self.base_url, + place=self.language.dictionary['place'], + location_name=urllib.parse.quote(self.location_name), + forecast_link=self.forecast_link, + extension=self.extension, + ) + + def get_hash(self): + return '{location_name}.{forecast_link}'.format( + location_name=self.location_name.replace('/', '-'), + forecast_link=self.forecast_link, + ) + + +class API_Locationforecast(YrObject): + + """Class to use the API of api.met.no""" + + base_url = 'https://api.met.no/weatherapi/locationforecast/1.9/?' + forecast_link = 'locationforecast' + + def __init__(self, lat, lon, msl=0, language=False): + """ + :param double lat: latitude coordinate + :param double lon: longitude coordinate + :param double msl: altitude (meters above sea level) + :param language: a Language object + """ + self.coordinates = dict(lat=lat, lon=lon, msl=msl) + self.location_name = 'lat={lat};lon={lon};msl={msl}'.format(**self.coordinates) + # self.language = language if isinstance(language, Language) else Language() + self.url = self.get_url() + self.hash = self.get_hash() + + def get_url(self): + """Return the url of API service""" + return '{base_url}{location_name}'.format( + base_url=self.base_url, + location_name=self.location_name, + ) + + def get_hash(self): + """Create an hash with the three coordinates""" + return '{location_name}.{forecast_link}'.format( + location_name=self.location_name, + forecast_link=self.forecast_link, + ) + + +class LocationXYZ(API_Locationforecast): # ~> Deprecated!!! + + """Class to use the API of yr.no""" + + def __init__(self, x, y, z=0, language=False): + """ + :param double x: longitude coordinate + :param double y: latitude coordinate + :param double z: altitude (meters above sea level) + :param language: a Language object + """ + super().__init__(y, x, z, language) + + +class Connect(YrObject): + + def __init__(self, location): + self.location = location + + async def read(self): + try: + log.info('weatherdata request: {}, forecast-link: {}'.format( + self.location.location_name, + self.location.forecast_link, + )) + cache = Cache(self.location) + if not cache.exists() or not cache.is_fresh(): + log.info('read online: {}'.format(self.location.url)) + async with aiohttp.ClientSession() as session: + async with session.get(self.location.url) as response: + if response.status != 200: + raise + weatherdata = await response.text() + cache.dump(weatherdata) + else: + weatherdata = cache.load() + return weatherdata + except Exception as e: + raise YrException(e) + + +class Cache(YrObject): + + directory = tempfile.gettempdir() + extension = 'xml' + timeout = 15 # cache timeout in minutes + + def __init__(self, location): + self.location = location + self.filename = os.path.join( + self.directory, + '{location_hash}.{extension}'.format( + location_hash=self.location.hash, + extension=self.extension, + ), # basename of filename + ) + + def dump(self, data): + log.info('writing cachefile: {}'.format(self.filename)) + with open(self.filename, mode='w', encoding=self.encoding) as f: + f.write(data) + + def valid_until_timestamp_from_file(self): + xmldata = self.load() + d = xmltodict.parse(xmldata) + meta = d['weatherdata']['meta'] + if isinstance(self.location, API_Locationforecast): + if isinstance(meta['model'], dict): + next_update = meta['model']['@nextrun'] + elif isinstance(meta['model'], list): + next_update = meta['model'][0]['@nextrun'] + else: + return False + next_update = next_update.replace("Z", " +0000") + date_format = "%Y-%m-%dT%H:%M:%S %z" + # Read the UTC timestamp, convert to local time and remove the timezone information. + valid_until = datetime.datetime.strptime(next_update,date_format) + valid_until = valid_until.replace(tzinfo=datetime.timezone.utc).astimezone(tz=None).replace(tzinfo=None) + else: + next_update = meta['nextupdate'] + date_format = '%Y-%m-%dT%H:%M:%S' + valid_until = datetime.datetime.strptime(next_update, date_format) + # hotfix API_Locationforecast ++ @nextrun <<< + log.info('Cache is valid until {}'.format(valid_until)) + return valid_until + + def is_fresh(self): + log.info('Now is {}'.format(datetime.datetime.now())) + return datetime.datetime.now() <= self.valid_until_timestamp_from_file() + + def exists(self): + return os.path.isfile(self.filename) + + def load(self): + log.info('read from cachefile: {}'.format(self.filename)) + with open(self.filename, mode='r', encoding=self.encoding) as f: + return f.read() + + def remove(self): + if os.path.isfile(self.filename): + os.remove(self.filename) + log.info('removed cachefile: {}'.format(self.filename)) + +if __name__ == '__main__': + logging.basicConfig(level=logging.DEBUG) + logging.info('starting __main__') + + weatherdata = Connect(Location( + location_name='Czech_Republic/Prague/Prague', + forecast_link='forecast', + language=Language(language_name='en'), + )).read() + # print(weatherdata) + + weatherdata = Connect(Location( + location_name='Czech_Republic/Prague/Prague', + forecast_link='forecast_hour_by_hour', + language=Language(language_name='en'), + )).read() + # print(weatherdata) + + weatherdata = Connect(API_Locationforecast( + 50.0596696, + 14.4656239, + 11, + language=Language(language_name='en'), + )).read() + # print(weatherdata) + + logging.info('stopping __main__') diff --git a/setup.py b/setup.py index 5f5e904..fa04e7a 100644 --- a/setup.py +++ b/setup.py @@ -1,13 +1,32 @@ #!/usr/bin/env python3 -from distutils.core import setup +try: + from setuptools import setup +except ImportError: + from distutils.core import setup -setup(name='python-yr', - version='1.2.1-dev', - description='Get the forecast from the norwegian wheather service yr.no in python', - author='Alexander Hansen, idxxx23 @ github', - author_email='alexander.l.hansen@gmail.com', - url='https://github.com/wckd/python-yr', - packages=['yr'], - install_requires=['requests', 'xmltodict', 'beautifulsoup4'], - ) +setup( + name='python-ayr', + version='0.0.1', + description='Asynchronously get the forecast from the norwegian weather service yr.no in python', + long_description=open('README.rst').read(), + author='Kristian von Streng Haehre', + author_email='kristian.vsh@gmail.com', + url='https://github.com/vonstring/python-ayr', + packages=['ayr'], + classifiers=[ # https://pypi.python.org/pypi?%3Aaction=list_classifiers + 'Programming Language :: Python :: 3', + 'Programming Language :: Python', + 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', + 'Operating System :: OS Independent', + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: Developers', + 'Topic :: Internet', + ], + package_data={ + 'ayr': [ + 'languages/*.json', + ], + }, + install_requires=['xmltodict', 'aiohttp'], # $$solve$$ ~> /usr/lib/python3.4/distutils/dist.py:260: UserWarning: Unknown distribution option: 'install_requires' warnings.warn(msg) +) diff --git a/yr/examples/client.py b/yr/examples/client.py deleted file mode 100644 index 8e51323..0000000 --- a/yr/examples/client.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python3 - -import os.path, sys -parent_directory = os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir)) -sys.path.append(parent_directory) -from libyr import Yr - -weather = Yr('Norge/Telemark/Skien/Skien') -#weather = Yr('Czech_Republic/Prague/Prague') - -print(weather.now(as_json=True)) diff --git a/yr/languages/en.json b/yr/languages/en.json deleted file mode 100644 index 9a10ee0..0000000 --- a/yr/languages/en.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "language": "en", - "place": "place", - "forecast": "forecast", - "credit": "Weather forecast from yr.no, delivered by the Norwegian Meteorological Institute and the NRK" -} diff --git a/yr/languages/nb.json b/yr/languages/nb.json deleted file mode 100644 index 8f725d4..0000000 --- a/yr/languages/nb.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "language": "nb", - "place": "sted", - "forecast": "varsel", - "credit": "Værvarsel fra yr.no, levert av Meteorologisk institutt og NRK" -} diff --git a/yr/languages/nn.json b/yr/languages/nn.json deleted file mode 100644 index 6e6a0b1..0000000 --- a/yr/languages/nn.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "language": "nn", - "place": "stad", - "forecast": "varsel", - "credit": "Vêrvarsel frå yr.no, levert av Meteorologisk institutt og NRK" -} diff --git a/yr/libyr.py b/yr/libyr.py deleted file mode 100644 index 0b2c221..0000000 --- a/yr/libyr.py +++ /dev/null @@ -1,170 +0,0 @@ -#!/usr/bin/env python3 -import sys, json -from utils import Location, Connect, Cache, Language - -class Yr: - - def xmlsource(self): - data = Connect(self.location).read() - return data - - def xmltosoup(self, xml=None): - try: - from bs4 import BeautifulSoup - except ImportError: - sys.stderr.write('import error: from bs4 import BeautifulSoup\n') - sys.exit(1) - if xml is None: - return BeautifulSoup(self.xmlsource()) - else: - return BeautifulSoup(xml) - - def xmltodict(self, xml=None): - try: - import xmltodict - except ImportError: - sys.stderr.write('import error: import xmltodict\n') - sys.exit(1) - if xml is None: - return xmltodict.parse(self.xmlsource()) - else: - return xmltodict.parse(xml) - - def xmltojson(self, xml=None): - return json.dumps(self.xmltodict(xml), indent=4) - - def now(self, as_json=False): # default is return result as dict ;) - soup = self.xmltosoup() - xml = str(soup.forecast.tabular.time) - if as_json: - return self.xmltojson(xml) - else: - return self.xmltodict(xml) - - def __init__(self, location_name, language='en'): - self.location_name = location_name - self.language = language - self._ = Language(self.language).get_dictionary() - self.location = Location(self.location_name, self.language) - self.yr_credit = { - 'text': self._['credit'], - 'url': 'http://www.yr.no/' - } - - """ - def temperature(self): - ''' - Get temperature from yr and return it. - ''' - getlocation = Location(self.location_name, self.language).find() - cache = Cache(getlocation, 'temperature') - if cache.exists() and cache.is_fresh(): - return json.loads(cache.read()) - data = Connect(getlocation).read() - data = et.fromstring(data) - out = {} - for parent in data[5].iter('temperature'): - if parent.attrib: - out['data'] = parent.attrib - out['credit'] = self.yr_credit - cache.write(json.dumps(out)) - return out - - def wind_speed(self): - ''' - Get wind speed from yr. - ''' - getlocation = Location(self.location_name, self.language).find() - cache = Cache(getlocation, 'windspeed') - if cache.exists() and cache.is_fresh(): - return json.loads(cache.read()) - data = Connect(getlocation).read() - data = et.fromstring(data) - out = {} - for parent in data[5].iter('windSpeed'): - if parent.attrib: - out['data'] = parent.attrib - out['credit'] = self.yr_credit - cache.write(json.dumps(out)) - return out - - def wind_direction(self): - ''' - Get wind direction from yr. - ''' - getlocation = Location(self.location_name, self.language).find() - cache = Cache(getlocation, 'wind_direction') - if cache.exists() and cache.is_fresh(): - return json.loads(cache.read()) - data = Connect(getlocation).read() - data = et.fromstring(data) - out = {} - for parent in data[5].iter('windDirection'): - if parent.attrib: - out['data'] = parent.attrib - out['credit'] = self.yr_credit - cache.write(json.dumps(out)) - return out - - def forecast(self): - getlocation = Location(self.location_name, self.language).find() - cache = Cache(getlocation, 'forecast') - if cache.exists() and cache.is_fresh(): - return json.loads(cache.read()) - data = Connect(getlocation).read() - data = et.fromstring(data) - days = [] - for parent in data[5][0].iter('text'): - for child in parent[0]: - days.append({ - 'from': child.get('from'), - 'to': child.get('to'), - child[0].tag: child[0].text, - child[1].tag: child[1].text, - }) - out = {} - out['data'] = days - out['credit'] = self.yr_credit - cache.write(json.dumps(out)) - return out - - def observations(self): - getlocation = Location(self.location_name, self.language).find() - cache = Cache(getlocation, 'observations') - if cache.exists() and cache.is_fresh(): - return json.loads(cache.read()) - data = Connect(getlocation).read() - data = et.fromstring(data) - observations = {} - observations['data'] = {} - for parent in data[6].iter('weatherstation'): - stno = parent.attrib['stno'] - observations['data'][stno] = parent.attrib - for child in parent: - tag = child.tag - observations['data'][stno][tag] = child.attrib - observations['credit'] = self.yr_credit - cache.write(json.dumps(observations)) - return observations - - def location_info(self): - getlocation = Location(self.location_name, self.language).find() - cache = Cache(getlocation, 'location') - if cache.exists() and cache.is_fresh(): - return json.loads(cache.read()) - data = Connect(getlocation).read() - data = et.fromstring(data) - location_list = [] - location = {} - for parent in data[0]: - if parent.attrib: - location_list.append(parent.attrib) - else: - location_list.append({ - parent.tag: parent.text - }) - location['data'] = location_list - location['credit'] = self.yr_credit - cache.write(json.dumps(location)) - return location - """ diff --git a/yr/utils.py b/yr/utils.py deleted file mode 100644 index e8bcefc..0000000 --- a/yr/utils.py +++ /dev/null @@ -1,75 +0,0 @@ -#!/usr/bin/env python3 -import os.path, sys, json, hashlib, requests, tempfile, datetime - -class Language: - - def __init__(self, language): - self.language = language - - def get_dictionary(self): - path = os.path.abspath(os.path.dirname(__file__)) - filename = '{}/languages/{}.json'.format(path, self.language) - if os.path.exists(filename): - with open(filename, mode='r', encoding='utf-8') as f: - return json.load(f) - else: - sys.stderr.write('error: unsupported language ~> {}\n'.format(self.language)) - sys.exit(1) - -class Location: - - def __init__(self, location_name, language): - self.location_name = location_name - self.language = language - self._ = Language(self.language).get_dictionary() - self.url = self.get_url() - self.hash = self.get_hash() - - def get_url(self): - result = 'http://www.yr.no/{place}/{location_name}/{forecast}.xml'.format(location_name=self.location_name, **self._) - return result - - def get_hash(self): - result = hashlib.sha256(self.location_name.encode('utf-8')).hexdigest()[:12] - return result - -class Connect: - - def __init__(self, location): - self.location = location - - def read(self): - cache = Cache(self.location, 'forecast') - if not cache.exists() or not cache.is_fresh(): - yr = requests.get(self.location.url) - if not yr.status_code == requests.codes.ok: - yr.raise_for_status() - cache.write(yr.text) #.encode('utf-8') $$bug$$ ~> create empty forecast file in my /tmp/ - data = cache.read() - return data - -class Cache: - - cache_timeout = 30 # cache timeout in minutes - - def __init__(self, location, what): - self.location = location - self.cache_filename = '{}/{}.{}'.format(tempfile.gettempdir(), self.location.hash, what) - - def write(self, data): - with open(self.cache_filename, mode='w', encoding='utf-8') as f: - f.write(data) - - def is_fresh(self): - modified = datetime.datetime.fromtimestamp(os.path.getmtime(self.cache_filename)) - result = datetime.datetime.now() - modified <= datetime.timedelta(minutes=self.cache_timeout) - return result - - def exists(self): - result = os.path.isfile(self.cache_filename) - return result - - def read(self): - with open(self.cache_filename, mode='r', encoding='utf-8') as f: - data = f.read() - return data