e-data
Advanced tools
| Metadata-Version: 2.4 | ||
| Name: e-data | ||
| Version: 1.3.2 | ||
| Summary: Python library for managing spanish energy data from various web providers | ||
| Author-email: VMG <vmayorg@outlook.es> | ||
| License: GNU GENERAL PUBLIC LICENSE | ||
| Version 3, 29 June 2007 | ||
| Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||
| 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. | ||
| <one line to give the program's name and a brief idea of what it does.> | ||
| Copyright (C) <year> <name of author> | ||
| 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 <https://www.gnu.org/licenses/>. | ||
| 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: | ||
| <program> Copyright (C) <year> <name of author> | ||
| 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 | ||
| <https://www.gnu.org/licenses/>. | ||
| 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 | ||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||
| Project-URL: Homepage, https://github.com/uvejota/python-edata | ||
| Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) | ||
| Classifier: Programming Language :: Python | ||
| Classifier: Programming Language :: Python :: 3.11 | ||
| Classifier: Programming Language :: Python :: 3.12 | ||
| Classifier: Programming Language :: Python :: Implementation :: CPython | ||
| Classifier: Programming Language :: Python :: Implementation :: PyPy | ||
| Requires-Python: >=3.11.0 | ||
| Description-Content-Type: text/markdown | ||
| License-File: LICENSE | ||
| Requires-Dist: dateparser>=1.1.2 | ||
| Requires-Dist: freezegun>=1.2.1 | ||
| Requires-Dist: holidays>=0.14.2 | ||
| Requires-Dist: pytest>=7.1.2 | ||
| Requires-Dist: python_dateutil>=2.8.2 | ||
| Requires-Dist: requests>=2.28.1 | ||
| Requires-Dist: voluptuous>=0.13.1 | ||
| Requires-Dist: Jinja2>=3.1.2 | ||
| Requires-Dist: diskcache>=5.6.3 | ||
| Requires-Dist: aiohttp>=3.12.15 | ||
| Dynamic: license-file | ||
| [](https://pepy.tech/project/e-data) | ||
| [](https://pepy.tech/project/e-data) | ||
| [](https://pepy.tech/project/e-data) | ||
| # python-edata | ||
| Este paquete proporciona herramientas para la descarga de tus datos de consumo eléctrico (desde Datadis.es) y su posterior procesado. La motivación principal es que conocer el consumo puede ayudarnos a reducirlo, e incluso a elegir una tarifa que mejor se adapte a nuestras necesidades. A día de hoy sus capacidades de facturación (€) son limitadas, soporta PVPC (según disponibilidad de datos de REData) y tarificación fija por tramos. Es el corazón de la integración [homeassistant-edata](https://github.com/uvejota/homeassistant-edata). | ||
| _**Esta herramienta no mantiene ningún tipo de vinculación con los proveedores de datos anteriormente mencionados, simplemente consulta la información disponible y facilita su posterior análisis.**_ | ||
| ## Instalación | ||
| Puedes instalar la última versión estable mediante: | ||
| ``` bash | ||
| pip install e-data | ||
| ``` | ||
| Si quieres probar la versión `dev` o contribuir a su desarrollo, clona este repositorio e instala manualmente las dependencias: | ||
| ``` bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
| ## Estructura | ||
| El paquete consta de tres módulos diferenciados: | ||
| * **Conectores** (módulo `connectors`), para definir los métodos de consulta a los diferentes proveedores: Datadis y REData. | ||
| * **Procesadores** (módulo `processors`), para procesar datos de consumo, maxímetro, o coste (tarificación). Ahora mismo consta de tres procesadores: `billing`, `consumption` y `maximeter`, además de algunas utilidades ubicadas en `utils`. Los procesadores deben heredar de la clase Processor definida en `base.py` | ||
| * **Ayudantes** (módulo `helpers`), para ayudar en el uso y gestión de los anteriores, presentando de momento un único ayudante llamado `EdataHelper` que te permite recopilar `X` días de datos (por defecto 365) y automáticamente procesarlos. Los datos son almacenados en la variable `data`, mientras que los atributos autocalculados son almacenados en la variable `attributes`. Por lo general, primero utilizan los conectores y luego procesan los datos, gestionando varias tareas de recuperación (principalmente para Datadis). | ||
| Estos módulos corresponden a la siguiente estructura del paquete: | ||
| ``` | ||
| edata/ | ||
| · __init__.py | ||
| · connectors/ | ||
| · __init__.py | ||
| · datadis.py | ||
| · redata.py | ||
| · processors/ | ||
| · __init__.py | ||
| · base.py | ||
| · billing.py | ||
| · consumption.py | ||
| · maximeter.py | ||
| · utils.py | ||
| · helpers.py | ||
| ``` | ||
| ## Ejemplo de uso | ||
| Partimos de que tenemos credenciales en Datadis.es. Algunas aclaraciones: | ||
| * No es necesario solicitar API pública en el registro (se utilizará la API privada habilitada por defecto) | ||
| * El username suele ser el NIF del titular | ||
| * Copie el CUPS de la web de Datadis, algunas comercializadoras adhieren caracteres adicionales en el CUPS mostrado en su factura. | ||
| * La herramienta acepta el uso de NIF autorizado para consultar el suministro de otro titular. | ||
| ``` python | ||
| from datetime import datetime | ||
| import json | ||
| # importamos definiciones de datos que nos interesen | ||
| from edata.definitions import PricingRules | ||
| # importamos el ayudante | ||
| from edata.helpers import EdataHelper | ||
| # importamos el procesador de utilidades | ||
| from edata.processors import utils | ||
| # Preparar reglas de tarificación (si se quiere) | ||
| PRICING_RULES_PVPC = PricingRules( | ||
| p1_kw_year_eur=30.67266, | ||
| p2_kw_year_eur=1.4243591, | ||
| meter_month_eur=0.81, | ||
| market_kw_year_eur=3.113, | ||
| electricity_tax=1.0511300560, | ||
| iva_tax=1.05, | ||
| # podemos rellenar los siguientes campos si quisiéramos precio fijo (y no pvpc) | ||
| p1_kwh_eur=None, | ||
| p2_kwh_eur=None, | ||
| p3_kwh_eur=None, | ||
| ) | ||
| # Instanciar el helper | ||
| # 'authorized_nif' permite indicar el NIF de la persona que nos autoriza a consultar su CUPS. | ||
| # 'data' permite "cargar" al helper datos anteriores (resultado edata.data de una ejecución anterior), para evitar volver a consultar los mismos. | ||
| edata = EdataHelper( | ||
| "datadis_user", | ||
| "datadis_password", | ||
| "cups", | ||
| datadis_authorized_nif=None, | ||
| pricing_rules=PRICING_RULES_PVPC, # si se le pasa None, no aplica tarificación | ||
| data=None, # aquí podríamos cargar datos anteriores | ||
| ) | ||
| # Solicitar actualización de todo el histórico (se almacena en edata.data) | ||
| edata.update(date_from=datetime(1970, 1, 1), date_to=datetime.today()) | ||
| # volcamos todo lo obtenido a un fichero | ||
| with open("backup.json", "w") as file: | ||
| json.dump(utils.serialize_dict(edata.data), file) # se puede utilizar deserialize_dict para la posterior lectura del backup | ||
| # Imprimir atributos | ||
| print(edata.attributes) | ||
| ``` |
| dateparser>=1.1.2 | ||
| freezegun>=1.2.1 | ||
| holidays>=0.14.2 | ||
| pytest>=7.1.2 | ||
| python_dateutil>=2.8.2 | ||
| requests>=2.28.1 | ||
| voluptuous>=0.13.1 | ||
| Jinja2>=3.1.2 | ||
| diskcache>=5.6.3 | ||
| aiohttp>=3.12.15 |
| LICENSE | ||
| MANIFEST.in | ||
| README.md | ||
| pyproject.toml | ||
| e_data.egg-info/PKG-INFO | ||
| e_data.egg-info/SOURCES.txt | ||
| e_data.egg-info/dependency_links.txt | ||
| e_data.egg-info/requires.txt | ||
| e_data.egg-info/top_level.txt | ||
| edata/__init__.py | ||
| edata/const.py | ||
| edata/definitions.py | ||
| edata/helpers.py | ||
| edata/storage.py | ||
| edata/connectors/__init__.py | ||
| edata/connectors/datadis.py | ||
| edata/connectors/redata.py | ||
| edata/processors/__init__.py | ||
| edata/processors/base.py | ||
| edata/processors/billing.py | ||
| edata/processors/consumption.py | ||
| edata/processors/maximeter.py | ||
| edata/processors/utils.py | ||
| edata/tests/__init__.py | ||
| edata/tests/test_datadis_connector.py | ||
| edata/tests/test_helpers.py | ||
| edata/tests/test_processors.py | ||
| edata/tests/test_redata_connector.py |
| dist | ||
| edata |
| """Constants file.""" | ||
| PROG_NAME = "edata" |
| """Definitions for data structures.""" | ||
| import voluptuous as vol | ||
| import datetime as dt | ||
| from typing import TypedDict | ||
| ATTRIBUTES = { | ||
| "cups": None, | ||
| "contract_p1_kW": "kW", | ||
| "contract_p2_kW": "kW", | ||
| "yesterday_kWh": "kWh", | ||
| "yesterday_hours": "h", | ||
| "yesterday_p1_kWh": "kWh", | ||
| "yesterday_p2_kWh": "kWh", | ||
| "yesterday_p3_kWh": "kWh", | ||
| "yesterday_surplus_kWh": "kWh", | ||
| "yesterday_surplus_p1_kWh": "kWh", | ||
| "yesterday_surplus_p2_kWh": "kWh", | ||
| "yesterday_surplus_p3_kWh": "kWh", | ||
| "last_registered_date": None, | ||
| "last_registered_day_kWh": "kWh", | ||
| "last_registered_day_hours": "h", | ||
| "last_registered_day_p1_kWh": "kWh", | ||
| "last_registered_day_p2_kWh": "kWh", | ||
| "last_registered_day_p3_kWh": "kWh", | ||
| "last_registered_day_surplus_kWh": "kWh", | ||
| "last_registered_day_surplus_p1_kWh": "kWh", | ||
| "last_registered_day_surplus_p2_kWh": "kWh", | ||
| "last_registered_day_surplus_p3_kWh": "kWh", | ||
| "month_kWh": "kWh", | ||
| "month_daily_kWh": "kWh", | ||
| "month_days": "d", | ||
| "month_p1_kWh": "kWh", | ||
| "month_p2_kWh": "kWh", | ||
| "month_p3_kWh": "kWh", | ||
| "month_surplus_kWh": "kWh", | ||
| "month_surplus_p1_kWh": "kWh", | ||
| "month_surplus_p2_kWh": "kWh", | ||
| "month_surplus_p3_kWh": "kWh", | ||
| "month_€": "€", | ||
| "last_month_kWh": "kWh", | ||
| "last_month_daily_kWh": "kWh", | ||
| "last_month_days": "d", | ||
| "last_month_p1_kWh": "kWh", | ||
| "last_month_p2_kWh": "kWh", | ||
| "last_month_p3_kWh": "kWh", | ||
| "last_month_surplus_kWh": "kWh", | ||
| "last_month_surplus_p1_kWh": "kWh", | ||
| "last_month_surplus_p2_kWh": "kWh", | ||
| "last_month_surplus_p3_kWh": "kWh", | ||
| "last_month_€": "€", | ||
| "max_power_kW": "kW", | ||
| "max_power_date": None, | ||
| "max_power_mean_kW": "kW", | ||
| "max_power_90perc_kW": "kW", | ||
| } | ||
| # Energy term with taxes | ||
| DEFAULT_BILLING_ENERGY_FORMULA = "electricity_tax * iva_tax * kwh_eur * kwh" | ||
| # Power term with taxes | ||
| DEFAULT_BILLING_POWER_FORMULA = "electricity_tax * iva_tax * (p1_kw * (p1_kw_year_eur + market_kw_year_eur) + p2_kw * p2_kw_year_eur) / 365 / 24" | ||
| # Others term with taxes | ||
| DEFAULT_BILLING_OTHERS_FORMULA = "iva_tax * meter_month_eur / 30 / 24" | ||
| # Surplus term with taxes | ||
| DEFAULT_BILLING_SURPLUS_FORMULA = ( | ||
| "electricity_tax * iva_tax * surplus_kwh * surplus_kwh_eur" | ||
| ) | ||
| # Sum energy and power terms, and substract surplus until 0. | ||
| # An alternative would be "[(energy_term + power_term - surplus_term), 0]|max + others_term" | ||
| DEFAULT_BILLING_MAIN_FORMULA = "energy_term + power_term + others_term" | ||
| class SupplyData(TypedDict): | ||
| """Data structure to represent a supply.""" | ||
| cups: str | ||
| date_start: dt.datetime | ||
| date_end: dt.datetime | ||
| address: str | None | ||
| postal_code: str | None | ||
| province: str | None | ||
| municipality: str | None | ||
| distributor: str | None | ||
| pointType: int | ||
| distributorCode: str | ||
| SupplySchema = vol.Schema( | ||
| { | ||
| vol.Required("cups"): str, | ||
| vol.Required("date_start"): dt.datetime, | ||
| vol.Required("date_end"): dt.datetime, | ||
| vol.Required("address"): vol.Union(str, None), | ||
| vol.Required("postal_code"): vol.Union(str, None), | ||
| vol.Required("province"): vol.Union(str, None), | ||
| vol.Required("municipality"): vol.Union(str, None), | ||
| vol.Required("distributor"): vol.Union(str, None), | ||
| vol.Required("pointType"): int, | ||
| vol.Required("distributorCode"): str, | ||
| } | ||
| ) | ||
| class ContractData(TypedDict): | ||
| """Data structure to represent a contract.""" | ||
| date_start: dt.datetime | ||
| date_end: dt.datetime | ||
| marketer: str | ||
| distributorCode: str | ||
| power_p1: float | None | ||
| power_p2: float | None | ||
| ContractSchema = vol.Schema( | ||
| { | ||
| vol.Required("date_start"): dt.datetime, | ||
| vol.Required("date_end"): dt.datetime, | ||
| vol.Required("marketer"): str, | ||
| vol.Required("distributorCode"): str, | ||
| vol.Required("power_p1"): vol.Union(vol.Coerce(float), None), | ||
| vol.Required("power_p2"): vol.Union(vol.Coerce(float), None), | ||
| } | ||
| ) | ||
| class ConsumptionData(TypedDict): | ||
| """Data structure to represent a consumption.""" | ||
| datetime: dt.datetime | ||
| delta_h: float | ||
| value_kWh: float | ||
| surplus_kWh: float | ||
| real: bool | ||
| ConsumptionSchema = vol.Schema( | ||
| { | ||
| vol.Required("datetime"): dt.datetime, | ||
| vol.Required("delta_h"): vol.Coerce(float), | ||
| vol.Required("value_kWh"): vol.Coerce(float), | ||
| vol.Optional("surplus_kWh", default=0): vol.Coerce(float), | ||
| vol.Required("real"): bool, | ||
| } | ||
| ) | ||
| class MaxPowerData(TypedDict): | ||
| """Data structure to represent a MaxPower.""" | ||
| datetime: dt.datetime | ||
| value_kW: float | ||
| MaxPowerSchema = vol.Schema( | ||
| { | ||
| vol.Required("datetime"): dt.datetime, | ||
| vol.Required("value_kW"): vol.Coerce(float), | ||
| } | ||
| ) | ||
| class PricingData(TypedDict): | ||
| """Data structure to represent pricing data.""" | ||
| datetime: dt.datetime | ||
| value_eur_kWh: float | ||
| delta_h: float | ||
| PricingSchema = vol.Schema( | ||
| { | ||
| vol.Required("datetime"): dt.datetime, | ||
| vol.Required("value_eur_kWh"): vol.Coerce(float), | ||
| vol.Required("delta_h"): vol.Coerce(float), | ||
| } | ||
| ) | ||
| class PricingRules(TypedDict): | ||
| """Data structure to represent custom pricing rules.""" | ||
| p1_kw_year_eur: float | ||
| p2_kw_year_eur: float | ||
| p1_kwh_eur: float | None | ||
| p2_kwh_eur: float | None | ||
| p3_kwh_eur: float | None | ||
| surplus_p1_kwh_eur: float | None | ||
| surplus_p2_kwh_eur: float | None | ||
| surplus_p3_kwh_eur: float | None | ||
| meter_month_eur: float | ||
| market_kw_year_eur: float | ||
| electricity_tax: float | ||
| iva_tax: float | ||
| energy_formula: str | None | ||
| power_formula: str | None | ||
| others_formula: str | None | ||
| surplus_formula: str | None | ||
| cycle_start_day: int | None | ||
| PricingRulesSchema = vol.Schema( | ||
| { | ||
| vol.Required("p1_kw_year_eur"): vol.Coerce(float), | ||
| vol.Required("p2_kw_year_eur"): vol.Coerce(float), | ||
| vol.Optional("p1_kwh_eur", default=None): vol.Union(vol.Coerce(float), None), | ||
| vol.Optional("p2_kwh_eur", default=None): vol.Union(vol.Coerce(float), None), | ||
| vol.Optional("p3_kwh_eur", default=None): vol.Union(vol.Coerce(float), None), | ||
| vol.Optional("surplus_p1_kwh_eur", default=None): vol.Union( | ||
| vol.Coerce(float), None | ||
| ), | ||
| vol.Optional("surplus_p2_kwh_eur", default=None): vol.Union( | ||
| vol.Coerce(float), None | ||
| ), | ||
| vol.Optional("surplus_p3_kwh_eur", default=None): vol.Union( | ||
| vol.Coerce(float), None | ||
| ), | ||
| vol.Required("meter_month_eur"): vol.Coerce(float), | ||
| vol.Required("market_kw_year_eur"): vol.Coerce(float), | ||
| vol.Required("electricity_tax"): vol.Coerce(float), | ||
| vol.Required("iva_tax"): vol.Coerce(float), | ||
| vol.Optional("energy_formula", default=DEFAULT_BILLING_ENERGY_FORMULA): str, | ||
| vol.Optional("power_formula", default=DEFAULT_BILLING_POWER_FORMULA): str, | ||
| vol.Optional("others_formula", default=DEFAULT_BILLING_OTHERS_FORMULA): str, | ||
| vol.Optional("surplus_formula", default=DEFAULT_BILLING_SURPLUS_FORMULA): str, | ||
| vol.Optional("main_formula", default=DEFAULT_BILLING_MAIN_FORMULA): str, | ||
| vol.Optional("cycle_start_day", default=1): vol.Range(1, 30), | ||
| } | ||
| ) | ||
| DEFAULT_PVPC_RULES = PricingRules( | ||
| p1_kw_year_eur=30.67266, | ||
| p2_kw_year_eur=1.4243591, | ||
| meter_month_eur=0.81, | ||
| market_kw_year_eur=3.113, | ||
| electricity_tax=1.0511300560, | ||
| iva_tax=1.05, | ||
| ) | ||
| class ConsumptionAggData(TypedDict): | ||
| """A dict holding a Consumption item.""" | ||
| datetime: dt.datetime | ||
| value_kWh: float | ||
| value_p1_kWh: float | ||
| value_p2_kWh: float | ||
| value_p3_kWh: float | ||
| surplus_kWh: float | ||
| surplus_p1_kWh: float | ||
| surplus_p2_kWh: float | ||
| surplus_p3_kWh: float | ||
| delta_h: float | ||
| ConsumptionAggSchema = vol.Schema( | ||
| { | ||
| vol.Required("datetime"): dt.datetime, | ||
| vol.Required("value_kWh"): vol.Coerce(float), | ||
| vol.Required("value_p1_kWh"): vol.Coerce(float), | ||
| vol.Required("value_p2_kWh"): vol.Coerce(float), | ||
| vol.Required("value_p3_kWh"): vol.Coerce(float), | ||
| vol.Optional("surplus_kWh", default=0): vol.Coerce(float), | ||
| vol.Optional("surplus_p1_kWh", default=0): vol.Coerce(float), | ||
| vol.Optional("surplus_p2_kWh", default=0): vol.Coerce(float), | ||
| vol.Optional("surplus_p3_kWh", default=0): vol.Coerce(float), | ||
| vol.Required("delta_h"): vol.Coerce(float), | ||
| } | ||
| ) | ||
| class PricingAggData(TypedDict): | ||
| """A dict holding a Billing item.""" | ||
| datetime: dt.datetime | ||
| value_eur: float | ||
| energy_term: float | ||
| power_term: float | ||
| others_term: float | ||
| surplus_term: float | ||
| delta_h: float | ||
| PricingAggSchema = vol.Schema( | ||
| { | ||
| vol.Required("datetime"): dt.datetime, | ||
| vol.Required("value_eur"): vol.Coerce(float), | ||
| vol.Required("energy_term"): vol.Coerce(float), | ||
| vol.Required("power_term"): vol.Coerce(float), | ||
| vol.Required("others_term"): vol.Coerce(float), | ||
| vol.Optional("surplus_term", default=0): vol.Coerce(float), | ||
| vol.Optional("delta_h", default=1): vol.Coerce(float), | ||
| }, | ||
| ) | ||
| class EdataData(TypedDict): | ||
| """A Typed Dict to handle Edata Aggregated Data.""" | ||
| supplies: list[SupplyData] | ||
| contracts: list[ContractData] | ||
| consumptions: list[ConsumptionData] | ||
| maximeter: list[MaxPowerData] | ||
| pvpc: list[PricingData] | ||
| consumptions_daily_sum: list[ConsumptionAggData] | ||
| consumptions_monthly_sum: list[ConsumptionAggData] | ||
| cost_hourly_sum: list[PricingAggData] | ||
| cost_daily_sum: list[PricingAggData] | ||
| cost_monthly_sum: list[PricingAggData] | ||
| EdataSchema = vol.Schema( | ||
| { | ||
| vol.Required("supplies"): [SupplySchema], | ||
| vol.Required("contracts"): [ContractSchema], | ||
| vol.Required("consumptions"): [ConsumptionSchema], | ||
| vol.Required("maximeter"): [MaxPowerSchema], | ||
| vol.Optional("pvpc", default=[]): [PricingSchema], | ||
| vol.Optional("consumptions_daily_sum", []): [ConsumptionAggSchema], | ||
| vol.Optional("consumptions_monthly_sum", []): [ConsumptionAggSchema], | ||
| vol.Optional("cost_hourly_sum", default=[]): [PricingAggSchema], | ||
| vol.Optional("cost_daily_sum", default=[]): [PricingAggSchema], | ||
| vol.Optional("cost_monthly_sum", default=[]): [PricingAggSchema], | ||
| } | ||
| ) |
+769
| """A module for edata helpers.""" | ||
| import asyncio | ||
| import contextlib | ||
| from datetime import datetime, timedelta | ||
| import logging | ||
| import os | ||
| from dateutil.relativedelta import relativedelta | ||
| import requests | ||
| from . import const | ||
| from .connectors.datadis import DatadisConnector | ||
| from .connectors.redata import REDataConnector | ||
| from .definitions import ATTRIBUTES, EdataData, PricingRules | ||
| from .processors import utils | ||
| from .processors.billing import BillingInput, BillingProcessor | ||
| from .processors.consumption import ConsumptionProcessor | ||
| from .processors.maximeter import MaximeterProcessor | ||
| from .storage import check_storage_integrity, dump_storage, load_storage | ||
| _LOGGER = logging.getLogger(__name__) | ||
| def acups(cups): | ||
| """Print an abbreviated and anonymized CUPS.""" | ||
| return cups[-5:] | ||
| class EdataHelper: | ||
| """Main EdataHelper class.""" | ||
| UPDATE_INTERVAL = timedelta(hours=1) | ||
| def __init__( | ||
| self, | ||
| datadis_username: str, | ||
| datadis_password: str, | ||
| cups: str, | ||
| datadis_authorized_nif: str | None = None, | ||
| pricing_rules: PricingRules | None = None, | ||
| storage_dir_path: str | None = None, | ||
| data: EdataData | None = None, | ||
| ) -> None: | ||
| self.data = EdataData( | ||
| supplies=[], | ||
| contracts=[], | ||
| consumptions=[], | ||
| maximeter=[], | ||
| pvpc=[], | ||
| consumptions_daily_sum=[], | ||
| consumptions_monthly_sum=[], | ||
| cost_hourly_sum=[], | ||
| cost_daily_sum=[], | ||
| cost_monthly_sum=[], | ||
| ) | ||
| self.attributes = {} | ||
| self._storage_dir = storage_dir_path | ||
| self._cups = cups | ||
| self._scups = acups(cups) | ||
| self._authorized_nif = datadis_authorized_nif | ||
| self.last_update = {x: datetime(1970, 1, 1) for x in self.data} | ||
| self._date_from = datetime(1970, 1, 1) | ||
| self._date_to = datetime.today() | ||
| self._must_dump = True | ||
| self._incremental_update = True | ||
| if data is not None: | ||
| data = check_storage_integrity(data) | ||
| self.data = data | ||
| else: | ||
| with contextlib.suppress(Exception): | ||
| self.data = load_storage(self._cups, self._storage_dir) | ||
| for attr in ATTRIBUTES: | ||
| self.attributes[attr] = None | ||
| self.datadis_api = DatadisConnector( | ||
| datadis_username, | ||
| datadis_password, | ||
| storage_path=( | ||
| os.path.join(storage_dir_path, const.PROG_NAME) | ||
| if storage_dir_path is not None | ||
| else None | ||
| ), | ||
| ) | ||
| self.redata_api = REDataConnector() | ||
| self.pricing_rules = pricing_rules | ||
| if self.pricing_rules is not None: | ||
| self.enable_billing = True | ||
| if not all( | ||
| x in self.pricing_rules and self.pricing_rules[x] is not None | ||
| for x in ("p1_kwh_eur", "p2_kwh_eur", "p3_kwh_eur") | ||
| ): | ||
| self.is_pvpc = True | ||
| else: | ||
| self.is_pvpc = False | ||
| else: | ||
| self.enable_billing = False | ||
| self.is_pvpc = False | ||
| async def async_update( | ||
| self, | ||
| date_from: datetime = datetime(1970, 1, 1), | ||
| date_to: datetime = datetime.today(), | ||
| incremental_update: bool = True, | ||
| ): | ||
| """Async call of update method.""" | ||
| _LOGGER.info( | ||
| "%s: update triggered", | ||
| self._scups, | ||
| ) | ||
| self._date_from = date_from | ||
| self._date_to = date_to | ||
| # update datadis resources | ||
| await self.update_datadis(self._cups, date_from, date_to) | ||
| # update redata resources if pvpc is requested | ||
| if self.is_pvpc: | ||
| try: | ||
| await asyncio.to_thread(self.update_redata, date_from, date_to) | ||
| except requests.exceptions.Timeout: | ||
| _LOGGER.error("Timeout exception while updating from REData") | ||
| await asyncio.to_thread(self.process_data, incremental_update=incremental_update) | ||
| if self._must_dump: | ||
| await asyncio.to_thread(dump_storage, self._cups, self.data, self._storage_dir) | ||
| def update( | ||
| self, | ||
| date_from: datetime = datetime(1970, 1, 1), | ||
| date_to: datetime = datetime.today(), | ||
| incremental_update: bool = True, | ||
| ): | ||
| """Update synchronously.""" | ||
| asyncio.run(self.async_update(date_from, date_to, incremental_update)) | ||
| async def update_supplies(self): | ||
| """Update supplies.""" | ||
| _LOGGER.debug("%s: supplies update triggered", self._scups) | ||
| if datetime.today().date() != self.last_update["supplies"].date(): | ||
| # if supplies haven't been updated today | ||
| supplies = await self.datadis_api.async_get_supplies( | ||
| authorized_nif=self._authorized_nif | ||
| ) # fetch supplies | ||
| if len(supplies) > 0: | ||
| self.data["supplies"] = supplies | ||
| # if we got something, update last_update flag | ||
| self.last_update["supplies"] = datetime.now() | ||
| _LOGGER.info("%s: supplies update succeeded", self._scups) | ||
| else: | ||
| _LOGGER.info("%s: supplies are already updated (skipping)", self._scups) | ||
| async def update_contracts(self, cups: str, distributor_code: str): | ||
| """Update contracts.""" | ||
| _LOGGER.debug("%s: contracts update triggered", self._scups) | ||
| if datetime.today().date() != self.last_update["contracts"].date(): | ||
| # if contracts haven't been updated today | ||
| contracts = await self.datadis_api.async_get_contract_detail( | ||
| cups, distributor_code, authorized_nif=self._authorized_nif | ||
| ) | ||
| if len(contracts) > 0: | ||
| self.data["contracts"] = utils.extend_by_key( | ||
| self.data["contracts"], contracts, "date_start" | ||
| ) # extend contracts data with new ones | ||
| # if we got something, update last_update flag | ||
| self.last_update["contracts"] = datetime.now() | ||
| _LOGGER.info("%s: contracts update succeeded", self._scups) | ||
| else: | ||
| _LOGGER.info("%s: contracts are already updated (skipping)", self._scups) | ||
| async def update_consumptions( | ||
| self, | ||
| cups: str, | ||
| distributor_code: str, | ||
| start_date: datetime, | ||
| end_date: datetime, | ||
| measurement_type: str, | ||
| point_type: int, | ||
| ): | ||
| """Update consumptions.""" | ||
| _LOGGER.debug("%s: consumptions update triggered", self._scups) | ||
| if (datetime.now() - self.last_update["consumptions"]) > self.UPDATE_INTERVAL: | ||
| consumptions = await self.datadis_api.async_get_consumption_data( | ||
| cups, | ||
| distributor_code, | ||
| start_date, | ||
| end_date, | ||
| measurement_type, | ||
| point_type, | ||
| authorized_nif=self._authorized_nif, | ||
| ) | ||
| if len(consumptions) > 0: | ||
| _LOGGER.info( | ||
| "%s: got consumptions from %s to %s", | ||
| self._scups, | ||
| consumptions[0]["datetime"].isoformat(), | ||
| consumptions[-1]["datetime"].isoformat(), | ||
| ) | ||
| self.data["consumptions"] = utils.extend_by_key( | ||
| self.data["consumptions"], consumptions, "datetime" | ||
| ) | ||
| self.last_update["consumptions"] = datetime.now() | ||
| else: | ||
| _LOGGER.info("%s: consumptions are up to date", self._scups) | ||
| else: | ||
| _LOGGER.info("%s: consumptions are already updated (skipping)", self._scups) | ||
| async def update_maximeter(self, cups, distributor_code, start_date, end_date): | ||
| """Update maximeter.""" | ||
| _LOGGER.debug("%s: maximeter update triggered", self._scups) | ||
| if (datetime.now() - self.last_update["maximeter"]) > self.UPDATE_INTERVAL: | ||
| maximeter = await self.datadis_api.async_get_max_power( | ||
| cups, | ||
| distributor_code, | ||
| start_date, | ||
| end_date, | ||
| authorized_nif=self._authorized_nif, | ||
| ) | ||
| if len(maximeter) > 0: | ||
| _LOGGER.info( | ||
| "%s: maximeter update succeeded", | ||
| self._scups, | ||
| ) | ||
| self.data["maximeter"] = utils.extend_by_key( | ||
| self.data["maximeter"], maximeter, "datetime" | ||
| ) | ||
| self.last_update["maximeter"] = datetime.now() | ||
| else: | ||
| _LOGGER.info("%s: maximeter is up to date", self._scups) | ||
| else: | ||
| _LOGGER.info("%s: maximeter is already updated (skipping)", self._scups) | ||
| async def update_datadis( | ||
| self, | ||
| cups: str, | ||
| date_from: datetime = datetime(1970, 1, 1), | ||
| date_to: datetime = datetime.today(), | ||
| ): | ||
| """Update all data from Datadis.""" | ||
| _LOGGER.info( | ||
| "%s: datadis update triggered (from %s to %s)", | ||
| self._scups, | ||
| date_from.isoformat(), | ||
| date_to.isoformat(), | ||
| ) | ||
| # update supplies and get distributorCode | ||
| await self.update_supplies() | ||
| if len(self.data["supplies"]) == 0: | ||
| # return if no supplies were discovered | ||
| _LOGGER.warning( | ||
| "%s: supplies update failed or no supplies found in the provided account", | ||
| self._scups, | ||
| ) | ||
| return False | ||
| # find requested cups in supplies | ||
| supply = utils.get_by_key(self.data["supplies"], "cups", cups) | ||
| if supply is None: | ||
| # return if specified cups seems not valid | ||
| _LOGGER.error( | ||
| "%s: CUPS not found. Got: %s", | ||
| self._scups, | ||
| [acups(x["cups"]) for x in self.data["supplies"]], | ||
| ) | ||
| return False | ||
| _LOGGER.info("%s: CUPS found in account", self._scups) | ||
| # get some supply-related data | ||
| supply_date_start = supply["date_start"] | ||
| distributor_code = supply["distributorCode"] | ||
| point_type = supply["pointType"] | ||
| _LOGGER.info( | ||
| "%s: CUPS start date is %s", self._scups, supply_date_start.isoformat() | ||
| ) | ||
| _LOGGER.info( | ||
| "%s: CUPS end date is %s", self._scups, supply["date_end"].isoformat() | ||
| ) | ||
| # update contracts to get valid periods | ||
| await self.update_contracts(cups, distributor_code) | ||
| if len(self.data["contracts"]) == 0: | ||
| _LOGGER.warning( | ||
| "%s: contracts update failed or no contracts found in the provided account", | ||
| self._scups, | ||
| ) | ||
| # return False | ||
| # filter consumptions and maximeter, and log gaps | ||
| def sort_and_filter(dt_from, dt_to): | ||
| self.data["consumptions"], miss_cons = utils.extract_dt_ranges( | ||
| self.data["consumptions"], | ||
| dt_from, | ||
| dt_to, | ||
| gap_interval=timedelta(hours=6), | ||
| ) | ||
| self.data["maximeter"], miss_maxim = utils.extract_dt_ranges( | ||
| self.data["maximeter"], | ||
| dt_from, | ||
| dt_to, | ||
| gap_interval=timedelta(days=60), | ||
| ) | ||
| return miss_cons, miss_maxim | ||
| miss_cons, miss_maxim = sort_and_filter(date_from, date_to) | ||
| # update consumptions | ||
| _LOGGER.info( | ||
| "%s: missing consumptions: %s", | ||
| self._scups, | ||
| ", ".join( | ||
| [ | ||
| "from " | ||
| + (x["from"] + timedelta(hours=1)).isoformat() | ||
| + " to " | ||
| + x["to"].isoformat() | ||
| for x in miss_cons | ||
| ] | ||
| ), | ||
| ) | ||
| for gap in miss_cons: | ||
| if not ( | ||
| gap["to"] < supply["date_start"] or gap["from"] > supply["date_end"] | ||
| ): | ||
| # fetch consumptions for each consumptions gap in valid periods | ||
| start = max([gap["from"] + timedelta(hours=1), supply["date_start"]]) | ||
| end = min([gap["to"], supply["date_end"]]) | ||
| _LOGGER.info( | ||
| "%s: requesting consumptions from %s to %s", | ||
| self._scups, | ||
| start.isoformat(), | ||
| end.isoformat(), | ||
| ) | ||
| await self.update_consumptions( | ||
| cups, | ||
| distributor_code, | ||
| start, | ||
| end, | ||
| "0", | ||
| point_type, | ||
| ) | ||
| # update maximeter | ||
| _LOGGER.info( | ||
| "%s: missing maximeter: %s", | ||
| self._scups, | ||
| ", ".join( | ||
| [ | ||
| "from " + x["from"].isoformat() + " to " + x["to"].isoformat() | ||
| for x in miss_maxim | ||
| ] | ||
| ), | ||
| ) | ||
| for gap in miss_maxim: | ||
| if not (date_to < supply["date_start"] or date_from > supply["date_end"]): | ||
| # fetch maximeter for each maximeter gap in valid periods | ||
| start = max( | ||
| [gap["from"], supply["date_start"] + relativedelta(months=1)] | ||
| ) | ||
| end = min([gap["to"], supply["date_end"]]) | ||
| start = min([start, end]) | ||
| _LOGGER.info( | ||
| "%s: requesting maximeter from %s to %s", | ||
| self._scups, | ||
| start.isoformat(), | ||
| end.isoformat(), | ||
| ) | ||
| await self.update_maximeter(cups, distributor_code, start, end) | ||
| miss_cons, miss_maxim = sort_and_filter(date_from, date_to) | ||
| return True | ||
| def update_redata( | ||
| self, | ||
| date_from: datetime = (datetime.today() - timedelta(days=30)).replace( | ||
| hour=0, minute=0 | ||
| ), | ||
| date_to: datetime = (datetime.today() + timedelta(days=2)).replace( | ||
| hour=0, minute=0 | ||
| ), | ||
| ): | ||
| """Fetch PVPC prices using REData API.""" | ||
| _LOGGER.info( | ||
| "%s: updating PVPC prices", | ||
| self._scups, | ||
| ) | ||
| self.data["pvpc"], missing = utils.extract_dt_ranges( | ||
| self.data["pvpc"], | ||
| date_from, | ||
| date_to, | ||
| gap_interval=timedelta(hours=1), | ||
| ) | ||
| for gap in missing: | ||
| prices = [] | ||
| gap["from"] = max( | ||
| (datetime.today() - timedelta(days=30)).replace(hour=0, minute=0), | ||
| gap["from"], | ||
| ) | ||
| while len(prices) == 0 and gap["from"] < gap["to"]: | ||
| prices = self.redata_api.get_realtime_prices(gap["from"], gap["to"]) | ||
| gap["from"] = gap["from"] + timedelta(days=1) | ||
| self.data["pvpc"] = utils.extend_by_key( | ||
| self.data["pvpc"], prices, "datetime" | ||
| ) | ||
| return True | ||
| def process_data(self, incremental_update: bool = True): | ||
| """Process all raw data.""" | ||
| self._incremental_update = incremental_update | ||
| for process_method in [ | ||
| self.process_supplies, | ||
| self.process_contracts, | ||
| self.process_consumptions, | ||
| self.process_maximeter, | ||
| self.process_cost, | ||
| ]: | ||
| try: | ||
| process_method() | ||
| except Exception as ex: # pylint: disable=broad-except | ||
| _LOGGER.error("Unhandled exception while updating attributes") | ||
| _LOGGER.exception(ex) | ||
| for attribute in self.attributes: | ||
| if attribute in ATTRIBUTES and ATTRIBUTES[attribute] is not None: | ||
| self.attributes[attribute] = ( | ||
| round(self.attributes[attribute], 2) | ||
| if self.attributes[attribute] is not None | ||
| else None | ||
| ) | ||
| if not incremental_update: | ||
| dump_storage(self._cups, self.data, self._storage_dir) | ||
| def process_supplies(self): | ||
| """Process supplies data.""" | ||
| for i in self.data["supplies"]: | ||
| if i["cups"] == self._cups: | ||
| self.attributes["cups"] = self._cups | ||
| break | ||
| def process_contracts(self): | ||
| """Process contracts data.""" | ||
| most_recent_date = datetime(1970, 1, 1) | ||
| for i in self.data["contracts"]: | ||
| if i["date_end"] > most_recent_date: | ||
| most_recent_date = i["date_end"] | ||
| self.attributes["contract_p1_kW"] = i.get("power_p1", None) | ||
| self.attributes["contract_p2_kW"] = i.get("power_p2", None) | ||
| break | ||
| def process_consumptions(self): | ||
| """Process consumptions data.""" | ||
| if len(self.data["consumptions"]) > 0: | ||
| new_data_from = self._date_from | ||
| if self._incremental_update: | ||
| with contextlib.suppress(Exception): | ||
| new_data_from = self.data["consumptions_monthly_sum"][-1][ | ||
| "datetime" | ||
| ] | ||
| proc = ConsumptionProcessor( | ||
| { | ||
| "consumptions": [ | ||
| x | ||
| for x in self.data["consumptions"] | ||
| if x["datetime"] >= new_data_from | ||
| ], | ||
| "cycle_start_day": 1, | ||
| } | ||
| ) | ||
| today_starts = datetime( | ||
| datetime.today().year, | ||
| datetime.today().month, | ||
| datetime.today().day, | ||
| 0, | ||
| 0, | ||
| 0, | ||
| ) | ||
| month_starts = datetime( | ||
| datetime.today().year, datetime.today().month, 1, 0, 0, 0 | ||
| ) | ||
| # append new data | ||
| self.data["consumptions_daily_sum"] = utils.extend_and_filter( | ||
| self.data["consumptions_daily_sum"], | ||
| proc.output["daily"], | ||
| "datetime", | ||
| self._date_from, | ||
| self._date_to, | ||
| ) | ||
| self.data["consumptions_monthly_sum"] = utils.extend_and_filter( | ||
| self.data["consumptions_monthly_sum"], | ||
| proc.output["monthly"], | ||
| "datetime", | ||
| self._date_from, | ||
| self._date_to, | ||
| ) | ||
| yday = utils.get_by_key( | ||
| self.data["consumptions_daily_sum"], | ||
| "datetime", | ||
| today_starts - timedelta(days=1), | ||
| ) | ||
| self.attributes["yesterday_kWh"] = ( | ||
| yday.get("value_kWh", None) if yday is not None else None | ||
| ) | ||
| for tariff in (1, 2, 3): | ||
| self.attributes[f"yesterday_p{tariff}_kWh"] = ( | ||
| yday.get(f"value_p{tariff}_kWh", None) if yday is not None else None | ||
| ) | ||
| self.attributes["yesterday_surplus_kWh"] = ( | ||
| yday.get("surplus_kWh", None) if yday is not None else None | ||
| ) | ||
| for tariff in (1, 2, 3): | ||
| self.attributes[f"yesterday_surplus_p{tariff}_kWh"] = ( | ||
| yday.get(f"surplus_p{tariff}_kWh", None) | ||
| if yday is not None | ||
| else None | ||
| ) | ||
| self.attributes["yesterday_hours"] = ( | ||
| yday.get("delta_h", None) if yday is not None else None | ||
| ) | ||
| month = utils.get_by_key( | ||
| self.data["consumptions_monthly_sum"], "datetime", month_starts | ||
| ) | ||
| self.attributes["month_kWh"] = ( | ||
| month.get("value_kWh", None) if month is not None else None | ||
| ) | ||
| self.attributes["month_surplus_kWh"] = ( | ||
| month.get("surplus_kWh", None) if month is not None else None | ||
| ) | ||
| self.attributes["month_days"] = ( | ||
| month.get("delta_h", 0) / 24 if month is not None else None | ||
| ) | ||
| self.attributes["month_daily_kWh"] = ( | ||
| ( | ||
| (self.attributes["month_kWh"] / self.attributes["month_days"]) | ||
| if self.attributes["month_days"] > 0 | ||
| else 0 | ||
| ) | ||
| if month is not None | ||
| else None | ||
| ) | ||
| for tariff in (1, 2, 3): | ||
| self.attributes[f"month_p{tariff}_kWh"] = ( | ||
| month.get(f"value_p{tariff}_kWh", None) | ||
| if month is not None | ||
| else None | ||
| ) | ||
| self.attributes[f"month_surplus_p{tariff}_kWh"] = ( | ||
| month.get(f"surplus_p{tariff}_kWh", None) | ||
| if month is not None | ||
| else None | ||
| ) | ||
| last_month = utils.get_by_key( | ||
| self.data["consumptions_monthly_sum"], | ||
| "datetime", | ||
| (month_starts - relativedelta(months=1)), | ||
| ) | ||
| self.attributes["last_month_kWh"] = ( | ||
| last_month.get("value_kWh", None) if last_month is not None else None | ||
| ) | ||
| self.attributes["last_month_surplus_kWh"] = ( | ||
| last_month.get("surplus_kWh", None) if last_month is not None else None | ||
| ) | ||
| self.attributes["last_month_days"] = ( | ||
| last_month.get("delta_h", 0) / 24 if last_month is not None else None | ||
| ) | ||
| self.attributes["last_month_daily_kWh"] = ( | ||
| ( | ||
| ( | ||
| self.attributes["last_month_kWh"] | ||
| / self.attributes["last_month_days"] | ||
| ) | ||
| if self.attributes["last_month_days"] > 0 | ||
| else 0 | ||
| ) | ||
| if last_month is not None | ||
| else None | ||
| ) | ||
| for tariff in (1, 2, 3): | ||
| self.attributes[f"last_month_p{tariff}_kWh"] = ( | ||
| last_month.get(f"value_p{tariff}_kWh", None) | ||
| if last_month is not None | ||
| else None | ||
| ) | ||
| self.attributes[f"last_month_surplus_p{tariff}_kWh"] = ( | ||
| last_month.get(f"surplus_p{tariff}_kWh", None) | ||
| if last_month is not None | ||
| else None | ||
| ) | ||
| if len(self.data["consumptions"]) > 0: | ||
| self.attributes["last_registered_date"] = self.data["consumptions"][-1][ | ||
| "datetime" | ||
| ] | ||
| if len(self.data["consumptions_daily_sum"]) > 0: | ||
| last_day = self.data["consumptions_daily_sum"][-1] | ||
| self.attributes["last_registered_day_kWh"] = ( | ||
| last_day.get("value_kWh", None) | ||
| if last_day is not None | ||
| else None | ||
| ) | ||
| self.attributes["last_registered_day_surplus_kWh"] = ( | ||
| last_day.get("surplus_kWh", None) | ||
| if last_day is not None | ||
| else None | ||
| ) | ||
| for tariff in (1, 2, 3): | ||
| self.attributes[f"last_registered_day_p{tariff}_kWh"] = ( | ||
| last_day.get(f"value_p{tariff}_kWh", None) | ||
| if last_day is not None | ||
| else None | ||
| ) | ||
| self.attributes[ | ||
| f"last_registered_day_surplus_p{tariff}_kWh" | ||
| ] = ( | ||
| last_day.get(f"surplus_p{tariff}_kWh", None) | ||
| if last_day is not None | ||
| else None | ||
| ) | ||
| self.attributes["last_registered_day_hours"] = ( | ||
| last_day.get("delta_h", None) if last_day is not None else None | ||
| ) | ||
| def process_maximeter(self): | ||
| """Process maximeter data.""" | ||
| if len(self.data["maximeter"]) > 0: | ||
| processor = MaximeterProcessor(self.data["maximeter"]) | ||
| last_relative_year = processor.output["stats"] | ||
| self.attributes["max_power_kW"] = last_relative_year.get( | ||
| "value_max_kW", None | ||
| ) | ||
| self.attributes["max_power_date"] = last_relative_year.get("date_max", None) | ||
| self.attributes["max_power_mean_kW"] = last_relative_year.get( | ||
| "value_mean_kW", None | ||
| ) | ||
| self.attributes["max_power_90perc_kW"] = last_relative_year.get( | ||
| "value_tile90_kW", None | ||
| ) | ||
| def process_cost(self): | ||
| """Process costs.""" | ||
| if self.enable_billing: | ||
| new_data_from = self._date_from | ||
| if self._incremental_update: | ||
| with contextlib.suppress(Exception): | ||
| new_data_from = self.data["cost_monthly_sum"][-1]["datetime"] | ||
| proc = BillingProcessor( | ||
| BillingInput( | ||
| contracts=self.data["contracts"], | ||
| consumptions=[ | ||
| x | ||
| for x in self.data["consumptions"] | ||
| if x["datetime"] >= new_data_from | ||
| ], | ||
| prices=( | ||
| [x for x in self.data["pvpc"] if x["datetime"] >= new_data_from] | ||
| if self.is_pvpc | ||
| else None | ||
| ), | ||
| rules=self.pricing_rules, | ||
| ) | ||
| ) | ||
| month_starts = datetime( | ||
| datetime.today().year, datetime.today().month, 1, 0, 0, 0 | ||
| ) | ||
| # append new data | ||
| hourly = proc.output["hourly"] | ||
| self.data["cost_hourly_sum"] = utils.extend_and_filter( | ||
| self.data["cost_hourly_sum"], | ||
| hourly, | ||
| "datetime", | ||
| self._date_from, | ||
| self._date_to, | ||
| ) | ||
| daily = proc.output["daily"] | ||
| self.data["cost_daily_sum"] = utils.extend_and_filter( | ||
| self.data["cost_daily_sum"], | ||
| daily, | ||
| "datetime", | ||
| self._date_from, | ||
| self._date_to, | ||
| ) | ||
| monthly = proc.output["monthly"] | ||
| self.data["cost_monthly_sum"] = utils.extend_and_filter( | ||
| self.data["cost_monthly_sum"], | ||
| monthly, | ||
| "datetime", | ||
| self._date_from, | ||
| self._date_to, | ||
| ) | ||
| this_month = utils.get_by_key( | ||
| self.data["cost_monthly_sum"], | ||
| "datetime", | ||
| month_starts, | ||
| ) | ||
| last_month = utils.get_by_key( | ||
| self.data["cost_monthly_sum"], | ||
| "datetime", | ||
| (month_starts - relativedelta(months=1)), | ||
| ) | ||
| if this_month is not None: | ||
| self.attributes["month_€"] = this_month.get("value_eur", None) | ||
| if last_month is not None: | ||
| self.attributes["last_month_€"] = last_month.get("value_eur", None) | ||
| def reset(self): | ||
| """Reset in-mem objects.""" | ||
| self.data = EdataData( | ||
| supplies=[], | ||
| contracts=[], | ||
| consumptions=[], | ||
| maximeter=[], | ||
| pvpc=[], | ||
| consumptions_daily_sum=[], | ||
| consumptions_monthly_sum=[], | ||
| cost_hourly_sum=[], | ||
| cost_daily_sum=[], | ||
| cost_monthly_sum=[], | ||
| ) | ||
| for attr in ATTRIBUTES: | ||
| self.attributes[attr] = None | ||
| self.last_update = {x: datetime(1970, 1, 1) for x in self.data} |
| import json | ||
| import logging | ||
| import os | ||
| from .processors import utils | ||
| from . import const as const | ||
| from . import definitions as defs | ||
| _LOGGER = logging.getLogger(__name__) | ||
| DEFAULT_STORAGE_DIR = os.getenv("HOME") | ||
| RECENT_CACHE_FILENAME = "edata_{id}.json" | ||
| compile_storage_id = lambda cups: cups.lower() | ||
| def check_storage_integrity(data: defs.EdataData): | ||
| """Check if an EdataData object follows a schema.""" | ||
| return defs.EdataSchema(data) | ||
| def load_storage(cups: str, storage_dir: str | None = None): | ||
| """Load EdataData storage from its config dir.""" | ||
| if storage_dir is None: | ||
| storage_dir = DEFAULT_STORAGE_DIR | ||
| _subdir = os.path.join(storage_dir, const.PROG_NAME) | ||
| _recent_cache = os.path.join( | ||
| _subdir, RECENT_CACHE_FILENAME.format(id=compile_storage_id(cups)) | ||
| ) | ||
| os.makedirs(_subdir, exist_ok=True) | ||
| with open(_recent_cache, encoding="utf-8") as f: | ||
| return check_storage_integrity(utils.deserialize_dict(json.load(f))) | ||
| def dump_storage(cups: str, storage: defs.EdataData, storage_dir: str | None = None): | ||
| """Update EdataData storage.""" | ||
| if storage_dir is None: | ||
| storage_dir = DEFAULT_STORAGE_DIR | ||
| _subdir = os.path.join(storage_dir, const.PROG_NAME) | ||
| _recent_cache = os.path.join( | ||
| _subdir, RECENT_CACHE_FILENAME.format(id=compile_storage_id(cups)) | ||
| ) | ||
| os.makedirs(_subdir, exist_ok=True) | ||
| with open(_recent_cache, "w", encoding="utf-8") as f: | ||
| json.dump(utils.serialize_dict(check_storage_integrity(storage)), f) |
+1
-1
| Metadata-Version: 2.4 | ||
| Name: e-data | ||
| Version: 1.3.1 | ||
| Version: 1.3.2 | ||
| Summary: Python library for managing spanish energy data from various web providers | ||
@@ -5,0 +5,0 @@ Author-email: VMG <vmayorg@outlook.es> |
+2
-2
@@ -7,3 +7,3 @@ [build-system] | ||
| name = "e-data" | ||
| version = "1.3.1" | ||
| version = "1.3.2" | ||
| description = "Python library for managing spanish energy data from various web providers" | ||
@@ -41,5 +41,5 @@ readme = "README.md" | ||
| [tool.setuptools.packages.find] | ||
| where = ["edata"] | ||
| where = ["."] | ||
| [tool.setuptools] | ||
| include-package-data = true |
| Metadata-Version: 2.4 | ||
| Name: e-data | ||
| Version: 1.3.1 | ||
| Summary: Python library for managing spanish energy data from various web providers | ||
| Author-email: VMG <vmayorg@outlook.es> | ||
| License: GNU GENERAL PUBLIC LICENSE | ||
| Version 3, 29 June 2007 | ||
| Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||
| 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. | ||
| <one line to give the program's name and a brief idea of what it does.> | ||
| Copyright (C) <year> <name of author> | ||
| 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 <https://www.gnu.org/licenses/>. | ||
| 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: | ||
| <program> Copyright (C) <year> <name of author> | ||
| 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 | ||
| <https://www.gnu.org/licenses/>. | ||
| 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 | ||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||
| Project-URL: Homepage, https://github.com/uvejota/python-edata | ||
| Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) | ||
| Classifier: Programming Language :: Python | ||
| Classifier: Programming Language :: Python :: 3.11 | ||
| Classifier: Programming Language :: Python :: 3.12 | ||
| Classifier: Programming Language :: Python :: Implementation :: CPython | ||
| Classifier: Programming Language :: Python :: Implementation :: PyPy | ||
| Requires-Python: >=3.11.0 | ||
| Description-Content-Type: text/markdown | ||
| License-File: LICENSE | ||
| Requires-Dist: dateparser>=1.1.2 | ||
| Requires-Dist: freezegun>=1.2.1 | ||
| Requires-Dist: holidays>=0.14.2 | ||
| Requires-Dist: pytest>=7.1.2 | ||
| Requires-Dist: python_dateutil>=2.8.2 | ||
| Requires-Dist: requests>=2.28.1 | ||
| Requires-Dist: voluptuous>=0.13.1 | ||
| Requires-Dist: Jinja2>=3.1.2 | ||
| Requires-Dist: diskcache>=5.6.3 | ||
| Requires-Dist: aiohttp>=3.12.15 | ||
| Dynamic: license-file | ||
| [](https://pepy.tech/project/e-data) | ||
| [](https://pepy.tech/project/e-data) | ||
| [](https://pepy.tech/project/e-data) | ||
| # python-edata | ||
| Este paquete proporciona herramientas para la descarga de tus datos de consumo eléctrico (desde Datadis.es) y su posterior procesado. La motivación principal es que conocer el consumo puede ayudarnos a reducirlo, e incluso a elegir una tarifa que mejor se adapte a nuestras necesidades. A día de hoy sus capacidades de facturación (€) son limitadas, soporta PVPC (según disponibilidad de datos de REData) y tarificación fija por tramos. Es el corazón de la integración [homeassistant-edata](https://github.com/uvejota/homeassistant-edata). | ||
| _**Esta herramienta no mantiene ningún tipo de vinculación con los proveedores de datos anteriormente mencionados, simplemente consulta la información disponible y facilita su posterior análisis.**_ | ||
| ## Instalación | ||
| Puedes instalar la última versión estable mediante: | ||
| ``` bash | ||
| pip install e-data | ||
| ``` | ||
| Si quieres probar la versión `dev` o contribuir a su desarrollo, clona este repositorio e instala manualmente las dependencias: | ||
| ``` bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
| ## Estructura | ||
| El paquete consta de tres módulos diferenciados: | ||
| * **Conectores** (módulo `connectors`), para definir los métodos de consulta a los diferentes proveedores: Datadis y REData. | ||
| * **Procesadores** (módulo `processors`), para procesar datos de consumo, maxímetro, o coste (tarificación). Ahora mismo consta de tres procesadores: `billing`, `consumption` y `maximeter`, además de algunas utilidades ubicadas en `utils`. Los procesadores deben heredar de la clase Processor definida en `base.py` | ||
| * **Ayudantes** (módulo `helpers`), para ayudar en el uso y gestión de los anteriores, presentando de momento un único ayudante llamado `EdataHelper` que te permite recopilar `X` días de datos (por defecto 365) y automáticamente procesarlos. Los datos son almacenados en la variable `data`, mientras que los atributos autocalculados son almacenados en la variable `attributes`. Por lo general, primero utilizan los conectores y luego procesan los datos, gestionando varias tareas de recuperación (principalmente para Datadis). | ||
| Estos módulos corresponden a la siguiente estructura del paquete: | ||
| ``` | ||
| edata/ | ||
| · __init__.py | ||
| · connectors/ | ||
| · __init__.py | ||
| · datadis.py | ||
| · redata.py | ||
| · processors/ | ||
| · __init__.py | ||
| · base.py | ||
| · billing.py | ||
| · consumption.py | ||
| · maximeter.py | ||
| · utils.py | ||
| · helpers.py | ||
| ``` | ||
| ## Ejemplo de uso | ||
| Partimos de que tenemos credenciales en Datadis.es. Algunas aclaraciones: | ||
| * No es necesario solicitar API pública en el registro (se utilizará la API privada habilitada por defecto) | ||
| * El username suele ser el NIF del titular | ||
| * Copie el CUPS de la web de Datadis, algunas comercializadoras adhieren caracteres adicionales en el CUPS mostrado en su factura. | ||
| * La herramienta acepta el uso de NIF autorizado para consultar el suministro de otro titular. | ||
| ``` python | ||
| from datetime import datetime | ||
| import json | ||
| # importamos definiciones de datos que nos interesen | ||
| from edata.definitions import PricingRules | ||
| # importamos el ayudante | ||
| from edata.helpers import EdataHelper | ||
| # importamos el procesador de utilidades | ||
| from edata.processors import utils | ||
| # Preparar reglas de tarificación (si se quiere) | ||
| PRICING_RULES_PVPC = PricingRules( | ||
| p1_kw_year_eur=30.67266, | ||
| p2_kw_year_eur=1.4243591, | ||
| meter_month_eur=0.81, | ||
| market_kw_year_eur=3.113, | ||
| electricity_tax=1.0511300560, | ||
| iva_tax=1.05, | ||
| # podemos rellenar los siguientes campos si quisiéramos precio fijo (y no pvpc) | ||
| p1_kwh_eur=None, | ||
| p2_kwh_eur=None, | ||
| p3_kwh_eur=None, | ||
| ) | ||
| # Instanciar el helper | ||
| # 'authorized_nif' permite indicar el NIF de la persona que nos autoriza a consultar su CUPS. | ||
| # 'data' permite "cargar" al helper datos anteriores (resultado edata.data de una ejecución anterior), para evitar volver a consultar los mismos. | ||
| edata = EdataHelper( | ||
| "datadis_user", | ||
| "datadis_password", | ||
| "cups", | ||
| datadis_authorized_nif=None, | ||
| pricing_rules=PRICING_RULES_PVPC, # si se le pasa None, no aplica tarificación | ||
| data=None, # aquí podríamos cargar datos anteriores | ||
| ) | ||
| # Solicitar actualización de todo el histórico (se almacena en edata.data) | ||
| edata.update(date_from=datetime(1970, 1, 1), date_to=datetime.today()) | ||
| # volcamos todo lo obtenido a un fichero | ||
| with open("backup.json", "w") as file: | ||
| json.dump(utils.serialize_dict(edata.data), file) # se puede utilizar deserialize_dict para la posterior lectura del backup | ||
| # Imprimir atributos | ||
| print(edata.attributes) | ||
| ``` |
| dateparser>=1.1.2 | ||
| freezegun>=1.2.1 | ||
| holidays>=0.14.2 | ||
| pytest>=7.1.2 | ||
| python_dateutil>=2.8.2 | ||
| requests>=2.28.1 | ||
| voluptuous>=0.13.1 | ||
| Jinja2>=3.1.2 | ||
| diskcache>=5.6.3 | ||
| aiohttp>=3.12.15 |
| LICENSE | ||
| MANIFEST.in | ||
| README.md | ||
| pyproject.toml | ||
| edata/connectors/__init__.py | ||
| edata/connectors/datadis.py | ||
| edata/connectors/redata.py | ||
| edata/e_data.egg-info/PKG-INFO | ||
| edata/e_data.egg-info/SOURCES.txt | ||
| edata/e_data.egg-info/dependency_links.txt | ||
| edata/e_data.egg-info/requires.txt | ||
| edata/e_data.egg-info/top_level.txt | ||
| edata/processors/__init__.py | ||
| edata/processors/base.py | ||
| edata/processors/billing.py | ||
| edata/processors/consumption.py | ||
| edata/processors/maximeter.py | ||
| edata/processors/utils.py | ||
| edata/tests/__init__.py | ||
| edata/tests/test_datadis_connector.py | ||
| edata/tests/test_helpers.py | ||
| edata/tests/test_processors.py | ||
| edata/tests/test_redata_connector.py |
| connectors | ||
| processors | ||
| tests |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
232654
21%30
20%2389
71.13%