eolas-data 1.3.13__tar.gz → 1.3.14__tar.gz

eolas_data-1.3.14/.github/workflows/pre-release.yml

@@ -0,0 +1,50 @@
+name: Pre-release gate
+
+on:
+  workflow_dispatch:
+
+jobs:
+  gate:
+    runs-on: ubuntu-latest
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Client contract matrix
+        run: python scripts/check_client_contract.py
+
+      - name: Build + install wheel
+        run: |
+          pip install build
+          python -m build
+          WHL=$(ls -1 dist/*.whl | head -1)
+          pip install "$WHL"
+          pip install pytest responses geopandas shapely pandas pyarrow typer rich keyring
+
+      - name: Unit tests (installed package)
+        run: pytest -q -m "not integration"
+
+      - name: Live smoke
+        env:
+          EOLAS_API_KEY: ${{ secrets.EOLAS_API_KEY }}
+        run: |
+          if [ -z "$EOLAS_API_KEY" ]; then
+            echo "::error::EOLAS_API_KEY secret required for pre-release smoke."
+            exit 1
+          fi
+          pytest -q -m integration tests/test_smoke_live.py
+
+      - name: Version parity with eolas-r
+        run: |
+          set -euo pipefail
+          py_ver=$(grep -E '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          r_ver=$(curl -fsSL "https://raw.githubusercontent.com/phildonovan/eolas-r/master/DESCRIPTION" \
+            | awk -F': ' '/^Version:/{print $2; exit}')
+          echo "Python: $py_ver | R (master): $r_ver"
+          if [ "$py_ver" != "$r_ver" ]; then
+            echo "::warning::Client versions differ — bump both before tagging if shipping related fixes"
+          fi

eolas_data-1.3.14/.github/workflows/publish.yml

@@ -0,0 +1,103 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  version-parity:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Compare tag to eolas-r DESCRIPTION
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          set -euo pipefail
+          expected="${TAG#v}"
+          r_ver=$(curl -fsSL "https://raw.githubusercontent.com/phildonovan/eolas-r/master/DESCRIPTION" \
+            | awk -F': ' '/^Version:/{print $2; exit}')
+          py_ver=$(grep -E '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          echo "Tag: $expected | R: $r_ver | Python (pyproject): $py_ver"
+          if [ "$expected" != "$py_ver" ]; then
+            echo "::error::Tag $TAG does not match pyproject.toml version $py_ver"
+            exit 1
+          fi
+          if [ "$expected" != "$r_ver" ]; then
+            echo "::warning::R package version ($r_ver) differs from tag ($expected) — align releases when possible"
+          fi
+
+  test:
+    runs-on: ubuntu-latest
+    needs: version-parity
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheel
+        run: pip install build && python -m build
+
+      - name: Install wheel + test deps
+        run: |
+          WHL=$(ls -1 dist/*.whl | head -1)
+          pip install "$WHL"
+          pip install pytest responses geopandas shapely pandas pyarrow typer rich keyring
+
+      - name: Client contract matrix
+        run: python scripts/check_client_contract.py
+
+      - name: pytest
+        run: pytest -q -m "not integration"
+
+  smoke:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install package from tag
+        run: pip install ".[dev,geo]"
+      - name: Live smoke (pre-publish gate)
+        env:
+          EOLAS_API_KEY: ${{ secrets.EOLAS_API_KEY }}
+        run: |
+          if [ -z "$EOLAS_API_KEY" ]; then
+            echo "::warning::EOLAS_API_KEY not set — skipping publish smoke"
+            exit 0
+          fi
+          pytest -q -m integration tests/test_smoke_live.py
+
+  publish:
+    needs: [test, smoke]
+    if: needs.test.result == 'success'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # Uses PYPI_API_TOKEN when set; otherwise OIDC trusted publishing.
+          password: ${{ secrets.PYPI_API_TOKEN }}

{eolas_data-1.3.13 → eolas_data-1.3.14}/.github/workflows/smoke.yml

@@ -15,6 +15,16 @@ jobs:
         with:
           python-version: "3.12"
 
+      - name: Require API key on manual runs
+        if: github.event_name == 'workflow_dispatch'
+        env:
+          EOLAS_API_KEY: ${{ secrets.EOLAS_API_KEY }}
+        run: |
+          if [ -z "$EOLAS_API_KEY" ]; then
+            echo "::error::EOLAS_API_KEY secret is required for workflow_dispatch smoke runs."
+            exit 1
+          fi
+
       - name: Install package + dev/geo deps (as users would)
         run: pip install ".[dev,geo]"
 
@@ -23,7 +33,7 @@ jobs:
           EOLAS_API_KEY: ${{ secrets.EOLAS_API_KEY }}
         run: |
           if [ -z "$EOLAS_API_KEY" ]; then
-            echo "EOLAS_API_KEY secret not configured — skipping smoke tests."
+            echo "EOLAS_API_KEY secret not configured — skipping scheduled smoke tests."
             exit 0
           fi
           pytest -q -m integration tests/test_smoke_live.py

eolas_data-1.3.14/.github/workflows/test.yml

@@ -0,0 +1,81 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  contract:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Client contract matrix
+        run: python scripts/check_client_contract.py
+
+  test:
+    runs-on: ubuntu-latest
+    needs: contract
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12", "3.13"]
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package + dev + geo + secure (editable)
+        run: pip install -e ".[dev,geo,secure]"
+
+      - name: pytest (unit suite)
+        run: pytest -q -m "not integration"
+
+  test-installed:
+    runs-on: ubuntu-latest
+    needs: contract
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheel
+        run: pip install build && python -m build
+
+      - name: Install built wheel + test deps (as users would)
+        run: |
+          WHL=$(ls -1 dist/*.whl | head -1)
+          pip install "$WHL"
+          pip install pytest responses geopandas shapely pandas pyarrow typer rich keyring
+
+      - name: pytest on installed package
+        run: pytest -q -m "not integration"
+
+  coverage:
+    runs-on: ubuntu-latest
+    needs: contract
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e ".[dev,geo,secure]" pytest-cov
+      - run: pytest -q -m "not integration" --cov=eolas_data --cov-report=xml
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false

{eolas_data-1.3.13 → eolas_data-1.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eolas-data
-Version: 1.3.13
+Version: 1.3.14
 Summary: Python client for the eolas.fyi statistical data API (NZ, Australia, OECD)
 Project-URL: Homepage, https://eolas.fyi
 Project-URL: Documentation, https://docs.eolas.fyi/

{eolas_data-1.3.13 → eolas_data-1.3.14}/eolas_data/client.py

@@ -2063,6 +2063,7 @@ class Client:
         meta: bool = True,
         envelope: bool = False,
         force: bool = False,
+        progress: ProgressControl = None,
     ) -> Dataset:
         """Fetch dataset rows as a pandas (or polars / geopandas) DataFrame.
 
@@ -2103,6 +2104,11 @@ class Client:
             envelope: When ``True``, request ``?envelope=1`` (JSON only) and
                     attach the ``data_sources`` licence block alongside rows.
                     Response ``X-Eolas-*`` headers are merged into metadata.
+            force: When ``True`` and the request auto-routes to :meth:`get_local`,
+                    re-download the bulk file even when the sidecar says current.
+            progress: Control bulk download/read progress when auto-routed to
+                    :meth:`get_local`. ``None`` auto-detects TTY; ignored on the
+                    live API path.
 
         Returns:
             A :class:`Dataset` (pandas DataFrame subclass), a polars DataFrame
@@ -2148,7 +2154,12 @@ class Client:
                 info_meta = self._info_cached(name)
                 if self._bulk_export_allowed(info_meta) and self._live_pull_blocked(info_meta):
                     result = self.get_local(
-                        name, as_geo=as_geo, as_arrow=False, meta=meta, force=force,
+                        name,
+                        as_geo=as_geo,
+                        as_arrow=False,
+                        meta=meta,
+                        force=force,
+                        progress=progress,
                     )
                     if engine == "polars":
                         try:

{eolas_data-1.3.13 → eolas_data-1.3.14}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "eolas-data"
-version = "1.3.13"
+version = "1.3.14"
 description = "Python client for the eolas.fyi statistical data API (NZ, Australia, OECD)"
 readme = "README.md"
 license = { text = "MIT" }

eolas_data-1.3.14/scripts/check_client_contract.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+"""Verify parity scenario tests from eolas/docs/client-contract.md exist locally.
+
+Run in CI and before release. Cross-repo version parity is checked separately
+in .github/workflows/version-parity.yml on tag push.
+"""
+from __future__ import annotations
+
+import pathlib
+import sys
+
+ROOT = pathlib.Path(__file__).resolve().parents[1]
+TESTS = ROOT / "tests"
+
+# filename -> substrings that must appear in that file
+REQUIRED: dict[str, list[str]] = {
+    "test_progress.py": [
+        "test_download_bulk_missing_content_length",
+        "Deliberately no Content-Length",
+    ],
+    "test_sync_bulk.py": [
+        "test_sync_bulk_force_redownloads_when_unchanged",
+        "test_cache_clear_removes_files_and_session_meta",
+    ],
+    "test_client.py": [
+        "test_get_whole_dataset_defers_to_get_local_for_large_geo",
+    ],
+    "test_meta.py": [
+        "test_attach_meta_geodataframe_head_does_not_break_repr",
+    ],
+    "test_smoke_live.py": [
+        "test_linz_nz_addresses_bulk_route_and_head",
+        "test_client_exports_cache_clear",
+    ],
+}
+
+
+def main() -> int:
+    errors: list[str] = []
+    for filename, patterns in REQUIRED.items():
+        path = TESTS / filename
+        if not path.exists():
+            errors.append(f"missing test file: {filename}")
+            continue
+        text = path.read_text(encoding="utf-8")
+        for pat in patterns:
+            if pat not in text:
+                errors.append(f"{filename}: missing required pattern {pat!r}")
+
+    if errors:
+        print("Client contract check FAILED (see eolas/docs/client-contract.md):")
+        for err in errors:
+            print(f"  - {err}")
+        return 1
+
+    print("Client contract check OK (Python)")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

eolas_data-1.3.13/.github/workflows/publish.yml

@@ -1,49 +0,0 @@
-name: Publish to PyPI
-
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    env:
-      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install package + dev deps
-        run: pip install -e ".[dev,secure]"
-
-      - name: pytest
-        run: pytest -q -m "not integration"
-
-  publish:
-    needs: test
-    runs-on: ubuntu-latest
-    environment: pypi
-    permissions:
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install build tools
-        run: pip install hatchling build
-
-      - name: Build
-        run: python -m build
-
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}

eolas_data-1.3.13/.github/workflows/test.yml

@@ -1,40 +0,0 @@
-name: Tests
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10", "3.12", "3.13"]
-    env:
-      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install package + dev + secure (install-tests the keyring extra)
-        run: pip install -e ".[dev,secure]"
-
-      - name: pytest (unit suite)
-        run: pytest -q -m "not integration"
-
-  coverage:
-    runs-on: ubuntu-latest
-    env:
-      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-      - run: pip install -e ".[dev,secure]" pytest-cov
-      - run: pytest -q -m "not integration" --cov=eolas_data --cov-report=term-missing