nimble_python 0.2.0__tar.gz → 0.4.0__tar.gz

nimble_python-0.4.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.4.0"
+}

{nimble_python-0.2.0 → nimble_python-0.4.0}/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## 0.4.0 (2026-02-09)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/Nimbleway/nimble-python/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** Add agents and rename agent ([a72d77b](https://github.com/Nimbleway/nimble-python/commit/a72d77b446b25b5f685066254ff0bdfb05918bad))
+* **api:** api update ([6f67725](https://github.com/Nimbleway/nimble-python/commit/6f67725ba6f96018e072780ae22d38cfd1ba0ad8))
+* **api:** Move crawl to client ([118165a](https://github.com/Nimbleway/nimble-python/commit/118165ab63206ae7e6435b8486c25f5bf71f55a5))
+* **api:** To sdk.nimbleway.com ([3dc176d](https://github.com/Nimbleway/nimble-python/commit/3dc176de8a29d3df6bfb6385d941a7881a8f56cd))
+
+
+### Chores
+
+* configure new SDK language ([1034102](https://github.com/Nimbleway/nimble-python/commit/103410232991048870d008a98e1a6a8baf8977d6))
+
+## 0.3.0 (2026-02-03)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/Nimbleway/nimble-python/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** Increase default timeout ([bb00c82](https://github.com/Nimbleway/nimble-python/commit/bb00c82062da9d9e812383364adf8c5b31f3c787))
+* **api:** manual updates ([fc70a1c](https://github.com/Nimbleway/nimble-python/commit/fc70a1cbc9dd6651de1ee8a564dfebb34f98af79))
+* trigger new release ([e1af702](https://github.com/Nimbleway/nimble-python/commit/e1af702364372e7140b4ed647bf63181272eb7be))
+
+
+### Chores
+
+* **api:** remove staging environment ([3788e48](https://github.com/Nimbleway/nimble-python/commit/3788e48dce4f59c8ecff201fc69078dc17a8d6e9))
+* **api:** Rename to nimble ([0dcaeda](https://github.com/Nimbleway/nimble-python/commit/0dcaedab384eddc0202a3228f3e013fc97c8a398))
+* remove custom code ([25cdd8b](https://github.com/Nimbleway/nimble-python/commit/25cdd8b57e91a4d1269ffc16de8ffb450560b425))
+* trigger release ([15b0fdb](https://github.com/Nimbleway/nimble-python/commit/15b0fdba8e7cfefa23871a1f65e0e45d8d786cff))
+* update SDK settings ([1eca32d](https://github.com/Nimbleway/nimble-python/commit/1eca32d03bf29acf16cd1c95a3bdf1fc8aa736e6))
+* update SDK settings ([e5719fa](https://github.com/Nimbleway/nimble-python/commit/e5719fa5eb38f4d9559642824225e991fdfe78c4))
+* update SDK settings ([b5717bf](https://github.com/Nimbleway/nimble-python/commit/b5717bf9aa3c3bae35331356817f4fcabc7914da))
+
 ## 0.2.0 (2026-02-03)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/Nimbleway/nimble-python/compare/v0.1.0...v0.2.0)

{nimble_python-0.2.0 → nimble_python-0.4.0}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2026 Nimbleway
+   Copyright 2026 Nimble
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{nimble_python-0.2.0 → nimble_python-0.4.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: nimble_python
-Version: 0.2.0
-Summary: The official Python library for the nimbleway API
+Version: 0.4.0
+Summary: The official Python library for the nimble API
 Project-URL: Homepage, https://github.com/Nimbleway/nimble-python
 Project-URL: Repository, https://github.com/Nimbleway/nimble-python
-Author-email: Nimbleway <support@nimbleway.com>
+Author-email: Nimble <support@nimbleway.com>
 License: Apache-2.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -33,12 +33,12 @@ Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
-# Nimbleway Python API library
+# Nimble Python API library
 
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/nimble_python.svg?label=pypi%20(stable))](https://pypi.org/project/nimble_python/)
 
-The Nimbleway Python library provides convenient access to the Nimbleway REST API from any Python 3.9+
+The Nimble Python library provides convenient access to the Nimble REST API from any Python 3.9+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -46,10 +46,10 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## MCP Server
 
-Use the Nimbleway MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+Use the Nimble MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
 
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=nimble-mcp&config=eyJuYW1lIjoibmltYmxlLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL25pbWJsZXdheS5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LW5pbWJsZS1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22nimble-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fnimbleway.stlmcp.com%22%2C%22headers%22%3A%7B%22x-nimble-api-key%22%3A%22My%20API%20Key%22%7D%7D)
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=nimble-js-mcp&config=eyJuYW1lIjoibmltYmxlLWpzLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL25pbWJsZXdheS5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LW5pbWJsZS1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22nimble-js-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fnimbleway.stlmcp.com%22%2C%22headers%22%3A%7B%22x-nimble-api-key%22%3A%22My%20API%20Key%22%7D%7D)
 
 > Note: You may need to set environment variables in your MCP client.
 
@@ -60,32 +60,26 @@ The full API of this library can be found in [api.md](https://github.com/Nimblew
 ## Installation
 
 ```sh
-# install from the production repo
-pip install git+ssh://git@github.com/Nimbleway/nimble-python.git
+# install from PyPI
+pip install nimble_python
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install nimble_python`
-
 ## Usage
 
 The full API of this library can be found in [api.md](https://github.com/Nimbleway/nimble-python/tree/main/api.md).
 
 ```python
 import os
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway(
+client = Nimble(
     api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
-    # defaults to "staging".
-    environment="production",
 )
 
 response = client.extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
-print(response.id)
+print(response.task_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -95,26 +89,23 @@ so that your API Key is not stored in source control.
 
 ## Async usage
 
-Simply import `AsyncNimbleway` instead of `Nimbleway` and use `await` with each API call:
+Simply import `AsyncNimble` instead of `Nimble` and use `await` with each API call:
 
 ```python
 import os
 import asyncio
-from nimble_python import AsyncNimbleway
+from nimble_python import AsyncNimble
 
-client = AsyncNimbleway(
+client = AsyncNimble(
     api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
-    # defaults to "staging".
-    environment="production",
 )
 
 
 async def main() -> None:
     response = await client.extract(
-        debug_options={},
-        url="https://example.com",
+        url="https://example.com/page",
     )
-    print(response.id)
+    print(response.task_id)
 
 
 asyncio.run(main())
@@ -129,8 +120,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from the production repo
-pip install 'nimble_python[aiohttp] @ git+ssh://git@github.com/Nimbleway/nimble-python.git'
+# install from PyPI
+pip install nimble_python[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -139,19 +130,18 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
 import os
 import asyncio
 from nimble_python import DefaultAioHttpClient
-from nimble_python import AsyncNimbleway
+from nimble_python import AsyncNimble
 
 
 async def main() -> None:
-    async with AsyncNimbleway(
+    async with AsyncNimble(
         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(
-            debug_options={},
-            url="https://example.com",
+            url="https://example.com/page",
         )
-        print(response.id)
+        print(response.task_id)
 
 
 asyncio.run(main())
@@ -171,15 +161,15 @@ Typed requests and responses provide autocomplete and documentation within your
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
 ```python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway()
+client = Nimble()
 
 response = client.extract(
-    debug_options={},
     url="https://example.com/page",
+    metadata={},
 )
-print(response.debug_options)
+print(response.metadata)
 ```
 
 ## Handling errors
@@ -193,14 +183,13 @@ All errors inherit from `nimble_python.APIError`.
 
 ```python
 import nimble_python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway()
+client = Nimble()
 
 try:
     client.extract(
-        debug_options={},
-        url="https://example.com",
+        url="https://example.com/page",
     )
 except nimble_python.APIConnectionError as e:
     print("The server could not be reached")
@@ -235,44 +224,42 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
 # Configure the default for all requests:
-client = Nimbleway(
+client = Nimble(
     # default is 2
     max_retries=0,
 )
 
 # Or, configure per-request:
 client.with_options(max_retries=5).extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
 ```
 
 ### Timeouts
 
-By default requests time out after 1 minute. You can configure this with a `timeout` option,
+By default requests time out after 3 minutes. You can configure this with a `timeout` option,
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
 # Configure the default for all requests:
-client = Nimbleway(
-    # 20 seconds (default is 1 minute)
+client = Nimble(
+    # 20 seconds (default is 3 minutes)
     timeout=20.0,
 )
 
 # More granular control:
-client = Nimbleway(
+client = Nimble(
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
 # Override per-request:
 client.with_options(timeout=5.0).extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
 ```
 
@@ -286,10 +273,10 @@ Note that requests that time out are [retried twice by default](https://github.c
 
 We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
 
-You can enable logging by setting the environment variable `NIMBLEWAY_LOG` to `info`.
+You can enable logging by setting the environment variable `NIMBLE_LOG` to `info`.
 
 ```shell
-$ export NIMBLEWAY_LOG=info
+$ export NIMBLE_LOG=info
 ```
 
 Or to `debug` for more verbose logging.
@@ -311,17 +298,16 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway()
+client = Nimble()
 response = client.with_raw_response.extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
 print(response.headers.get('X-My-Header'))
 
 client = response.parse()  # get the object that `extract()` would have returned
-print(client.id)
+print(client.task_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Nimbleway/nimble-python/tree/main/src/nimble_python/_response.py) object.
@@ -336,8 +322,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.with_streaming_response.extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -391,10 +376,10 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 
 ```python
 import httpx
-from nimble_python import Nimbleway, DefaultHttpxClient
+from nimble_python import Nimble, DefaultHttpxClient
 
-client = Nimbleway(
-    # Or use the `NIMBLEWAY_BASE_URL` env var
+client = Nimble(
+    # Or use the `NIMBLE_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
         proxy="http://my.test.proxy.example.com",
@@ -414,9 +399,9 @@ client.with_options(http_client=DefaultHttpxClient(...))
 By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
 
 ```py
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-with Nimbleway() as client:
+with Nimble() as client:
   # make requests here
   ...
 

{nimble_python-0.2.0 → nimble_python-0.4.0}/README.md

@@ -1,9 +1,9 @@
-# Nimbleway Python API library
+# Nimble Python API library
 
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/nimble_python.svg?label=pypi%20(stable))](https://pypi.org/project/nimble_python/)
 
-The Nimbleway Python library provides convenient access to the Nimbleway REST API from any Python 3.9+
+The Nimble Python library provides convenient access to the Nimble REST API from any Python 3.9+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -11,10 +11,10 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## MCP Server
 
-Use the Nimbleway MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+Use the Nimble MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
 
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=nimble-mcp&config=eyJuYW1lIjoibmltYmxlLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL25pbWJsZXdheS5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LW5pbWJsZS1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22nimble-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fnimbleway.stlmcp.com%22%2C%22headers%22%3A%7B%22x-nimble-api-key%22%3A%22My%20API%20Key%22%7D%7D)
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=nimble-js-mcp&config=eyJuYW1lIjoibmltYmxlLWpzLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL25pbWJsZXdheS5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LW5pbWJsZS1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22nimble-js-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fnimbleway.stlmcp.com%22%2C%22headers%22%3A%7B%22x-nimble-api-key%22%3A%22My%20API%20Key%22%7D%7D)
 
 > Note: You may need to set environment variables in your MCP client.
 
@@ -25,32 +25,26 @@ The full API of this library can be found in [api.md](api.md).
 ## Installation
 
 ```sh
-# install from the production repo
-pip install git+ssh://git@github.com/Nimbleway/nimble-python.git
+# install from PyPI
+pip install nimble_python
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install nimble_python`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 ```python
 import os
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway(
+client = Nimble(
     api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
-    # defaults to "staging".
-    environment="production",
 )
 
 response = client.extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
-print(response.id)
+print(response.task_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -60,26 +54,23 @@ so that your API Key is not stored in source control.
 
 ## Async usage
 
-Simply import `AsyncNimbleway` instead of `Nimbleway` and use `await` with each API call:
+Simply import `AsyncNimble` instead of `Nimble` and use `await` with each API call:
 
 ```python
 import os
 import asyncio
-from nimble_python import AsyncNimbleway
+from nimble_python import AsyncNimble
 
-client = AsyncNimbleway(
+client = AsyncNimble(
     api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
-    # defaults to "staging".
-    environment="production",
 )
 
 
 async def main() -> None:
     response = await client.extract(
-        debug_options={},
-        url="https://example.com",
+        url="https://example.com/page",
     )
-    print(response.id)
+    print(response.task_id)
 
 
 asyncio.run(main())
@@ -94,8 +85,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from the production repo
-pip install 'nimble_python[aiohttp] @ git+ssh://git@github.com/Nimbleway/nimble-python.git'
+# install from PyPI
+pip install nimble_python[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -104,19 +95,18 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
 import os
 import asyncio
 from nimble_python import DefaultAioHttpClient
-from nimble_python import AsyncNimbleway
+from nimble_python import AsyncNimble
 
 
 async def main() -> None:
-    async with AsyncNimbleway(
+    async with AsyncNimble(
         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(
-            debug_options={},
-            url="https://example.com",
+            url="https://example.com/page",
         )
-        print(response.id)
+        print(response.task_id)
 
 
 asyncio.run(main())
@@ -136,15 +126,15 @@ Typed requests and responses provide autocomplete and documentation within your
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
 ```python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway()
+client = Nimble()
 
 response = client.extract(
-    debug_options={},
     url="https://example.com/page",
+    metadata={},
 )
-print(response.debug_options)
+print(response.metadata)
 ```
 
 ## Handling errors
@@ -158,14 +148,13 @@ All errors inherit from `nimble_python.APIError`.
 
 ```python
 import nimble_python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway()
+client = Nimble()
 
 try:
     client.extract(
-        debug_options={},
-        url="https://example.com",
+        url="https://example.com/page",
     )
 except nimble_python.APIConnectionError as e:
     print("The server could not be reached")
@@ -200,44 +189,42 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
 # Configure the default for all requests:
-client = Nimbleway(
+client = Nimble(
     # default is 2
     max_retries=0,
 )
 
 # Or, configure per-request:
 client.with_options(max_retries=5).extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
 ```
 
 ### Timeouts
 
-By default requests time out after 1 minute. You can configure this with a `timeout` option,
+By default requests time out after 3 minutes. You can configure this with a `timeout` option,
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
 # Configure the default for all requests:
-client = Nimbleway(
-    # 20 seconds (default is 1 minute)
+client = Nimble(
+    # 20 seconds (default is 3 minutes)
     timeout=20.0,
 )
 
 # More granular control:
-client = Nimbleway(
+client = Nimble(
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
 # Override per-request:
 client.with_options(timeout=5.0).extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
 ```
 
@@ -251,10 +238,10 @@ Note that requests that time out are [retried twice by default](#retries).
 
 We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
 
-You can enable logging by setting the environment variable `NIMBLEWAY_LOG` to `info`.
+You can enable logging by setting the environment variable `NIMBLE_LOG` to `info`.
 
 ```shell
-$ export NIMBLEWAY_LOG=info
+$ export NIMBLE_LOG=info
 ```
 
 Or to `debug` for more verbose logging.
@@ -276,17 +263,16 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-client = Nimbleway()
+client = Nimble()
 response = client.with_raw_response.extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 )
 print(response.headers.get('X-My-Header'))
 
 client = response.parse()  # get the object that `extract()` would have returned
-print(client.id)
+print(client.task_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Nimbleway/nimble-python/tree/main/src/nimble_python/_response.py) object.
@@ -301,8 +287,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.with_streaming_response.extract(
-    debug_options={},
-    url="https://example.com",
+    url="https://example.com/page",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -356,10 +341,10 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 
 ```python
 import httpx
-from nimble_python import Nimbleway, DefaultHttpxClient
+from nimble_python import Nimble, DefaultHttpxClient
 
-client = Nimbleway(
-    # Or use the `NIMBLEWAY_BASE_URL` env var
+client = Nimble(
+    # Or use the `NIMBLE_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
         proxy="http://my.test.proxy.example.com",
@@ -379,9 +364,9 @@ client.with_options(http_client=DefaultHttpxClient(...))
 By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
 
 ```py
-from nimble_python import Nimbleway
+from nimble_python import Nimble
 
-with Nimbleway() as client:
+with Nimble() as client:
   # make requests here
   ...