Merge branch 'develop'

Author: Stéphane Senart

.github/workflows/ci.yaml

@@ -26,8 +26,8 @@ permissions:
   contents: read # Read-only access
 
 env:
-  DEFAULT_PYTHON_VERSION: "3.12"
-  TARGET_PYTHON_VERSIONS: "[ '3.9', '3.10', '3.11', '3.12', '3.13' ]"
+  DEFAULT_PYTHON_VERSION: "3.13"
+  TARGET_PYTHON_VERSIONS: "[ '3.10', '3.11', '3.12', '3.13' ]"
 
 jobs:
   #----------------------------------------------

.github/workflows/create-release.yaml

@@ -13,7 +13,7 @@ permissions:
   contents: write # Allow to commit and push.
 
 env:
-  DEFAULT_PYTHON_VERSION: "3.12"
+  DEFAULT_PYTHON_VERSION: "3.13"
 
 jobs:
   #----------------------------------------------
@@ -76,17 +76,11 @@ jobs:
         with:
           fetch-tags: true
 
-      #----------------------------------------------
-      # Set the package version
-      - name: Set package version
-        run: echo "PACKAGE_VERSION=${{ needs.prepare.outputs.package-version }}" >> $GITHUB_ENV
-
       #----------------------------------------------
       # Install & configure poetry  -----
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
-          version: 2.0.0
           virtualenvs-create: true
           virtualenvs-in-project: true
           virtualenvs-path: .venv
@@ -95,10 +89,6 @@ jobs:
       - name: Bump version to ${{ needs.prepare.outputs.package-version }}
         run: poetry version ${{ needs.prepare.outputs.package-version }}
 
-      #----------------------------------------------
-      - name: Build package
-        run: poetry build        
-
       #----------------------------------------------
       # Commit the changes
       - name: Commit changes
@@ -124,6 +114,10 @@ jobs:
         with:
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
 
+      #----------------------------------------------
+      - name: Build package
+        run: poetry build       
+
       #----------------------------------------------
       - name: Upload package
         uses: actions/upload-artifact@v4

.github/workflows/python-lint/action.yaml

@@ -23,38 +23,15 @@ runs:
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
+        virtualenvs-path: .venv
 
     #----------------------------------------------
-    # Load cached venv if cache exists
-    - name: Load cached venv
-      id: cached-poetry-dependencies
-      uses: actions/cache@v4
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-
-    #----------------------------------------------
-    # Install dependencies if cache does not exist
-    - name: Install dependencies
-      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-      shell: bash
-      run: poetry install --no-interaction --no-root
-
-    #----------------------------------------------
-    # Install root project, if required
+    # Install project
     #----------------------------------------------
     - name: Install project
       shell: bash
       run: poetry install --no-interaction
 
-    #----------------------------------------------
-    #  Load pip cache if cache exists
-    - uses: actions/cache@v4
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip
-        restore-keys: ${{ runner.os }}-pip
-
     #----------------------------------------------
     #  Run Pylint    
     - name: Pylint

.github/workflows/python-test/action.yaml

@@ -23,32 +23,17 @@ runs:
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
+        virtualenvs-path: .venv
 
     #----------------------------------------------
-    # Load cached venv if cache exists
-    - name: Load cached venv
-      id: cached-poetry-dependencies
-      uses: actions/cache@v4
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-
-    #----------------------------------------------
-    # Install dependencies if cache does not exist
-    - name: Install dependencies
-      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-      shell: bash
-      run: poetry install --no-interaction --no-root
-
-    #----------------------------------------------
-    # Install your root project, if required
+    # Install project
     #----------------------------------------------
-    - name: Install library
+    - name: Install project
       shell: bash
       run: poetry install --no-interaction
 
     #----------------------------------------------
-    # If not using devcontainer, run tests
+    # Run tests
     - name: Test with pytest
       shell: bash
       run: poetry run pytest tests

CHANGELOG.md

@@ -4,7 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.3.0] - 2025-02-08
+## [1.3.0] - 2025-02-15
+
+### Added
+
+[#84](https://github.com/ssenart/PyGazpar/issues/84) : Add a function to retrieve list of PCE ids.
 
 ### Changed
 

README.md

@@ -1,7 +1,5 @@
 # PyGazpar
 
-## $\text{\color{green}{!!! This library is working again. CAPTCHA has been removed !!!}}$
-
 PyGazpar is a Python library for getting natural gas consumption from GrDF French provider.
 
 Their natural gas meter is called Gazpar. It is wireless and transmit the gas consumption once per day.
@@ -76,8 +74,12 @@ client = pygazpar.Client(pygazpar.JsonWebDataSource(
     password='your password')
 )
 
-data = client.loadSince(pceIdentifier='your PCE identifier',
-                        lastNDays=60,
+# Returns the list of your PCE identifiers attached to your account.
+pce_identifiers = client.get_pce_identifiers()
+
+# Returns the daily and monthly consumptions for the last 60 days on your PCE identifier.
+data = client.load_since(pce_identifier='your PCE identifier',
+                        last_n_days=60,
                         frequencies=[pygazpar.Frequency.DAILY, pygazpar.Frequency.MONTHLY])
 ```
 See [samples/jsonSample.py](samples/jsonSample.py) file for the full example.
@@ -92,8 +94,12 @@ client = pygazpar.Client(pygazpar.ExcelWebDataSource(
     password='your password')
 )
 
-data = client.loadSince(pceIdentifier='your PCE identifier',
-                        lastNDays=60,
+# Returns the list of your PCE identifiers attached to your account.
+pce_identifiers = client.get_pce_identifiers()
+
+# Returns the daily and monthly consumptions for the last 60 days on your PCE identifier.
+data = client.load_since(pce_identifier='your PCE identifier',
+                        last_n_days=60,
                         frequencies=[pygazpar.Frequency.DAILY, pygazpar.Frequency.MONTHLY])
 ```
 See [samples/excelSample.py](samples/jsonSample.py) file for the full example.
@@ -105,8 +111,8 @@ import pygazpar
 
 client = pygazpar.Client(pygazpar.TestDataSource())
 
-data = client.loadSince(pceIdentifier='your PCE identifier',
-                        lastNDays=10,
+data = client.load_since(pce_identifier='your PCE identifier',
+                        last_n_days=10,
                         frequencies=[pygazpar.Frequency.DAILY, Frequency.MONTHLY])
 ```
 See [samples/testSample.py](samples/jsonSample.py) file for the full example.

gitversion.yaml

@@ -1,8 +1,8 @@
 # Python package version (PEP440): https://peps.python.org/pep-0440/
 
-assembly-file-versioning-format: '{MajorMinorPatch}{PreReleaseLabel}{env:GITHUB_RUN_NUMBER  ?? 0}'
-assembly-versioning-format: '{MajorMinorPatch}{PreReleaseLabel}{env:GITHUB_RUN_NUMBER  ?? 0}'
-assembly-informational-format: '{MajorMinorPatch}{PreReleaseLabel}{env:GITHUB_RUN_NUMBER  ?? 0}'
+assembly-file-versioning-format: '{MajorMinorPatch}{PreReleaseLabel}{CommitsSinceVersionSource}'
+assembly-versioning-format: '{MajorMinorPatch}{PreReleaseLabel}{CommitsSinceVersionSource}'
+assembly-informational-format: '{MajorMinorPatch}{PreReleaseLabel}{CommitsSinceVersionSource}'
 
 branches:
   develop:
@@ -14,6 +14,7 @@ branches:
   release:
     regex: ^release/(?<BranchName>.+) 
     label: 'b'
+    increment: None
   feature:
     regex: ^feature/(?<BranchName>.+)
     label: '.dev'

poetry.lock

@@ -7,6 +7,8 @@
 
 import pygazpar
 
+Logger = logging.getLogger(__name__)
+
 
 def main():
     """Main function"""
@@ -37,6 +39,9 @@ def main():
 
     args = parser.parse_args()
 
+    print(f"PyGazpar version: {pygazpar.__version__}")
+    print(f"Running on Python version: {sys.version}")
+
     # We create the tmp directory if not already exists.
     if not os.path.exists(args.tmpdir):
         os.mkdir(args.tmpdir)
@@ -51,11 +56,12 @@ def main():
         filename=f"{pygazparLogFile}", level=logging.DEBUG, format="%(asctime)s %(levelname)s [%(name)s] %(message)s"
     )
 
-    logging.info(f"PyGazpar {pygazpar.__version__}")
-    logging.info(f"--tmpdir {args.tmpdir}")
-    logging.info(f"--frequency {args.frequency}")
-    logging.info(f"--lastNDays {args.lastNDays}")
-    logging.info(f"--datasource {bool(args.datasource)}")
+    Logger.info(f"PyGazpar version: {pygazpar.__version__}")
+    Logger.info(f"Running on Python version: {sys.version}")
+    Logger.info(f"--tmpdir {args.tmpdir}")
+    Logger.info(f"--frequency {args.frequency}")
+    Logger.info(f"--lastNDays {args.lastNDays}")
+    Logger.info(f"--datasource {bool(args.datasource)}")
 
     if args.datasource == "json":
         client = pygazpar.Client(pygazpar.JsonWebDataSource(args.username, args.password))
@@ -67,11 +73,13 @@ def main():
         raise ValueError("Invalid datasource: (json | excel | test) is expected")
 
     try:
-        data = client.loadSince(args.pce, int(args.lastNDays), [args.frequency])
+        data = client.load_since(args.pce, int(args.lastNDays), [args.frequency])
     except BaseException:  # pylint: disable=broad-except
         print("An error occured while querying PyGazpar library : %s", traceback.format_exc())
         return 1
 
+    Logger.info(f"Data loaded: {len(data)} records")
+    Logger.debug(f"Data: {data}")
     print(json.dumps(data, indent=2))
 
     return 0