eolas-data 1.8.0__tar.gz → 1.9.1__tar.gz

{eolas_data-1.8.0 → eolas_data-1.9.1}/.github/workflows/catalog-drift.yml

@@ -17,7 +17,7 @@ jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - uses: actions/setup-python@v5
         with:

eolas_data-1.9.1/.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@v5
+      - 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.9.1/.github/workflows/publish.yml

@@ -0,0 +1,143 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  version-parity:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - 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
+
+      - name: Guard — version must not already exist on PyPI
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          # PyPI permanently reserves a filename once uploaded, INCLUDING for
+          # yanked releases — a yanked version can never be re-published. This
+          # repo has a burned band at 1.5.0-1.8.0 (uploaded May 2026, yanked),
+          # and development later resumed BELOW it on the 1.3.x line, so a naive
+          # minor bump can walk straight back into it. Without this guard that
+          # failure surfaces only at the upload step, after a full build+test,
+          # as an opaque "400 File already exists".
+          set -euo pipefail
+          expected="${TAG#v}"
+          taken=$(curl -fsSL "https://pypi.org/pypi/eolas-data/json" \
+            | python3 -c "import json,sys; print('yes' if '$expected' in json.load(sys.stdin)['releases'] else 'no')")
+          if [ "$taken" = "yes" ]; then
+            echo "::error::Version $expected already exists on PyPI (possibly yanked)."
+            echo "::error::Yanked versions permanently reserve their filenames and cannot be re-published."
+            echo "::error::Pick a version above every existing release and re-tag."
+            exit 1
+          fi
+          echo "Version $expected is free on PyPI."
+
+  test:
+    runs-on: ubuntu-latest
+    needs: version-parity
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v5
+
+      - 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: Version self-report parity (REL-1)
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          set -euo pipefail
+          expected="${TAG#v}"
+          # __version__ is read from installed distribution metadata, so this
+          # asserts the wheel the user pip-installs self-reports the tag — the
+          # exact drift (shipped 1.3.21 said 1.3.20) that this gate structurally
+          # closes. Run from /tmp so the source tree's __init__ can't shadow.
+          reported=$(cd /tmp && python -c "import eolas_data; print(eolas_data.__version__)")
+          echo "Tag: $expected | __version__: $reported"
+          if [ "$reported" != "$expected" ]; then
+            echo "::error::Installed eolas_data.__version__ ($reported) != tag ($expected)"
+            exit 1
+          fi
+
+      - 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@v5
+      - 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@v5
+
+      - 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.9.1/.github/workflows/smoke.yml

@@ -0,0 +1,39 @@
+name: Live API smoke
+
+on:
+  schedule:
+    - cron: "0 8 * * 1"  # Mondays 08:00 UTC
+  workflow_dispatch:
+
+jobs:
+  smoke:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v5
+        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]"
+
+      - name: Live smoke tests
+        env:
+          EOLAS_API_KEY: ${{ secrets.EOLAS_API_KEY }}
+        run: |
+          if [ -z "$EOLAS_API_KEY" ]; then
+            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.9.1/.github/workflows/test.yml

@@ -0,0 +1,84 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  contract:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - 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@v5
+
+      - 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@v5
+
+      - 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
+    permissions:
+      id-token: write
+    env:
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+    steps:
+      - uses: actions/checkout@v5
+      - 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@v5
+        with:
+          files: coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false

eolas_data-1.9.1/CHANGELOG.md

@@ -0,0 +1,130 @@
+# Changelog
+
+All notable changes to `eolas-data` are recorded here. This project follows
+[Semantic Versioning](https://semver.org/).
+
+## 1.9.1
+
+### Changed
+
+- **`geometry=False` now skips the column at READ time, not after.** 1.9.0 read
+  the whole Parquet — WKT included — and dropped the column afterwards, paying
+  the full parse and peak memory for data discarded a line later. `get_local()`
+  now passes `columns=` to `pd.read_parquet()`, so those column chunks are never
+  decoded, and it deliberately avoids `gpd.read_parquet()` (which would
+  materialise shapely geometry we are about to throw away). `get()` passes the
+  flag down rather than applying it to the result.
+
+  Geometry is typically ~95% of a spatial layer's bytes: `geometry_wkt` is 262 of
+  275 MB in `linz.nz_building_outlines`.
+
+- `get_local()` gains a `geometry` argument, mirroring `get()`.
+
+### Unchanged (deliberately)
+
+- What gets downloaded. One cached artifact still serves both variants, so
+  upgrading a non-spatial read back to spatial re-reads the same local file with
+  no re-download. A test asserts the cache file is byte-identical after a
+  `geometry=False` read. Reducing the *download* is a separate design question —
+  see `docs/geometry-fetch-design-2026-07-22.md` in the eolas repo.
+
+## 1.9.0
+
+> Version jumps 1.4.0 -> 1.9.0. PyPI versions 1.5.0-1.8.0 were uploaded in May
+> 2026 and later yanked; yanked filenames are permanently reserved, so those
+> numbers can never be published again. The 1.9.0 jump clears the band for good.
+> The R client moves to 1.9.0 at the same time so the two stay aligned.
+
+
+### Added
+
+- **`geometry=False` on `get()`** — omit the `geometry_wkt` column. Two-thirds of
+  eolas datasets (1017/1536) carry geometry, and on TA/RC boundary tables the WKT
+  dwarfs the attributes. The column is projected away at the API's storage layer,
+  so it is never read from S3 or transferred — this cuts I/O, not just payload.
+  Responses carry `X-Eolas-Geometry-Omitted: true`.
+
+### Changed
+
+- **Whole-dataset pulls of small spatial tables stay on the live path when
+  `geometry=False`.** Geometry was one of the two triggers for the API's
+  large-dataset (413) guard, so `get("some_boundary_table")` was transparently
+  diverted to a bulk download. The client now mirrors the server's relaxed guard.
+  The row-count trigger is unchanged — dropping a column doesn't reduce row count.
+
+### Fixed
+
+- **`geometry=False` is now honoured on the bulk-routed path.** A spatial table
+  over the 100k-row threshold stays "blocked" even with `geometry=False`, so
+  `get()` routes it to the bulk cache — which has no server-side projection. The
+  flag was dropped at that hand-off, so the caller silently received the full
+  geometry-bearing file and, with `as_geo=None`, an auto-converted GeoDataFrame.
+  Found in peer review.
+- **The in-memory response cache now keys on `geometry`.** Without it,
+  `get(x)` and `get(x, geometry=False)` shared a cache key, so whichever ran
+  second silently returned the other's shape (a whole column different). Only
+  reachable with `Client(cache=True)`.
+
+## 1.4.0
+
+### Added
+
+- **`Client.preview(name)`** — up to 10 sample rows via the unauthenticated
+  `/preview` endpoint. No API key required, no rate-limit cost, geometry hidden.
+  `eolas datasets preview` now uses it instead of burning an authenticated,
+  rate-limited `/data` call (DRIFT-5).
+- **`dimensions=` filter on `get()`** and `eolas get --dimensions` — a
+  case-insensitive substring filter on dimension columns, applied server-side on
+  the live `/data` path (the filter was live in prod but exposed by no client;
+  DRIFT-4).
+
+## 1.3.22
+
+Network-hardening + correctness release, addressing findings from the
+2026-07-05 client-library audit.
+
+### Fixed
+
+- **Request timeouts everywhere (EH-1).** Every HTTP call now carries a default
+  `(10, 300)` second (connect, read) timeout via a session subclass. A
+  black-holed connection raises instead of hanging the caller forever. Override
+  with `Client(timeout=...)`.
+- **Clean errors on transport failures (EH-2).** Connection refused / DNS /
+  timeout / reset now surface as `EolasError("Network error talking to
+  api.eolas.fyi: ...")` instead of a raw urllib3 traceback. The CLI's existing
+  error handler renders them cleanly.
+- **Atomic downloads (EH-5).** `download()` / `download_bulk()` write to a temp
+  file and atomically rename on success, and verify bytes received against
+  `Content-Length`. An interrupted or truncated download now leaves **no file**
+  at the final path instead of a silent partial.
+- **`get()` no longer degrades a bulk failure to a misleading 413 (EH-3).** The
+  auto-route swallow is narrowed to the routing decision; a real failure in the
+  bulk path now propagates instead of falling through to "use bulk download".
+- **Arrow negotiation no longer masks real errors (EH-7).** An auth/404/429
+  during the Arrow attempt now propagates immediately, without the bogus "Arrow
+  IPC unavailable" nag and without re-sending the failed request as JSON. Only a
+  non-Arrow 200 or a genuine pyarrow/IPC decode error downgrades the session.
+- **Watermark floor parsed correctly (DRIFT-2).** The HTTP 410 re-baseline
+  response nests its fields under `detail`; `WatermarkExpired.min_available_seq`
+  was always 0. Now read from the correct level with a top-level fallback.
+- **No more pandas-3 warning on every `get()` (PY-3).** Metadata accessors are
+  set via `object.__setattr__`, bypassing the pandas 3 `UserWarning`.
+- **Orphaned partial downloads are swept (PY-5).** `*.eolas-tmp-*` files >24h
+  old are cleaned on download start; a full `cache_clear()` removes them all.
+- **`download()` docstring corrected (PY-1).** It no longer claims to work for
+  "all datasets" — it is the live path and 413s on whole-dataset pulls of
+  large/geo tables; use `get()` or `download_bulk()` there.
+- **`eolas datasets list` no longer renders a blank ghost column (CLI-1).** On
+  narrow (<100 col) terminals the title column is dropped with a hint instead of
+  being squeezed to zero width.
+- **Bulk-download docs corrected (DRIFT-3).** `download_bulk()` / the CLI
+  `--freshness` help no longer claim Free plans get monthly bulk — bulk is
+  Pro/Enterprise and Free keys receive HTTP 402.
+
+### Changed
+
+- **Single-sourced version (REL-1).** `__version__` is read from installed
+  distribution metadata, so it can never drift from `pyproject.toml` again
+  (shipped 1.3.21 previously self-reported 1.3.20). The publish workflow asserts
+  the installed `__version__` equals the release tag.
+- **`merge_changes` is now a public export (DRIFT-6)** — added to `__all__`.

eolas_data-1.9.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Virtus Solutions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.