Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.24.0"
".": "1.0.0"
}
8 changes: 4 additions & 4 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 54
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nimbleway/nimbleway-bf1b1bed98ef9bce4fe48bad669f2548d0c20816d351821365bdb3ca86ccd723.yml
openapi_spec_hash: 30d0670c85632cc2100bc2cafb6aec0e
config_hash: 1f331615274d4cb8fcdb997da6f9d23e
configured_endpoints: 58
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nimbleway/nimbleway-46d484b69bce8b655b4cb2741903af321088ee25d778dd1f9974925b75ae0c76.yml
openapi_spec_hash: e4c1f68f0083d3b13501f3c85d29b4f4
config_hash: 2a7bb5e7a725315963e311126f1f7e4c
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## 1.0.0 (2026-07-20)

Full Changelog: [v0.24.0...v1.0.0](https://github.com/Nimbleway/nimble-python/compare/v0.24.0...v1.0.0)

### Features

* **api:** api update ([1f846bf](https://github.com/Nimbleway/nimble-python/commit/1f846bff007afa2bd17e3dbe720e858dde41a062))
* **api:** Api v2 ([54c125b](https://github.com/Nimbleway/nimble-python/commit/54c125b46e2eaa6e64aa5267f3e3fef7853b3085))

## 0.24.0 (2026-07-19)

Full Changelog: [v0.23.0...v0.24.0](https://github.com/Nimbleway/nimble-python/compare/v0.23.0...v0.24.0)
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ client = Nimble(
api_key=os.environ.get("NIMBLE_API_KEY"), # This is the default and can be omitted
)

response = client.extract(
response = client.extract.run(
url="https://exapmle.com",
)
print(response.task_id)
Expand All @@ -67,7 +67,7 @@ client = AsyncNimble(


async def main() -> None:
response = await client.extract(
response = await client.extract.run(
url="https://exapmle.com",
)
print(response.task_id)
Expand Down Expand Up @@ -103,7 +103,7 @@ async def main() -> None:
api_key=os.environ.get("NIMBLE_API_KEY"), # This is the default and can be omitted
http_client=DefaultAioHttpClient(),
) as client:
response = await client.extract(
response = await client.extract.run(
url="https://exapmle.com",
)
print(response.task_id)
Expand All @@ -130,7 +130,7 @@ from nimble_python import Nimble

client = Nimble()

response = client.extract(
response = client.extract.run(
url="url",
session={},
)
Expand All @@ -153,7 +153,7 @@ from nimble_python import Nimble
client = Nimble()

try:
client.extract(
client.extract.run(
url="https://exapmle.com",
)
except nimble_python.APIConnectionError as e:
Expand Down Expand Up @@ -198,7 +198,7 @@ client = Nimble(
)

# Or, configure per-request:
client.with_options(max_retries=5).extract(
client.with_options(max_retries=5).extract.run(
url="https://exapmle.com",
)
```
Expand All @@ -223,7 +223,7 @@ client = Nimble(
)

# Override per-request:
client.with_options(timeout=5.0).extract(
client.with_options(timeout=5.0).extract.run(
url="https://exapmle.com",
)
```
Expand Down Expand Up @@ -266,13 +266,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
from nimble_python import Nimble

client = Nimble()
response = client.with_raw_response.extract(
response = client.extract.with_raw_response.run(
url="https://exapmle.com",
)
print(response.headers.get('X-My-Header'))

client = response.parse() # get the object that `extract()` would have returned
print(client.task_id)
extract = response.parse() # get the object that `extract.run()` would have returned
print(extract.task_id)
```

These methods return an [`APIResponse`](https://github.com/Nimbleway/nimble-python/tree/main/src/nimble_python/_response.py) object.
Expand All @@ -286,7 +286,7 @@ The above interface eagerly reads the full response body when you make the reque
To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.

```python
with client.with_streaming_response.extract(
with client.extract.with_streaming_response.run(
url="https://exapmle.com",
) as response:
print(response.headers.get("X-My-Header"))
Expand Down
240 changes: 139 additions & 101 deletions api.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "nimble_python"
version = "0.24.0"
version = "1.0.0"
description = "The official Python library for the nimble API"
dynamic = ["readme"]
license = "Apache-2.0"
Expand Down
Loading
Loading