hydopt-client 0.0.2__tar.gz

hydopt_client-0.0.2/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

hydopt_client-0.0.2/.github/workflows/test.yml

@@ -0,0 +1,63 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Run ruff
+        run: uv run ruff check src/
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Authenticate to Google Cloud
+        uses: google-github-actions/auth@v2
+        with:
+          token_format: access_token
+          service_account: job-deployer@hydopt.iam.gserviceaccount.com
+          workload_identity_provider: projects/131385138719/locations/global/workloadIdentityPools/github-actions/providers/github-actions-provider
+
+      - name: Configure Docker for GAR
+        run: gcloud auth configure-docker us-central1-docker.pkg.dev --quiet
+
+      - name: Start hydopt-api
+        run: docker compose up -d
+
+      - name: Wait for API
+        run: |
+          for i in $(seq 1 60); do
+            if curl -sf http://localhost:8083/healthz > /dev/null 2>&1; then
+              echo "API ready"
+              exit 0
+            fi
+            sleep 1
+          done
+          docker compose logs
+          exit 1
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Dump API logs
+        if: always()
+        run: docker compose logs

hydopt_client-0.0.2/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+.hydopt-api/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

hydopt_client-0.0.2/Makefile

@@ -0,0 +1,20 @@
+LAST_TAG := $(shell git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+
+## Create a new semver tag based on conventional commits since last tag
+tag:
+	@BUMP=$$(git log $(LAST_TAG)..HEAD --pretty=format:'%s' 2>/dev/null \
+		| grep -qE '!:|BREAKING CHANGE' && echo major \
+		|| git log $(LAST_TAG)..HEAD --pretty=format:'%s' 2>/dev/null \
+		| grep -qE '^feat' && echo minor \
+		|| echo patch); \
+	OLD=$$(echo $(LAST_TAG) | sed 's/^v//'); \
+	NEW=$$(echo $$OLD | awk -v b=$$BUMP -F. '{ \
+		if(b=="major") print $$1+1".0.0"; \
+		else if(b=="minor") print $$1"."$$2+1".0"; \
+		else print $$1"."$$2"."$$3+1}'); \
+	echo "$$OLD -> $$NEW ($$BUMP)"; \
+	git tag "v$$NEW"
+
+## Push the latest tag to origin
+push:
+	@git push origin $(LAST_TAG)

hydopt_client-0.0.2/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.5
+Name: hydopt-client
+Version: 0.0.2
+Summary: Python client for the HydOpt hydropower optimization API
+Requires-Python: >=3.13
+Requires-Dist: google-auth>=2.56.3
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: requests>=2.34.2
+Description-Content-Type: text/markdown
+
+# hydopt-client
+
+Python client for the [HydOpt](https://hydopt.io) hydropower optimization API.
+
+## Install
+
+```bash
+uv add hydopt-client
+```
+
+## Authentication
+
+Authenticate with Google Cloud:
+
+```bash
+gcloud auth application-default login
+```
+
+## Quick Start
+
+```python
+from hydopt_client.client import Client
+
+client = Client()
+
+# List available partition dates
+dates = client.list_partitions()
+print(dates)  # ["2026-01-01", "2026-01-02", ...]
+
+# Fetch a time series
+records = client.series(dates[0], "production")
+for record in records:
+    print(record.name, record.x[0], record.y[0])
+
+# Filter and group results
+from hydopt_client.client import Filters, GroupBy
+
+filtered = client.series(
+    dates[0],
+    "production",
+    filters=Filters(country=["norway"]),
+    group_by=[GroupBy.region],
+)
+```
+
+## Available Methods
+
+| Method | Description |
+|--------|-------------|
+| `list_partitions()` | List available partition dates |
+| `series(asof, category1, ...)` | Query time-series data |
+| `diff(category1, from, to, ...)` | Compare two partitions |
+| `static(category1, ...)` | Query static dataset |
+| `realized(category1, ...)` | Query realized dataset |
+| `catchments(asof)` | Fetch catchment geometries |
+| `orders(asof)` | Fetch energy orders |
+| `object_report(source, target)` | Compare two partition objects |

hydopt_client-0.0.2/README.md

@@ -0,0 +1,57 @@
+# hydopt-client
+
+Python client for the [HydOpt](https://hydopt.io) hydropower optimization API.
+
+## Install
+
+```bash
+uv add hydopt-client
+```
+
+## Authentication
+
+Authenticate with Google Cloud:
+
+```bash
+gcloud auth application-default login
+```
+
+## Quick Start
+
+```python
+from hydopt_client.client import Client
+
+client = Client()
+
+# List available partition dates
+dates = client.list_partitions()
+print(dates)  # ["2026-01-01", "2026-01-02", ...]
+
+# Fetch a time series
+records = client.series(dates[0], "production")
+for record in records:
+    print(record.name, record.x[0], record.y[0])
+
+# Filter and group results
+from hydopt_client.client import Filters, GroupBy
+
+filtered = client.series(
+    dates[0],
+    "production",
+    filters=Filters(country=["norway"]),
+    group_by=[GroupBy.region],
+)
+```
+
+## Available Methods
+
+| Method | Description |
+|--------|-------------|
+| `list_partitions()` | List available partition dates |
+| `series(asof, category1, ...)` | Query time-series data |
+| `diff(category1, from, to, ...)` | Compare two partitions |
+| `static(category1, ...)` | Query static dataset |
+| `realized(category1, ...)` | Query realized dataset |
+| `catchments(asof)` | Fetch catchment geometries |
+| `orders(asof)` | Fetch energy orders |
+| `object_report(source, target)` | Compare two partition objects |

hydopt_client-0.0.2/docker-compose.yml

@@ -0,0 +1,15 @@
+name: hydopt-api
+
+services:
+  api:
+    image: us-central1-docker.pkg.dev/hydopt/hydopt-backend/hydopt-api:20260817T143154-066d541
+    ports:
+      - "${PORT:-8083}:8083"
+    environment:
+      MODE: testing
+      WITH_AUTH: "0"
+    healthcheck:
+      test: ["CMD", "curl", "-sf", "http://localhost:8083/healthz"]
+      interval: 5s
+      timeout: 5s
+      retries: 12

hydopt_client-0.0.2/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "hydopt-client"
+dynamic = ["version"]
+description = "Python client for the HydOpt hydropower optimization API"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "google-auth>=2.56.3",
+    "httpx>=0.28.1",
+    "pydantic>=2.13.4",
+    "requests>=2.34.2",
+]
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/hydopt_client"]
+
+[tool.uv]
+dev-dependencies = [
+    "pytest>=8.3",
+    "ruff>=0.11",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"

hydopt_client-0.0.2/src/hydopt_client/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("hydopt-client")

hydopt_client-0.0.2/src/hydopt_client/auth.py

@@ -0,0 +1,17 @@
+from google.auth.transport import requests as google_requests
+from google.oauth2 import id_token
+
+SERVER_URL = "https://hydopt-api-131385138719.us-central1.run.app"
+AUDIENCE = "131385138719-463u6bbculfbqd491e2falsocsdr0rca.apps.googleusercontent.com"
+
+
+class TokenProvider:
+    def __init__(
+        self,
+        audience: str | None = None,
+    ) -> None:
+        self.audience = audience or AUDIENCE
+
+    def get_token(self) -> str:
+        request = google_requests.Request()
+        return id_token.fetch_id_token(request, self.audience)