ekzexport 0.1.0__tar.gz

ekzexport-0.1.0/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

ekzexport-0.1.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: ekzexport
+Version: 0.1.0
+Summary: CLI and data exporter for the myEKZ customer portal.
+Home-page: https://github.com/mensi/ekzexport
+Author: Manuel Stocker
+Author-email: mensi@mensi.ch
+License: Apache-2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: click
+Requires-Dist: beautifulsoup4
+Requires-Dist: rich
+Requires-Dist: platformdirs
+Requires-Dist: tzdata
+Provides-Extra: influx
+Requires-Dist: influxdb-client; extra == "influx"
+
+# ekzexport
+
+Exporter for EKZ data provided on the http://my.ekz.ch customer portal.
+
+## Installing
+
+Get it from PyPI:
+
+```console
+$ python -m pip install ekzexport
+```
+
+You can then use the `ekzexport` CLI.
+
+## Example Usage
+
+To authenticate, you can either put your credentials into a JSON file
+`ekzexport.json` in your home directory:
+
+```json
+{
+  "user": "myusername",
+  "password": "mypassword"
+}
+```
+
+Or use the `--user` and `--password` options. The following examples use a JSON
+file.
+
+First, list your contracts to find the installation ID of interest:
+
+```console
+$ ekzexport overview
+                                        Contracts                                        
+                  ╷                                      ╷              ╷
+  Installation ID │ Address                              │ Move-in Date │ Move-out Date 
+╺━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━╸
+  123             │ Somestreet 1, 8000 Someplace         │ 2010-01-01   │ 2020-01-01
+  456             │ Some Other Street 2, 8001 Otherplace │ 2020-01-02   │
+                  ╵                                      ╵              ╵
+```
+
+With the installation ID, we can then figure out what kind of data is available
+for your account:
+
+```console
+$ ekzexport installation 456 properties
+                 Properties                 
+                 ╷            ╷
+  Property       │ From       │ Until      
+╺━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━┿━━━━━━━━━━━━╸
+  CONTRACT       │ 2020-01-02 │ 2024-05-01
+  SMART_METER    │ 2020-01-02 │ 2024-05-01
+  VERB_15MIN     │ 2020-01-02 │ 2024-05-01
+  VERB_TAG_EDM   │ 2020-01-02 │ 2024-05-01
+  VERB_TAG_METER │ 2020-01-02 │ 2024-05-01
+                 ╵            ╵
+```
+
+If you do not see any entry for 15 minute values, you likely have to enable
+granular data on myEKZ first.
+
+You can print consumption data to get an idea what is available:
+
+```console
+$ ekzexport installation 456 data --type PK_VERB_TAG_EDM --from 2024-04-01 --to 2024-04-02 show
+                 Consumption Data                 
+                      ╷        ╷        ╷
+  Time                │ kWh    │ Tariff │ Status 
+╺━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━┿━━━━━━━━┿━━━━━━━━╸
+  2024-04-01 00:00:00 │ 12.123 │ NT     │ VALID
+  2024-04-01 00:00:00 │ 10.123 │ HT     │ VALID
+  2024-04-02 00:00:00 │ 12.678 │ NT     │ VALID
+  2024-04-02 00:00:00 │ 8.678  │ HT     │ VALID
+                      ╵        ╵        ╵
+```
+
+But the more interesting use-case is to export data. Available exporters are:
+
+ - `csv` to sync data to a CSV file in the same format as myEKZ offers
+ - `influxdb` to sync data to an InfluxDB 2.x server
+
+The CLI's help command will provide further detail on the exporter-specific
+options, for example:
+
+```console
+$ ekzexport installation 456 data export csv --help
+```
+
+## Running Exports Periodically
+
+If you're using a Linux distribution using systemd, you can create a service
+and trigger to run the export periodically. To do so, create
+`/etc/systemd/system/ekzexport.service` with something like:
+
+```ini
+[Unit]
+Description=Pull EKZ data
+
+[Service]
+Type=oneshot
+ExecStart=/path/to/ekzexport/venv/bin/ekzexport installation 456 data export csv -f data.csv
+WorkingDirectory=/path/to/ekzexport
+```
+
+This example assumes you created a Python virtualenv to install ekzexport
+in (which keeps the dependencies local in the venv). You can also
+set up an `OnFailure` hook to send emails in case the export fails.
+
+A corresponding timer can look something like this in `/etc/systemd/system/ekzexport.timer`:
+
+```ini
+[Unit]
+Description=Run ekzexport once a day
+
+[Timer]
+OnCalendar=*-*-* 04:00:00
+RandomizedDelaySec=30m
+Persistent=true
+
+[Install]
+WantedBy=timers.target
+```
+
+Please keep the randomized delay to avoid myEKZ getting a flood of requests
+at exactly 04:00 every night. Remember to enable and start the timer.

ekzexport-0.1.0/README.md

@@ -0,0 +1,126 @@
+# ekzexport
+
+Exporter for EKZ data provided on the http://my.ekz.ch customer portal.
+
+## Installing
+
+Get it from PyPI:
+
+```console
+$ python -m pip install ekzexport
+```
+
+You can then use the `ekzexport` CLI.
+
+## Example Usage
+
+To authenticate, you can either put your credentials into a JSON file
+`ekzexport.json` in your home directory:
+
+```json
+{
+  "user": "myusername",
+  "password": "mypassword"
+}
+```
+
+Or use the `--user` and `--password` options. The following examples use a JSON
+file.
+
+First, list your contracts to find the installation ID of interest:
+
+```console
+$ ekzexport overview
+                                        Contracts                                        
+                  ╷                                      ╷              ╷
+  Installation ID │ Address                              │ Move-in Date │ Move-out Date 
+╺━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━╸
+  123             │ Somestreet 1, 8000 Someplace         │ 2010-01-01   │ 2020-01-01
+  456             │ Some Other Street 2, 8001 Otherplace │ 2020-01-02   │
+                  ╵                                      ╵              ╵
+```
+
+With the installation ID, we can then figure out what kind of data is available
+for your account:
+
+```console
+$ ekzexport installation 456 properties
+                 Properties                 
+                 ╷            ╷
+  Property       │ From       │ Until      
+╺━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━┿━━━━━━━━━━━━╸
+  CONTRACT       │ 2020-01-02 │ 2024-05-01
+  SMART_METER    │ 2020-01-02 │ 2024-05-01
+  VERB_15MIN     │ 2020-01-02 │ 2024-05-01
+  VERB_TAG_EDM   │ 2020-01-02 │ 2024-05-01
+  VERB_TAG_METER │ 2020-01-02 │ 2024-05-01
+                 ╵            ╵
+```
+
+If you do not see any entry for 15 minute values, you likely have to enable
+granular data on myEKZ first.
+
+You can print consumption data to get an idea what is available:
+
+```console
+$ ekzexport installation 456 data --type PK_VERB_TAG_EDM --from 2024-04-01 --to 2024-04-02 show
+                 Consumption Data                 
+                      ╷        ╷        ╷
+  Time                │ kWh    │ Tariff │ Status 
+╺━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━┿━━━━━━━━┿━━━━━━━━╸
+  2024-04-01 00:00:00 │ 12.123 │ NT     │ VALID
+  2024-04-01 00:00:00 │ 10.123 │ HT     │ VALID
+  2024-04-02 00:00:00 │ 12.678 │ NT     │ VALID
+  2024-04-02 00:00:00 │ 8.678  │ HT     │ VALID
+                      ╵        ╵        ╵
+```
+
+But the more interesting use-case is to export data. Available exporters are:
+
+ - `csv` to sync data to a CSV file in the same format as myEKZ offers
+ - `influxdb` to sync data to an InfluxDB 2.x server
+
+The CLI's help command will provide further detail on the exporter-specific
+options, for example:
+
+```console
+$ ekzexport installation 456 data export csv --help
+```
+
+## Running Exports Periodically
+
+If you're using a Linux distribution using systemd, you can create a service
+and trigger to run the export periodically. To do so, create
+`/etc/systemd/system/ekzexport.service` with something like:
+
+```ini
+[Unit]
+Description=Pull EKZ data
+
+[Service]
+Type=oneshot
+ExecStart=/path/to/ekzexport/venv/bin/ekzexport installation 456 data export csv -f data.csv
+WorkingDirectory=/path/to/ekzexport
+```
+
+This example assumes you created a Python virtualenv to install ekzexport
+in (which keeps the dependencies local in the venv). You can also
+set up an `OnFailure` hook to send emails in case the export fails.
+
+A corresponding timer can look something like this in `/etc/systemd/system/ekzexport.timer`:
+
+```ini
+[Unit]
+Description=Run ekzexport once a day
+
+[Timer]
+OnCalendar=*-*-* 04:00:00
+RandomizedDelaySec=30m
+Persistent=true
+
+[Install]
+WantedBy=timers.target
+```
+
+Please keep the randomized delay to avoid myEKZ getting a flood of requests
+at exactly 04:00 every night. Remember to enable and start the timer.

ekzexport-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ekzexport-0.1.0/setup.py

@@ -0,0 +1,48 @@
+from setuptools import setup
+
+with open('README.md', 'r', encoding='utf-8') as f:
+    readme = f.read()
+
+setup(
+    name='ekzexport',
+    description='CLI and data exporter for the myEKZ customer portal.',
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    author='Manuel Stocker',
+    author_email='mensi@mensi.ch',
+    url='https://github.com/mensi/ekzexport',
+    license='Apache-2.0',
+    version='0.1.0',
+    packages=['ekzexport'],
+    package_data={'': ['LICENSE']},
+    package_dir={'': 'src'},
+    install_requires=[
+        'requests',
+        'click',
+        'beautifulsoup4',
+        'rich',
+        'platformdirs',
+        'tzdata',
+    ],
+    extras_require={
+        'influx': ['influxdb-client'],
+    },
+    tests_require=[
+        'pytest',
+    ],
+    entry_points={
+        'console_scripts': [
+            'ekzexport = ekzexport.cli:main',
+        ],
+    },
+    classifiers=[
+            "License :: OSI Approved :: Apache Software License",
+            "Natural Language :: English",
+            "Operating System :: OS Independent",
+            "Programming Language :: Python",
+            "Programming Language :: Python :: 3.10",
+            "Programming Language :: Python :: 3.11",
+            "Programming Language :: Python :: 3.12",
+            "Programming Language :: Python :: 3 :: Only",
+        ],
+)

ekzexport-0.1.0/src/ekzexport/apitypes.py

@@ -0,0 +1,120 @@
+from typing import TypedDict, List, Optional
+
+
+class Address(TypedDict):
+    addressNumber: str
+    street: str
+    houseNumber: str
+    houseNumberDetails: str
+    locationDetails: str
+    floor: str
+    postalCode: str
+    city: str
+
+
+class ISDContract(TypedDict):
+    """Used for the contracts property in InstallationSelectionData."""
+    gpart: str
+    vkonto: str
+    vertrag: str
+    anlage: str
+    vstelle: str
+    haus: str
+    einzdat: str
+    auszdat: Optional[str]
+    sparte: str
+
+
+class ISDAnlage(TypedDict):
+    """Used for the eanl property in InstallationSelectionData."""
+    anlage: str
+    sparte: str
+    vstelle: str
+    anlart: str
+    spebene: str
+    zzenergietraeger: Optional[str]
+    zzevgstat: Optional[str]
+    zzevganlage: Optional[str]
+    eanlhTariftyp: str
+    eanlhAbleinh: str
+
+
+class ISDStelle(TypedDict):
+    vstelle: str
+    haus: str
+    eigent: str
+    vbsart: str
+    lgzusatz: str
+    floor: str
+    zzlage: str
+    zzlgzusatz: str
+    iflotZzanobjart: str
+    iflotZzeigen: str
+    iflotZzegid: str
+    address: Address
+
+
+class ISDFkkVkp(TypedDict):
+    vkont: str
+    gpart: str
+    opbuk: str
+    stdbk: str
+    abrwe: Optional[str]
+    abwra: Optional[str]
+    abwma: Optional[str]
+    ebvty: Optional[str]
+    abvty: str
+    ezawe: str
+    azawe: str
+    vkpbz: str
+    ktokl: str
+    consolidatorId: str
+    zzRechDet: str
+
+
+class InstallationSelectionData(TypedDict):
+    """Return schema for /consumption-view/v1/installation-selection-data?installationVariant=CONSUMPTION"""
+    contracts: List[ISDContract]
+    eanl: List[ISDAnlage]
+    evbs: List[ISDStelle]
+    fkkvkp: List[ISDFkkVkp]
+    commonData: Optional[str]
+
+
+class IDProperty(TypedDict):
+    property: str
+    ab: str
+    bis: str
+
+
+class InstallationData(TypedDict):
+    """Return schema for /consumption-view/v1/installation-data?installationId=..."""
+    status: List[IDProperty]
+
+
+class Value(TypedDict):
+    value: float
+    timestamp: int
+    date: str
+    time: str
+    status: str
+
+
+class Series(TypedDict):
+    level: str
+    energyType: Optional[str]
+    sourceType: Optional[str]
+    tariffType: str
+    ab: str
+    bis: str
+    values: List[Value]
+
+
+class ConsumptionData(TypedDict):
+    """Return schema for /consumption-view/v1/consumption-data?installationId=..."""
+    series: Optional[Series]
+    seriesHt: Optional[Series]
+    seriesNetz: Optional[Series]
+    seriesNetzHt: Optional[Series]
+    seriesNetzHt: Optional[Series]
+    seriesNt: Optional[Series]