Hydro-Quebec-API-Wrapper 0.6.9__tar.gz → 0.8.1__tar.gz

{Hydro-Quebec-API-Wrapper-0.6.9 → hydro_quebec_api_wrapper-0.8.1}/.coveragerc

@@ -2,3 +2,4 @@
 source =
 	./
 	/builds/*/hydroqc-test/hydroqc/
+	/builds/*/*-hydroqc-test/hydroqc/

hydro_quebec_api_wrapper-0.8.1/.devcontainer/Dockerfile

@@ -0,0 +1,11 @@
+FROM registry.gitlab.com/hydroqc/hydroqc-base-container/3.13:latest
+
+# Create devcontainer user with home directory and bash shell, install sudo, and configure passwordless sudo
+RUN useradd -m -s /bin/bash devcontainer \
+    && apt-get update && apt-get install -y sudo gnulib locales \
+    && echo "devcontainer ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/devcontainer
+
+WORKDIR /home/devcontainer
+USER devcontainer
+RUN mkdir -p /home/devcontainer/.local/bin \
+    && export PATH=$PATH:/home/devcontainer/.local/bin

hydro_quebec_api_wrapper-0.8.1/.devcontainer/devcontainer.json

@@ -0,0 +1,20 @@
+{
+    "name": "hydroqc",
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+    "features": {
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+        "ghcr.io/msclock/features/gitlab-ci-local:0": {
+            "version": "latest"
+        }
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "GitLab.gitlab-workflow"
+            ]
+        }
+    },
+    "remoteUser": "devcontainer"
+}

{Hydro-Quebec-API-Wrapper-0.6.9 → hydro_quebec_api_wrapper-0.8.1}/.gitignore

@@ -124,9 +124,29 @@ venv.bak/
 .mypy_cache/
 .dmypy.json
 dmypy.json
+mypy-html-report/
+mypy-junit.xml
+mypy-txt-report/
+classes.html
+packages.html
 
 # Pyre type checker
 .pyre/
 /hydro-env/
 config.yaml
 .idea/
+
+# gitlab-ci-local
+.gitlab-ci-local-env
+.gitlab-ci-local/
+.gitlab-ci-local-variables.yml
+
+# Tests results
+mypy*
+packages.html
+classes.html
+
+
+diagnostic.zip
+/diagnostic/
+

{Hydro-Quebec-API-Wrapper-0.6.9 → hydro_quebec_api_wrapper-0.8.1}/.gitlab-ci.yml

@@ -1,26 +1,38 @@
+include:
+  - project: "renovate-bot/renovate-runner"
+    file: "/templates/renovate-config-validator.gitlab-ci.yml"
 variables:
   TWINE_USERNAME: __token__
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
 stages:
-- test
-- private_tests
-- private_tests_done
-- pypi
+  - test
+  - private_tests
+  - private_tests_done
+  - pypi
 
 cache:
   key: pip-cache
   paths:
     - .cache/pip
 
-test:
+renovate-config-validator:
   stage: test
   tags:
-  - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/build:20221121
+    - hydroqc
+  rules:
+    # Enable for all other branches if it's a MR pipeline
+    - if: "$CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH && $CI_MERGE_REQUEST_IID"
+      changes:
+        - renovate.json5
+      when: on_success
+    - when: never
+
+test:
+  stage: test
+  # tags:
+  #  - hydroqc
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.13:latest
   script:
-    #- apt-get update && apt-get install git --no-install-recommends -y graphviz jq python3.10 python3-venv python3-pip git
-    - cat renovate.json |jq > /dev/null 2&>1 || ( echo "renovate.json not valid" && exit 1 )
-    #- pip install tox
     - tox -e pylint,flake8,pydocstyle,typing,black,deps-conflict --parallel auto
     - cat mypy-txt-report/index.txt
   artifacts:
@@ -36,21 +48,30 @@ test:
       - packages.mmd
       - packages.html
   rules:
-    - if: '$CI_SKIP =~ /test/'
+    # Disable if CI_SKIP is set
+    - if: "$CI_SKIP =~ /test/"
       when: never
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-      #when: never
-    - if: '$CI_COMMIT_TAG'
+    # Disable if it's a tag pipeline
+    - if: "$CI_COMMIT_TAG"
       when: never
-    - when: on_success
+    # Enabled for main branch
+    - if: "$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH"
+      when: on_success
+    # Enable for all other branches if it's a MR pipeline
+    - if: "$CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH && $CI_MERGE_REQUEST_IID"
+      when: on_success
+    # Make it manual for external MR
+    - if: "$CI_MERGE_REQUEST_IID && $CI_MERGE_REQUEST_PROJECT_PATH != $CI_MERGE_REQUEST_SOURCE_PROJECT_PATH"
+      when: manual
+    - when: never
 
 .private_test_script: &private_test_script
   stage: private_tests
-  tags:
-  - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/build:20221121
+  # Run on shared runners to lighten the load on the private runners
+  # tags:
+  # - hydroqc
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.13:latest
   script:
-    #- apt update && apt install -y jq unzip curl
     - >
       OUTPUT=$(curl
       --globoff
@@ -146,67 +167,100 @@ test:
     reports:
       junit: hydroqc/tests_result_junit.*.xml
   rules:
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-      #when: never
-    - if: '$CI_COMMIT_TAG'
+    # Disable if it's a tag pipeline
+    - if: "$CI_COMMIT_TAG"
       when: never
-    - when: on_success
-
+    # Enabled for main branch
+    - if: "$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH"
+      when: on_success
+    # Enable for all other branches if it's a MR pipeline
+    - if: "$CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH && $CI_MERGE_REQUEST_IID"
+      when: on_success
+    # Make it manual for external MR
+    - if: "$CI_MERGE_REQUEST_IID && $CI_MERGE_REQUEST_PROJECT_PATH != $CI_MERGE_REQUEST_SOURCE_PROJECT_PATH"
+      when: manual
+    - when: never
 
-private_test_titilambert:
+D_CPC_titilambert:
   variables:
     PROJECT_ID: 35085986
   <<: *private_test_script
   rules:
-    - if: '$CI_SKIP =~ /titilambert/'
+    - if: "$CI_SKIP =~ /d_cpc_titilambert/"
       when: never
     - !reference [.private_test_script, rules]
 
-private_test_mdallaire1:
+DPC_mdallaire1:
   variables:
     PROJECT_ID: 39503160
   <<: *private_test_script
   rules:
-    - if: '$CI_SKIP =~ /mdallaire1/'
+    - if: "$CI_SKIP =~ /dpc_mdallaire1/"
+      when: never
+    - !reference [.private_test_script, rules]
+
+DT_mdallaire1:
+  variables:
+    PROJECT_ID: 52729124
+  <<: *private_test_script
+  rules:
+    - if: "$CI_SKIP =~ /dt_mdallaire1/"
+      when: never
+    - !reference [.private_test_script, rules]
+
+D_mdallaire1:
+  variables:
+    PROJECT_ID: 52728916
+  <<: *private_test_script
+  rules:
+    - if: "$CI_SKIP =~ /d_mdallaire1/"
       when: never
     - !reference [.private_test_script, rules]
 
-private_test_weimdall:
+D_weimdall:
   variables:
     PROJECT_ID: 39038345
   <<: *private_test_script
   rules:
-    - if: '$CI_SKIP =~ /weimdall/'
+    - if: "$CI_SKIP =~ /d_weimdall/"
       when: never
     - !reference [.private_test_script, rules]
 
-private_test_zepiaf:
+D_CPC_zepiaf:
   variables:
     PROJECT_ID: 39098670
   <<: *private_test_script
   rules:
-    - if: '$CI_SKIP =~ /zepiaf/'
+    - if: "$CI_SKIP =~ /d_cpc_zepiaf/"
       when: never
     - !reference [.private_test_script, rules]
 
-private_test_devzwf:
+D_devzwf:
   variables:
     PROJECT_ID: 39310934
   <<: *private_test_script
   rules:
-    - if: '$CI_SKIP =~ /devzwf/'
+    - if: "$CI_SKIP =~ /d_devzwf/"
+      when: never
+    - !reference [.private_test_script, rules]
+
+M_hdenergy:
+  variables:
+    PROJECT_ID: 41155894
+  <<: *private_test_script
+  rules:
+    - if: "$CI_SKIP =~ /m_hdenergy/"
       when: never
     - !reference [.private_test_script, rules]
 
 private_tests_done:
   stage: private_tests_done
   tags:
-  - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/build:20221121
+    - hydroqc
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.13:latest
   script:
     #- apt-get update && apt-get install --no-install-recommends -y python3.10 python3-venv python3-pip --no-install-recommends git
     - echo "Private Tests done"
-    #- pip install tox
     - find .
     - mv -v hydroqc/.coverage* .
     - mv -v hydroqc/*.xml .
@@ -224,19 +278,28 @@ private_tests_done:
       - "*-badge.svg"
       - "*-job-end-date.svg"
   rules:
-    - if: '$CI_SKIP =~ /done/'
+    # Disable if CI_SKIP is set
+    - if: "$CI_SKIP =~ /done/"
       when: never
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-      #when: never
-    - if: '$CI_COMMIT_TAG'
+    # Disable if it's a tag pipeline
+    - if: "$CI_COMMIT_TAG"
       when: never
-    - when: on_success
+    # Enabled for main branch
+    - if: "$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH"
+      when: on_success
+    # Enable for all other branches if it's a MR pipeline
+    - if: "$CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH && $CI_MERGE_REQUEST_IID"
+      when: on_success
+    # Make it manual for external MR
+    - if: "$CI_MERGE_REQUEST_IID && $CI_MERGE_REQUEST_PROJECT_PATH != $CI_MERGE_REQUEST_SOURCE_PROJECT_PATH"
+      when: manual
+    - when: never
 
 package:
   stage: test
   tags:
-  - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/build:20221121
+    - hydroqc
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.13:latest
   script:
     # Build a package with a version based on the commmit short sha
     - pip install --upgrade pip
@@ -245,19 +308,31 @@ package:
     - python3 -m twine check --strict dist/*
     - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python3 -m twine upload --verbose --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
   rules:
-    - if: '$CI_SKIP =~ /package/'
+    # Disable if CI_SKIP is set
+    - if: "$CI_SKIP =~ /package/"
+      when: never
+    # Disable if it's a tag pipeline
+    - if: "$CI_COMMIT_TAG"
       when: never
-    - if: '$CI_COMMIT_TAG'
+    # Disable if it's a scheduled pipeline
+    - if: "$CI_PIPELINE_SOURCE == 'schedule'"
       when: never
-    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH'
+    # Enabled for main branch
+    - if: "$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH"
+      when: on_success
+    # Enable for all other branches if it's a MR pipeline
+    - if: "$CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH && $CI_MERGE_REQUEST_IID"
       when: on_success
+    # Make it manual for external MR
+    - if: "$CI_MERGE_REQUEST_IID && $CI_MERGE_REQUEST_PROJECT_PATH != $CI_MERGE_REQUEST_SOURCE_PROJECT_PATH"
+      when: manual
     - when: never
 
 promote2pypi:
   stage: pypi
   tags:
-  - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/build:20221121
+    - hydroqc
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.13:latest
   script:
     # TODO: try to pull the good package from gitlab pypi repo
     #       then change the version (promote)
@@ -272,17 +347,17 @@ promote2pypi:
     #- |
     #  pip download Hydro-Quebec-API-Wrapper --extra-index-url https://gitlab.com/api/v4/projects/${CI_PROJECT_ID}/packages/pypi/simple --no-deps
     # TODO: open archives edit versions and rebuild archive
-    #- cd ..
-    #- apt-get update && apt-get install --no-install-recommends -y python3.10 python3-venv python3-pip git
+
     # Build package that could be promoted
     - pip install --upgrade pip
     - pip install --upgrade build setuptools_scm twine
     - python3 -m build -o dist
     - python3 -m twine check --strict dist/*
     - twine upload --verbose --non-interactive --repository pypi dist/*
+    - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python3 -m twine upload --verbose --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
   rules:
-    - if: '$CI_SKIP =~ /pypi/'
+    - if: "$CI_SKIP =~ /pypi/"
       when: never
-    - if: '$CI_COMMIT_TAG'
+    - if: "$CI_COMMIT_TAG"
       when: on_success
     - when: never

{Hydro-Quebec-API-Wrapper-0.6.9 → hydro_quebec_api_wrapper-0.8.1}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.3.0
+  rev: v6.0.0
   hooks:
   - id: trailing-whitespace
   - id: end-of-file-fixer
@@ -16,38 +16,40 @@ repos:
   - id: check-ast
 
 - repo: https://github.com/psf/black
-  rev: 22.10.0
+  rev: 25.12.0
   hooks:
   - id: black
     language_version: python3
 
 - repo: https://github.com/PyCQA/flake8/
-  rev: 5.0.4
+  rev: 7.3.0
   hooks:
   - id: flake8
     additional_dependencies: [flake8-docstrings]
 
 - repo: https://github.com/PyCQA/isort
-  rev: 5.10.1
+  rev: 7.0.0
   hooks:
   - id: isort
     args: ["--profile", "black", "--filter-files"]
     #    additional_dependencies: [toml]
 
 - repo: https://github.com/PyCQA/doc8
-  rev: v1.0.0
+  rev: v2.0.0
   hooks:
   - id: doc8
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v0.981
+  rev: v1.19.1
   hooks:
   - id: mypy
     args: [--strict, --pretty, --show-error-codes]
     additional_dependencies:
-      - "types-pytz==2022.6.0.1"
-      - "types-PyYAML==6.0.12.2"
-      - "types-python-dateutil==2.8.19.4"
+      - "types-pytz==2025.2.0.20251108"
+      - "types-PyYAML==6.0.12.20250915"
+      - "types-python-dateutil==2.9.0.20260124"
       - "pytest-stub==1.1.0"
-      - "aiohttp==3.8.3"
-      - "aiocache==0.11.1"
+      - "aiohttp==3.13.3"
+      - "aiocache==0.12.3"
+      - "pkce==1.0.3"
+      - "pytest-asyncio==1.3.0"

{Hydro-Quebec-API-Wrapper-0.6.9 → hydro_quebec_api_wrapper-0.8.1}/.pylintrc

@@ -239,7 +239,7 @@ max-returns=10
 max-branches=20
 
 # Maximum number of statements in function / method body
-max-statements=80
+max-statements=70
 
 # Maximum number of parents for a class (see R0901).
 max-parents=7
@@ -251,7 +251,7 @@ max-attributes=25
 min-public-methods=1
 
 # Maximum number of public methods for a class (see R0904).
-max-public-methods=30
+max-public-methods=40
 
 
 [IMPORTS]
@@ -276,7 +276,7 @@ int-import-graph=
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception
 
 max-nested-blocks=7
 max-bool-expr=10

hydro_quebec_api_wrapper-0.8.1/Hydro_Quebec_API_Wrapper.egg-info/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: Hydro-Quebec-API-Wrapper
+Version: 0.8.1
+Summary: A wrapper library to access hydro quebec API and more
+Home-page: https://hydroqc.ca
+Author-email: Hydroqc Team <info@hydroqc.ca>
+License: LGPL-3.0-or-later
+Project-URL: Source Code, https://gitlab.com/hydroqc/hydroqc
+Project-URL: Bug Reports, https://gitlab.com/hydroqc/hydroqc/-/issues
+Project-URL: Home-page, https://hydroqc.ca
+Keywords: hydroquebec,lib
+Platform: any
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp<4.0.0,>=3.10.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: pytz>=2024.1
+Requires-Dist: aiocache>=0.12.0
+Requires-Dist: pkce>=1.0.3
+Dynamic: license-file
+
+# HydroQC - Hydro Quebec API wrapper
+
+
+[![coverage report](https://gitlab.com/hydroqc/hydroqc/badges/main/coverage.svg)](https://gitlab.com/hydroqc/hydroqc/-/commits/main)
+[![pipeline status](https://gitlab.com/hydroqc/hydroqc/badges/main/pipeline.svg)](https://gitlab.com/hydroqc/hydroqc/-/commits/main)
+
+
+
+**This is a library to use if you want to build your own solution. If you want a user-friendly implementation for your home automation system please use [hydroqc2mqtt](https://gitlab.com/hydroqc/hydroqc2mqtt) which provide a MQTT publisher, docker image and HASS addon.**
+
+This is a package to access some functionalities of Hydro Quebec API that are not documented.
+
+We started a discord server for the project where you can come to discuss and find help with the project on our [#development](https://discord.gg/NWnfdfRZ7T) channel
+
+## Donations
+
+We put a lot of heart and effort in this project, any contribution is greatly appreciated!
+
+[![Donate](https://img.shields.io/badge/Donate-Hydroqc-green)](https://hydroqc.ca/en/donations)
+
+## Tested Rates
+
+Each account, contracts and rates are different and we do our best to integrate all available options. Currently the account combinations listed below are supported and tested automaticaly by our CI/CD pipeline. If your account scenario is not currently tested and listed as **Needed** feel free to reach out to us on our discord [#development](https://discord.gg/NWnfdfRZ7T) channel if you want to volunter for testing. We provide a way to setup CI/CD tests in your own account in a way that keep your account info private to you (more details [here](https://gitlab.com/hydroqc/hydroqc-test-template)). Keep in mind that this process is a bit involved technicaly so it is best if you have some working knowledge with Gitlab.
+
+### Rate D
+
+| Base Rate | Rate Option | Tester | Test result | Last run | Comment |
+| - | - | - | - | - | - |
+| D | - | @weimdall | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39038345-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39038345-job-end-date.svg?job=private_tests_done) | |
+| D | - | @mdallaire1 | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/52728916-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/52728916-job-end-date.svg?job=private_tests_done) | |
+| D | - | @devzwf | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39310934-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39310934-job-end-date.svg?job=private_tests_done) | Hilo |
+| D | CPC | @titilambert |![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/35085986-badge.svg?job=private_tests_done)  | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/35085986-job-end-date.svg?job=private_tests_done) | |
+
+#### Flex D (DPC)
+
+| Base Rate | Rate Option  | Tester | Test result | Last run | Comment |
+| - | - | - | - | - | - |
+| DPC | - | @mdallaire1 | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39503160-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39503160-job-end-date.svg?job=private_tests_done) | |
+
+#### Dual Energy (DT)
+
+| Base Rate | Rate Option | Tester | Test result | Last run | Comment |
+| - | - | - | - | - | - |
+| DT | - | @mdallaire1 | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/52729124-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/52729124-job-end-date.svg?job=private_tests_done) |
+
+#### Rate M
+
+| Base Rate | Rate Option | Tester | Test result | Last run | Comment |
+| - | - | - | - | - | - |
+| M | - | @hdenergy | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/41155894-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39503160-job-end-date.svg?job=private_tests_done) | [HD Énergie](https://hd.energy) |
+| M | GDP | @hdenergy | ![Test Result](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/41155894-badge.svg?job=private_tests_done) | ![Timestamp](https://gitlab.com/api/v4/projects/hydroqc%2Fhydroqc/jobs/artifacts/main/raw/39503160-job-end-date.svg?job=private_tests_done) | [HD Énergie](https://hd.energy) |
+
+Thanks to [HD Énergie](https://hd.energy) for sponsoring developpement of the Rate M support.
+
+### Other plans
+We don't have anyone to test with. Please reach out to us if you have this plan and want to help!
+
+## Documentation
+
+### Code documentation
+
+[https://hydroqc.readthedocs.io/](https://hydroqc.readthedocs.io/)
+
+### Architecture / concepts
+
+If you need more information about the usage and current integrations of the library please see our website [https://hydroqc.ca](https://hydroqc.ca)
+
+## Goal
+
+Make it easy to fetch and manipulate data from Hydro-Quebec, especially the winter credit periods
+
+## Example folder
+
+An example script that extracts the data available from Hydro-Quebec is available in the examples folder.
+
+### Basic setup
+
+This uses python 3.10
+
+1. Clone the repo
+
+   ```bash
+   git clone https://gitlab.com/hydroqc/hydroqc.git
+   ```
+
+2. Create a virtual-env
+
+   ```bash
+   python -m venv env
+   . env/bin/activate
+   pip install --editable .
+   ```
+
+3. Enter your hydro account credentials in the examples/hydro.py file (line 6)
+
+4. Run
+
+   ```bash
+   examples/hydro.py
+   ```
+
+## TODO
+
+[https://gitlab.com/groups/hydroqc/-/issues](https://gitlab.com/groups/hydroqc/-/issues)
+
+## Targeted architecture (might change in the future)
+
+```mermaid
+classDiagram
+    WebUser <-- Customer
+    WebUser <-- HydroClient
+
+    Customer <-- Account
+
+    Account <-- Contract
+
+    Contract <-- HydroClient
+    Contract <-- Period
+    Contract <-- Event
+    Contract <-- WinterCreditHelper
+
+    WinterCreditHelper <-- HydroClient
+
+
+    HydroClient <-- Authenticator
+
+    class HydroClient{
+
+    }
+    class WinterCreditHelper{
+    }
+
+    class WebUser{
+        -HydroClient _hydro_client
+        +List~Customer~ customers
+        +get_contracts()
+    }
+
+    class Customer{
+        -HydroClient _hydro_client
+        +List~Account~ accounts
+    }
+
+    class Account{
+        -HydroClient _hydro_client
+        +List~Contract~ contracts
+    }
+
+    class Config{
+        -string config_file_path
+    }
+
+    class Contract{
+        -HydroClient _hydro_client
+        -int customer_id
+        -int webuser_id
+        +string subscription_type
+        +float balance
+        +list~Period~ periods
+        +list~Event~ events
+        +get_winter_credit()
+        +fetch_periods()
+        +fetch_summary()
+    }
+
+    class Period{
+    }
+
+    class Event{
+    }
+```