diff --git a/docs/batch-client-reference.md b/docs/batch-client-reference.md index a988a37..6a9b79e 100644 --- a/docs/batch-client-reference.md +++ b/docs/batch-client-reference.md @@ -1,4 +1,4 @@ -# ZenRows Batch — Python SDK Reference +# Zenrows Batch — Python SDK Reference _Auto-generated from the SDK docstrings via `make docs`. Do not edit by hand. Everything below is imported from the top-level `zenrows.batch` package (`from zenrows.batch import ...`)._ @@ -39,7 +39,7 @@ don't have further-actions to chain). class ZenRowsBatchClient() ``` -Synchronous, typed client for the ZenRows Batch API. +Synchronous, typed client for the Zenrows Batch API. `api_key` is required. Most users read it from a secrets store or environment variable at the call site: @@ -2156,7 +2156,7 @@ Vocabulary (the only keys that appear): - `bad_target` — target URL is the problem (bad host, 404, 410, too large) - `rate_limited` — target throttled the request - `timeout` — the scrape didn't complete in time -- `gateway_error` — ZenRows-side transport / 5xx +- `gateway_error` — Zenrows-side transport / 5xx - `other` — anything else diff --git a/docs/openapi.yaml b/docs/openapi.yaml index c820a41..a494ae6 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -1522,7 +1522,7 @@ components: - `bad_target` — target URL is the problem (bad host, 404, 410, too large) - `rate_limited` — target throttled the request - `timeout` — the scrape didn't complete in time - - `gateway_error` — ZenRows-side transport / 5xx + - `gateway_error` — Zenrows-side transport / 5xx - `other` — anything else additionalProperties: type: integer diff --git a/scripts/build_reference.py b/scripts/build_reference.py index 3e1d5ec..6a2d38b 100644 --- a/scripts/build_reference.py +++ b/scripts/build_reference.py @@ -33,7 +33,7 @@ ] HEADER = ( - "# ZenRows Batch — Python SDK Reference\n\n" + "# Zenrows Batch — Python SDK Reference\n\n" "_Auto-generated from the SDK docstrings via `make docs`. Do not edit by " "hand. Everything below is imported from the top-level `zenrows.batch` " "package (`from zenrows.batch import ...`)._\n" diff --git a/src/zenrows/__init__.py b/src/zenrows/__init__.py index 312ed5e..9bbf8c1 100644 --- a/src/zenrows/__init__.py +++ b/src/zenrows/__init__.py @@ -1,4 +1,4 @@ -"""ZenRows Python SDK. +"""Zenrows Python SDK. Two clients live here: diff --git a/src/zenrows/batch/__init__.py b/src/zenrows/batch/__init__.py index 1a0ebe7..4eccfb7 100644 --- a/src/zenrows/batch/__init__.py +++ b/src/zenrows/batch/__init__.py @@ -1,4 +1,4 @@ -"""Public surface for the ZenRows Batch (async-job) API. +"""Public surface for the Zenrows Batch (async-job) API. What's where: - `client.ZenRowsBatchClient` — the friendly typed facade. One diff --git a/src/zenrows/batch/client.py b/src/zenrows/batch/client.py index dc5ea3a..174525c 100644 --- a/src/zenrows/batch/client.py +++ b/src/zenrows/batch/client.py @@ -127,7 +127,7 @@ class ZenRowsBatchClient: - """Synchronous, typed client for the ZenRows Batch API. + """Synchronous, typed client for the Zenrows Batch API. `api_key` is required. Most users read it from a secrets store or environment variable at the call site: diff --git a/src/zenrows/batch/models.py b/src/zenrows/batch/models.py index 185e42a..3ae21ea 100644 --- a/src/zenrows/batch/models.py +++ b/src/zenrows/batch/models.py @@ -1,6 +1,6 @@ # generated by datamodel-codegen: # filename: openapi.yaml -# timestamp: 2026-07-27T07:37:28+00:00 +# timestamp: 2026-08-21T10:17:51+00:00 from __future__ import annotations @@ -290,7 +290,7 @@ class RunStats(BaseModel): - `bad_target` — target URL is the problem (bad host, 404, 410, too large) - `rate_limited` — target throttled the request - `timeout` — the scrape didn't complete in time - - `gateway_error` — ZenRows-side transport / 5xx + - `gateway_error` — Zenrows-side transport / 5xx - `other` — anything else """