canopy-ag-sdk 0.1.0__tar.gz

canopy_ag_sdk-0.1.0/.gitignore

@@ -0,0 +1,283 @@
+# See https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files for more about ignoring files.
+
+# compiled output
+dist
+tmp
+out-tsc
+
+# Playwright
+test-results/
+playwright-report/
+playwright-smoke-report/
+blob-report/
+playwright/.cache/
+
+# dependencies
+node_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
+
+# Flutter/Dart specific
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+**/build/
+# Style Dictionary generated tokens are committed for diff review + so the
+# tools/check-design-tokens.mjs check has a ground-truth snapshot to compare
+# against. Un-ignore the SD output dir specifically.
+!react/ui/src/tokens/build/
+ios/Pods/
+ios/.symlinks/
+ios/Flutter/Flutter.framework
+ios/Flutter/Flutter.podspec
+ios/Runner/GeneratedPluginRegistrant.*
+android/.gradle/
+android/captures/
+android/gradlew
+android/gradlew.bat
+android/local.properties
+android/**/GeneratedPluginRegistrant.java
+android/key.properties
+*.jks
+macos/Pods/
+macos/.symlinks/
+windows/flutter/
+.fvm/
+
+.nx/cache
+.nx/workspace-data
+.cursor/rules/nx-rules.mdc
+.github/instructions/nx.instructions.md
+
+
+# NestJs build output
+**/dist
+
+# Node modules
+**/node_modules
+
+# compiled output# Tests
+/coverage
+/.nyc_output
+
+# Jest cache
+/.jest
+.jest/
+/.jest-cache
+.jest-cache//node_modules
+/build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# dotenv environment variable files
+**/.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+.env*
+!**/.env.example
+!**/.env.*.example
+!.env.example
+!**/.env.e2e
+# canopy-mobile dev-profile runtime config: PUBLIC by design (Firebase web
+# apiKey + dev API hosts, same values as the k8s webConfig ConfigMap) and
+# committed so `expo start` gets the dev EXPO_PUBLIC_* vars (mobile auth E3-s3).
+!apps/canopy-mobile/.env.development
+
+# temp directory
+.temp
+.tmp
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# helm/kube secrets
+**/*.secret.yaml
+**/*.secret.*
+
+# migration-tool local k8s run manifests (operational scratch, not deployed via GitOps)
+tools/canopy-migration-tool/k8s/
+
+# database files
+*.sqlite
+*.sqlite3
+
+# Data directories
+**/data/
+
+# backups
+*.bak
+*.backup
+backups/
+
+# release manifests (generated artifacts)
+release-manifests/
+
+# secrets folder
+**/secrets*
+vite.config.*.timestamp*
+
+# Next.js
+.next
+out
+
+vitest.config.*.timestamp*
+
+# Python
+*.py[cod]
+__pycache__/
+*.so
+*.egg
+*.egg-info/
+dist-python/
+build-python/
+.eggs/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+*.cover
+.hypothesis/
+*.log
+.uv/
+.venv/
+venv/
+ENV/
+env/
+pip-log.txt
+pip-delete-this-directory.txt
+.Python
+# Ralph orchestration files
+.ralph/
+.ralph-task-*.md
+.spec-task.md
+
+# Canopy agent worktrees (created by /canopy-handoff via `git worktree add`)
+# Registered worktrees are already excluded from `git status` by git itself; this
+# entry is defensive against orphan state from failed `git worktree remove` runs
+# or manual `mkdir .worktrees/...` outside the canopy-* skill flow.
+.worktrees/
+
+# tools/<name>/output/ — per-run artifacts from operator CLIs
+# (e.g. tools/tenant-inventory/output/<timestamp>.{json,md}).
+# Per-run manifests should never land in PRs.
+tools/*/output/
+
+.nx/polygraph
+.claude/worktrees
+.claude/settings.local.json
+
+# Storybook static build outputs
+react/ui/storybook-static/
+
+# eflow story plan dirs — local scratch, exchanged via Notion Tech Notes, never committed
+.plan/
+
+# eflow session-hook runtime state — per-session bookkeeping, never committed
+.eflow/
+
+# Playwright MCP debug output (console logs, page snapshots) — local scratch
+.playwright-mcp/
+
+# Expo
+node_modules/
+.expo/
+.yarn/
+dist/
+npm-debug.*
+*.jks
+*.p8
+*.p12
+*.key
+*.mobileprovision
+*.orig.*
+web-build/
+cache/
+
+
+# entitlement-backfill runbook bundle artifact (docs/auth/entitlement-backfill-runbook.md)
+.backfill-cli.cjs
+
+# TypeScript incremental-build cache — machine-specific, never committed
+*.tsbuildinfo
+
+.nx/self-healing
+.nx/migrate-runs
+
+# canopy-mobile Android toolchain env (generated by apps/canopy-mobile/tools/android-setup.sh)
+apps/canopy-mobile/.android-env.sh
+
+# Warm npm cache baked into the ARC runner image at build time (see
+# .github/workflows/build-runner-image.yml) — contents are generated, never committed.
+.github/runner-image/npm-cache/*
+!.github/runner-image/npm-cache/.gitkeep

canopy_ag_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.5
+Name: canopy-ag-sdk
+Version: 0.1.0
+Summary: Official Python SDK for the Canopy Customer API (api-stg.canopy.ag/v1): openapi-python-client generated transport + a thin wrapper with env contract and API-key redaction.
+License: MIT
+Keywords: canopy,iot,irrigation,openapi,sdk
+Requires-Python: >=3.11
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29,>=0.23.1
+Requires-Dist: python-dateutil>=2.8.0
+Description-Content-Type: text/markdown
+
+# canopy-ag-sdk
+
+Official Python SDK for the [Canopy Customer API](https://api-stg.canopy.ag/v1) —
+transport generated from the committed public spec (`spec/public/openapi.json`)
+by [openapi-python-client](https://github.com/openapi-generators/openapi-python-client),
+wrapped by a thin hand-written layer that owns the env contract and API-key
+redaction.
+
+## Install
+
+```sh
+pip install canopy-ag-sdk
+```
+
+> **Package-name note:** the distribution is `canopy-ag-sdk` but the import
+> names are `canopy_sdk` (wrapper) and `canopy_sdk_client` (generated
+> transport) — a Python distribution name and its import name need not match.
+> The distribution is **not** `canopy-sdk`: that name was already taken on PyPI
+> by an unrelated project (Pinecone's RAG framework / context engine) before
+> Canopy's first publish, so `canopy-ag-sdk` was chosen to mirror the
+> `@canopy-ag/` npm scope used by the TypeScript SDK. That squatted
+> distribution installs top-level `canopy` / `canopy_cli` / `canopy_server`, so
+> it does not collide with our import names even if both are installed. See
+> [`docs/ci/public-sdk-publishing.md`](../../../docs/ci/public-sdk-publishing.md)
+> (`.github/workflows/publish-public-sdk.yml`) for how publishing (PyPI OIDC
+> trusted publishing — no token) and versioning (the version tracks
+> `spec/public/openapi.json` `info.version`) work.
+
+Requires Python >= 3.11 (the generated client pins `httpx >= 0.23.1, < 0.29`).
+
+## Quickstart — list irrigation zones
+
+Only `CANOPY_API_KEY` needs to be set (7 lines of code):
+
+```python
+from canopy_sdk import CanopyClient
+from canopy_sdk_client.api.irrigation_zones import irrigation_zones_controller_find_all
+
+client = CanopyClient()  # reads CANOPY_API_KEY
+zones = irrigation_zones_controller_find_all.sync(
+    client=client.raw, x_tenant_id="<your-tenant-uuid>"
+)
+print(zones)
+```
+
+Every operation in the public spec has a module under `canopy_sdk_client.api.*`
+with `sync` / `sync_detailed` / `asyncio` / `asyncio_detailed` variants; pass
+`client=client.raw` to any of them.
+
+## Environment contract
+
+| Variable              | Required | Behavior                                                                                |
+| --------------------- | -------- | --------------------------------------------------------------------------------------- |
+| `CANOPY_API_KEY`      | yes      | `CanopyClient()` **fails fast** with `MissingApiKeyError` naming this variable if unset. |
+| `CANOPY_API_BASE_URL` | no       | Overrides the default base URL `https://api-stg.canopy.ag/v1` (`DEFAULT_BASE_URL`).      |
+
+Both can also be passed programmatically — `CanopyClient(api_key=..., base_url=...)`
+(arguments win over the environment).
+
+## Key redaction guarantee
+
+The API key never appears in:
+
+- `repr()` / `str()` of `CanopyClient` (rendered as `[REDACTED]`),
+- exceptions raised through the request path (scrubbed by a wrapping transport),
+- httpx logs at default (INFO) level.
+
+Pinned by the leak tests in `tests/test_redaction.py` (written first, per the
+story brief). **Do not `repr()` the raw generated client** (`client.raw`) —
+its attrs-generated repr is not redacted; treat it as a transport handle only.
+
+## Regenerating the transport
+
+`src/canopy_sdk_client/` is generated code — committed, drift-gated in CI
+(`sdk-python-drift` in `.github/workflows/pr-checks.yml`), and never hand-edited.
+After any change to `spec/public/openapi.json`:
+
+```sh
+npx nx run sdk-python:generate   # or: bash libs/sdk/python/tools/generate.sh
+```
+
+Generator + ruff post-hook versions are pinned inside `tools/generate.sh` so
+regeneration is byte-identical everywhere.
+
+## Development
+
+```sh
+npx nx run sdk-python:install    # uv sync
+npx nx run sdk-python:test       # uv run pytest tests/ -v
+npx nx run sdk-python:lint       # ruff check on the hand-written surface
+npx nx run sdk-python:build      # uv build (wheel + sdist)
+```

canopy_ag_sdk-0.1.0/README.md

@@ -0,0 +1,92 @@
+# canopy-ag-sdk
+
+Official Python SDK for the [Canopy Customer API](https://api-stg.canopy.ag/v1) —
+transport generated from the committed public spec (`spec/public/openapi.json`)
+by [openapi-python-client](https://github.com/openapi-generators/openapi-python-client),
+wrapped by a thin hand-written layer that owns the env contract and API-key
+redaction.
+
+## Install
+
+```sh
+pip install canopy-ag-sdk
+```
+
+> **Package-name note:** the distribution is `canopy-ag-sdk` but the import
+> names are `canopy_sdk` (wrapper) and `canopy_sdk_client` (generated
+> transport) — a Python distribution name and its import name need not match.
+> The distribution is **not** `canopy-sdk`: that name was already taken on PyPI
+> by an unrelated project (Pinecone's RAG framework / context engine) before
+> Canopy's first publish, so `canopy-ag-sdk` was chosen to mirror the
+> `@canopy-ag/` npm scope used by the TypeScript SDK. That squatted
+> distribution installs top-level `canopy` / `canopy_cli` / `canopy_server`, so
+> it does not collide with our import names even if both are installed. See
+> [`docs/ci/public-sdk-publishing.md`](../../../docs/ci/public-sdk-publishing.md)
+> (`.github/workflows/publish-public-sdk.yml`) for how publishing (PyPI OIDC
+> trusted publishing — no token) and versioning (the version tracks
+> `spec/public/openapi.json` `info.version`) work.
+
+Requires Python >= 3.11 (the generated client pins `httpx >= 0.23.1, < 0.29`).
+
+## Quickstart — list irrigation zones
+
+Only `CANOPY_API_KEY` needs to be set (7 lines of code):
+
+```python
+from canopy_sdk import CanopyClient
+from canopy_sdk_client.api.irrigation_zones import irrigation_zones_controller_find_all
+
+client = CanopyClient()  # reads CANOPY_API_KEY
+zones = irrigation_zones_controller_find_all.sync(
+    client=client.raw, x_tenant_id="<your-tenant-uuid>"
+)
+print(zones)
+```
+
+Every operation in the public spec has a module under `canopy_sdk_client.api.*`
+with `sync` / `sync_detailed` / `asyncio` / `asyncio_detailed` variants; pass
+`client=client.raw` to any of them.
+
+## Environment contract
+
+| Variable              | Required | Behavior                                                                                |
+| --------------------- | -------- | --------------------------------------------------------------------------------------- |
+| `CANOPY_API_KEY`      | yes      | `CanopyClient()` **fails fast** with `MissingApiKeyError` naming this variable if unset. |
+| `CANOPY_API_BASE_URL` | no       | Overrides the default base URL `https://api-stg.canopy.ag/v1` (`DEFAULT_BASE_URL`).      |
+
+Both can also be passed programmatically — `CanopyClient(api_key=..., base_url=...)`
+(arguments win over the environment).
+
+## Key redaction guarantee
+
+The API key never appears in:
+
+- `repr()` / `str()` of `CanopyClient` (rendered as `[REDACTED]`),
+- exceptions raised through the request path (scrubbed by a wrapping transport),
+- httpx logs at default (INFO) level.
+
+Pinned by the leak tests in `tests/test_redaction.py` (written first, per the
+story brief). **Do not `repr()` the raw generated client** (`client.raw`) —
+its attrs-generated repr is not redacted; treat it as a transport handle only.
+
+## Regenerating the transport
+
+`src/canopy_sdk_client/` is generated code — committed, drift-gated in CI
+(`sdk-python-drift` in `.github/workflows/pr-checks.yml`), and never hand-edited.
+After any change to `spec/public/openapi.json`:
+
+```sh
+npx nx run sdk-python:generate   # or: bash libs/sdk/python/tools/generate.sh
+```
+
+Generator + ruff post-hook versions are pinned inside `tools/generate.sh` so
+regeneration is byte-identical everywhere.
+
+## Development
+
+```sh
+npx nx run sdk-python:install    # uv sync
+npx nx run sdk-python:test       # uv run pytest tests/ -v
+npx nx run sdk-python:lint       # ruff check on the hand-written surface
+npx nx run sdk-python:build      # uv build (wheel + sdist)
+```

canopy_ag_sdk-0.1.0/config.yml

@@ -0,0 +1,11 @@
+# openapi-python-client config for the Canopy Python SDK.
+# Consumed by tools/generate.sh (which pins the generator + ruff versions).
+# package_name_override controls the generated top-level package directory
+# (committed at src/canopy_sdk_client, imported by the canopy_sdk wrapper);
+# project_name_override is the PyPI distribution name the wrapper ships under.
+# Keep project_name_override in sync with [project] name in pyproject.toml —
+# "canopy-sdk" is squatted on PyPI, so the distribution is "canopy-ag-sdk".
+# (generate.sh passes --meta none, so this value emits no files; it is kept
+# accurate so the generated config never contradicts the shipped manifest.)
+project_name_override: canopy-ag-sdk
+package_name_override: canopy_sdk_client

canopy_ag_sdk-0.1.0/project.json

@@ -0,0 +1,45 @@
+{
+  "name": "sdk-python",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/sdk/python/src",
+  "projectType": "library",
+  "tags": ["type:util", "scope:shared", "platform:python"],
+  "targets": {
+    "install": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cd libs/sdk/python && uv sync",
+        "cwd": "."
+      }
+    },
+    "generate": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "bash libs/sdk/python/tools/generate.sh",
+        "cwd": "{workspaceRoot}"
+      }
+    },
+    "test": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cd libs/sdk/python && uv run pytest tests/ -v",
+        "cwd": "."
+      }
+    },
+    "lint": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cd libs/sdk/python && uv run ruff check src/canopy_sdk tests/",
+        "cwd": "."
+      }
+    },
+    "build": {
+      "executor": "nx:run-commands",
+      "outputs": ["{workspaceRoot}/libs/sdk/python/dist"],
+      "options": {
+        "command": "cd libs/sdk/python && uv build --out-dir dist",
+        "cwd": "."
+      }
+    }
+  }
+}

canopy_ag_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+# Distribution name. NOT "canopy-sdk": that name is already taken on PyPI by an
+# unrelated project (Pinecone's RAG framework / context engine, 0.9.0), so it is
+# unobtainable. "canopy-ag-sdk" mirrors the @canopy-ag/ npm scope used by the
+# TypeScript SDK. The IMPORT names stay canopy_sdk / canopy_sdk_client (see
+# [tool.hatch.build.targets.wheel] below) — a distribution name and an import
+# name need not match, and the squatted distribution installs top-level
+# `canopy` / `canopy_cli` / `canopy_server`, so there is no import collision
+# even for a consumer who installs both.
+name = "canopy-ag-sdk"
+version = "0.1.0"
+description = "Official Python SDK for the Canopy Customer API (api-stg.canopy.ag/v1): openapi-python-client generated transport + a thin wrapper with env contract and API-key redaction."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.11"
+keywords = ["canopy", "sdk", "openapi", "irrigation", "iot"]
+dependencies = [
+    # Inherited from the openapi-python-client (0.29.x) generated client.
+    "httpx>=0.23.1,<0.29",
+    "attrs>=22.2.0",
+    "python-dateutil>=2.8.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=7.4.0",
+    "ruff>=0.6.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+# Two top-level packages in one distribution: the hand-written wrapper
+# (canopy_sdk) and the committed generated transport (canopy_sdk_client —
+# regenerated only via tools/generate.sh, never hand-edited).
+packages = ["src/canopy_sdk", "src/canopy_sdk_client"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+# JUnit XML lands in the workspace-shared test-results/ tree consumed by
+# scripts/summarize-test-results.ts. Path is relative to this file's directory
+# (libs/sdk/python/), so ../../../ resolves to the repo root.
+addopts = "--junitxml=../../../test-results/sdk-python-pytest.xml"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+# Generated code is ruff-formatted by the generator's own pinned post-hooks;
+# lint only the hand-written surface.
+extend-exclude = ["src/canopy_sdk_client"]

canopy_ag_sdk-0.1.0/src/canopy_sdk/__init__.py

@@ -0,0 +1,32 @@
+"""canopy-ag-sdk — official Python SDK for the Canopy Customer API.
+
+Installed as ``pip install canopy-ag-sdk``; imported as ``canopy_sdk``.
+
+Quickstart (only ``CANOPY_API_KEY`` needs to be set)::
+
+    from canopy_sdk import CanopyClient
+    from canopy_sdk_client.api.irrigation_zones import irrigation_zones_controller_find_all
+
+    client = CanopyClient()  # reads CANOPY_API_KEY
+    zones = irrigation_zones_controller_find_all.sync(
+        client=client.raw, x_tenant_id="<your-tenant-uuid>"
+    )
+    print(zones)
+"""
+
+from .client import (
+    DEFAULT_BASE_URL,
+    CanopyClient,
+    CanopyError,
+    MissingApiKeyError,
+)
+from .redaction import REDACTED, redact_secret
+
+__all__ = [
+    "DEFAULT_BASE_URL",
+    "REDACTED",
+    "CanopyClient",
+    "CanopyError",
+    "MissingApiKeyError",
+    "redact_secret",
+]