nimble_python 0.12.0__tar.gz → 0.14.0__tar.gz

{nimble_python-0.12.0 → nimble_python-0.14.0}/.gitignore

@@ -1,4 +1,5 @@
 .prism.log
+.stdy.log
 _dev
 
 __pycache__

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

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

{nimble_python-0.12.0 → nimble_python-0.14.0}/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.14.0 (2026-03-25)
+
+Full Changelog: [v0.13.0...v0.14.0](https://github.com/Nimbleway/nimble-python/compare/v0.13.0...v0.14.0)
+
+### Features
+
+* **api:** api update ([821cfa1](https://github.com/Nimbleway/nimble-python/commit/821cfa15a5328f20cda1f76b1d7a284d3d53b23f))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([3e1d8f5](https://github.com/Nimbleway/nimble-python/commit/3e1d8f5838127cb3145a69876d993bca07bc4b8e))
+
+## 0.13.0 (2026-03-24)
+
+Full Changelog: [v0.12.0...v0.13.0](https://github.com/Nimbleway/nimble-python/compare/v0.12.0...v0.13.0)
+
+### Features
+
+* **api:** manual updates ([17e730d](https://github.com/Nimbleway/nimble-python/commit/17e730d1f09b8cead6fa11cb68af9d8105dc57df))
+
+
+### Bug Fixes
+
+* sanitize endpoint path params ([0c14c30](https://github.com/Nimbleway/nimble-python/commit/0c14c308e068da0c00affd197abb5ddd3b7f8ca2))
+
+
+### Chores
+
+* **internal:** update gitignore ([f19a4e6](https://github.com/Nimbleway/nimble-python/commit/f19a4e6cea6039638d95e8b5f8d136a34149c63d))
+
 ## 0.12.0 (2026-03-18)
 
 Full Changelog: [v0.11.0...v0.12.0](https://github.com/Nimbleway/nimble-python/compare/v0.11.0...v0.12.0)

{nimble_python-0.12.0 → nimble_python-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nimble_python
-Version: 0.12.0
+Version: 0.14.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

{nimble_python-0.12.0 → nimble_python-0.14.0}/api.md

@@ -93,3 +93,17 @@ Methods:
 - <code title="get /v1/tasks">client.tasks.<a href="./src/nimble_python/resources/tasks.py">list</a>(\*\*<a href="src/nimble_python/types/task_list_params.py">params</a>) -> <a href="./src/nimble_python/types/task_list_response.py">TaskListResponse</a></code>
 - <code title="get /v1/tasks/{task_id}">client.tasks.<a href="./src/nimble_python/resources/tasks.py">get</a>(task_id) -> <a href="./src/nimble_python/types/task_get_response.py">TaskGetResponse</a></code>
 - <code title="get /v1/tasks/{task_id}/results">client.tasks.<a href="./src/nimble_python/resources/tasks.py">results</a>(task_id) -> <a href="./src/nimble_python/types/task_results_response.py">TaskResultsResponse</a></code>
+
+# Batches
+
+Types:
+
+```python
+from nimble_python.types import BatchGetResponse, BatchProgressResponse
+```
+
+Methods:
+
+- <code title="get /v1/batches">client.batches.<a href="./src/nimble_python/resources/batches.py">list</a>() -> None</code>
+- <code title="get /v1/batches/{batch_id}">client.batches.<a href="./src/nimble_python/resources/batches.py">get</a>(batch_id) -> <a href="./src/nimble_python/types/batch_get_response.py">BatchGetResponse</a></code>
+- <code title="get /v1/batches/{batch_id}/progress">client.batches.<a href="./src/nimble_python/resources/batches.py">progress</a>(batch_id) -> <a href="./src/nimble_python/types/batch_progress_response.py">BatchProgressResponse</a></code>

{nimble_python-0.12.0 → nimble_python-0.14.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nimble_python"
-version = "0.12.0"
+version = "0.14.0"
 description = "The official Python library for the nimble API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{nimble_python-0.12.0 → nimble_python-0.14.0}/src/nimble_python/_client.py

@@ -60,10 +60,11 @@ from .types.extract_async_response import ExtractAsyncResponse
 from .types.extract_batch_response import ExtractBatchResponse
 
 if TYPE_CHECKING:
-    from .resources import agent, crawl, tasks
+    from .resources import agent, crawl, tasks, batches
     from .resources.agent import AgentResource, AsyncAgentResource
     from .resources.crawl import CrawlResource, AsyncCrawlResource
     from .resources.tasks import TasksResource, AsyncTasksResource
+    from .resources.batches import BatchesResource, AsyncBatchesResource
 
 __all__ = ["Timeout", "Transport", "ProxiesTypes", "RequestOptions", "Nimble", "AsyncNimble", "Client", "AsyncClient"]
 
@@ -137,6 +138,12 @@ class Nimble(SyncAPIClient):
 
         return TasksResource(self)
 
+    @cached_property
+    def batches(self) -> BatchesResource:
+        from .resources.batches import BatchesResource
+
+        return BatchesResource(self)
+
     @cached_property
     def with_raw_response(self) -> NimbleWithRawResponse:
         return NimbleWithRawResponse(self)
@@ -493,7 +500,7 @@ class Nimble(SyncAPIClient):
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
         driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -1484,7 +1491,7 @@ class Nimble(SyncAPIClient):
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
         driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -2230,8 +2237,8 @@ class Nimble(SyncAPIClient):
     def extract_batch(
         self,
         *,
-        params: Iterable[client_extract_batch_params.Param],
-        shared_params: client_extract_batch_params.SharedParams | Omit = omit,
+        inputs: Iterable[client_extract_batch_params.Input],
+        shared_inputs: client_extract_batch_params.SharedInputs | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -2242,13 +2249,13 @@ class Nimble(SyncAPIClient):
         """Extract Batch Endpoint
 
         Args:
-          params: Array of extraction requests.
+          inputs: Array of extraction requests.
 
-        Each object represents one extraction with its own
-              parameters.
+        Each object can include extraction parameters and
+              async/storage settings.
 
-          shared_params: Shared parameters applied to the entire batch, such as storage and callback
-              configuration.
+          shared_inputs: Shared parameters applied to the entire batch. Can include extraction parameters
+              and async/storage settings.
 
           extra_headers: Send extra headers
 
@@ -2262,8 +2269,8 @@ class Nimble(SyncAPIClient):
             "/v1/extract/batch",
             body=maybe_transform(
                 {
-                    "params": params,
-                    "shared_params": shared_params,
+                    "inputs": inputs,
+                    "shared_inputs": shared_inputs,
                 },
                 client_extract_batch_params.ClientExtractBatchParams,
             ),
@@ -3331,6 +3338,12 @@ class AsyncNimble(AsyncAPIClient):
 
         return AsyncTasksResource(self)
 
+    @cached_property
+    def batches(self) -> AsyncBatchesResource:
+        from .resources.batches import AsyncBatchesResource
+
+        return AsyncBatchesResource(self)
+
     @cached_property
     def with_raw_response(self) -> AsyncNimbleWithRawResponse:
         return AsyncNimbleWithRawResponse(self)
@@ -3687,7 +3700,7 @@ class AsyncNimble(AsyncAPIClient):
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
         driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -4678,7 +4691,7 @@ class AsyncNimble(AsyncAPIClient):
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
         driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -5424,8 +5437,8 @@ class AsyncNimble(AsyncAPIClient):
     async def extract_batch(
         self,
         *,
-        params: Iterable[client_extract_batch_params.Param],
-        shared_params: client_extract_batch_params.SharedParams | Omit = omit,
+        inputs: Iterable[client_extract_batch_params.Input],
+        shared_inputs: client_extract_batch_params.SharedInputs | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -5436,13 +5449,13 @@ class AsyncNimble(AsyncAPIClient):
         """Extract Batch Endpoint
 
         Args:
-          params: Array of extraction requests.
+          inputs: Array of extraction requests.
 
-        Each object represents one extraction with its own
-              parameters.
+        Each object can include extraction parameters and
+              async/storage settings.
 
-          shared_params: Shared parameters applied to the entire batch, such as storage and callback
-              configuration.
+          shared_inputs: Shared parameters applied to the entire batch. Can include extraction parameters
+              and async/storage settings.
 
           extra_headers: Send extra headers
 
@@ -5456,8 +5469,8 @@ class AsyncNimble(AsyncAPIClient):
             "/v1/extract/batch",
             body=await async_maybe_transform(
                 {
-                    "params": params,
-                    "shared_params": shared_params,
+                    "inputs": inputs,
+                    "shared_inputs": shared_inputs,
                 },
                 client_extract_batch_params.ClientExtractBatchParams,
             ),
@@ -6496,6 +6509,12 @@ class NimbleWithRawResponse:
 
         return TasksResourceWithRawResponse(self._client.tasks)
 
+    @cached_property
+    def batches(self) -> batches.BatchesResourceWithRawResponse:
+        from .resources.batches import BatchesResourceWithRawResponse
+
+        return BatchesResourceWithRawResponse(self._client.batches)
+
 
 class AsyncNimbleWithRawResponse:
     _client: AsyncNimble
@@ -6537,6 +6556,12 @@ class AsyncNimbleWithRawResponse:
 
         return AsyncTasksResourceWithRawResponse(self._client.tasks)
 
+    @cached_property
+    def batches(self) -> batches.AsyncBatchesResourceWithRawResponse:
+        from .resources.batches import AsyncBatchesResourceWithRawResponse
+
+        return AsyncBatchesResourceWithRawResponse(self._client.batches)
+
 
 class NimbleWithStreamedResponse:
     _client: Nimble
@@ -6578,6 +6603,12 @@ class NimbleWithStreamedResponse:
 
         return TasksResourceWithStreamingResponse(self._client.tasks)
 
+    @cached_property
+    def batches(self) -> batches.BatchesResourceWithStreamingResponse:
+        from .resources.batches import BatchesResourceWithStreamingResponse
+
+        return BatchesResourceWithStreamingResponse(self._client.batches)
+
 
 class AsyncNimbleWithStreamedResponse:
     _client: AsyncNimble
@@ -6619,6 +6650,12 @@ class AsyncNimbleWithStreamedResponse:
 
         return AsyncTasksResourceWithStreamingResponse(self._client.tasks)
 
+    @cached_property
+    def batches(self) -> batches.AsyncBatchesResourceWithStreamingResponse:
+        from .resources.batches import AsyncBatchesResourceWithStreamingResponse
+
+        return AsyncBatchesResourceWithStreamingResponse(self._client.batches)
+
 
 Client = Nimble
 

{nimble_python-0.12.0 → nimble_python-0.14.0}/src/nimble_python/_utils/__init__.py

@@ -1,3 +1,4 @@
+from ._path import path_template as path_template
 from ._sync import asyncify as asyncify
 from ._proxy import LazyProxy as LazyProxy
 from ._utils import (

nimble_python-0.14.0/src/nimble_python/_utils/_path.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+import re
+from typing import (
+    Any,
+    Mapping,
+    Callable,
+)
+from urllib.parse import quote
+
+# Matches '.' or '..' where each dot is either literal or percent-encoded (%2e / %2E).
+_DOT_SEGMENT_RE = re.compile(r"^(?:\.|%2[eE]){1,2}$")
+
+_PLACEHOLDER_RE = re.compile(r"\{(\w+)\}")
+
+
+def _quote_path_segment_part(value: str) -> str:
+    """Percent-encode `value` for use in a URI path segment.
+
+    Considers characters not in `pchar` set from RFC 3986 §3.3 to be unsafe.
+    https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+    """
+    # quote() already treats unreserved characters (letters, digits, and -._~)
+    # as safe, so we only need to add sub-delims, ':', and '@'.
+    # Notably, unlike the default `safe` for quote(), / is unsafe and must be quoted.
+    return quote(value, safe="!$&'()*+,;=:@")
+
+
+def _quote_query_part(value: str) -> str:
+    """Percent-encode `value` for use in a URI query string.
+
+    Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe.
+    https://datatracker.ietf.org/doc/html/rfc3986#section-3.4
+    """
+    return quote(value, safe="!$'()*+,;:@/?")
+
+
+def _quote_fragment_part(value: str) -> str:
+    """Percent-encode `value` for use in a URI fragment.
+
+    Considers characters not in `fragment` set from RFC 3986 §3.5 to be unsafe.
+    https://datatracker.ietf.org/doc/html/rfc3986#section-3.5
+    """
+    return quote(value, safe="!$&'()*+,;=:@/?")
+
+
+def _interpolate(
+    template: str,
+    values: Mapping[str, Any],
+    quoter: Callable[[str], str],
+) -> str:
+    """Replace {name} placeholders in `template`, quoting each value with `quoter`.
+
+    Placeholder names are looked up in `values`.
+
+    Raises:
+        KeyError: If a placeholder is not found in `values`.
+    """
+    # re.split with a capturing group returns alternating
+    # [text, name, text, name, ..., text] elements.
+    parts = _PLACEHOLDER_RE.split(template)
+
+    for i in range(1, len(parts), 2):
+        name = parts[i]
+        if name not in values:
+            raise KeyError(f"a value for placeholder {{{name}}} was not provided")
+        val = values[name]
+        if val is None:
+            parts[i] = "null"
+        elif isinstance(val, bool):
+            parts[i] = "true" if val else "false"
+        else:
+            parts[i] = quoter(str(values[name]))
+
+    return "".join(parts)
+
+
+def path_template(template: str, /, **kwargs: Any) -> str:
+    """Interpolate {name} placeholders in `template` from keyword arguments.
+
+    Args:
+        template: The template string containing {name} placeholders.
+        **kwargs: Keyword arguments to interpolate into the template.
+
+    Returns:
+        The template with placeholders interpolated and percent-encoded.
+
+        Safe characters for percent-encoding are dependent on the URI component.
+        Placeholders in path and fragment portions are percent-encoded where the `segment`
+        and `fragment` sets from RFC 3986 respectively are considered safe.
+        Placeholders in the query portion are percent-encoded where the `query` set from
+        RFC 3986 §3.3 is considered safe except for = and & characters.
+
+    Raises:
+        KeyError: If a placeholder is not found in `kwargs`.
+        ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments).
+    """
+    # Split the template into path, query, and fragment portions.
+    fragment_template: str | None = None
+    query_template: str | None = None
+
+    rest = template
+    if "#" in rest:
+        rest, fragment_template = rest.split("#", 1)
+    if "?" in rest:
+        rest, query_template = rest.split("?", 1)
+    path_template = rest
+
+    # Interpolate each portion with the appropriate quoting rules.
+    path_result = _interpolate(path_template, kwargs, _quote_path_segment_part)
+
+    # Reject dot-segments (. and ..) in the final assembled path.  The check
+    # runs after interpolation so that adjacent placeholders or a mix of static
+    # text and placeholders that together form a dot-segment are caught.
+    # Also reject percent-encoded dot-segments to protect against incorrectly
+    # implemented normalization in servers/proxies.
+    for segment in path_result.split("/"):
+        if _DOT_SEGMENT_RE.match(segment):
+            raise ValueError(f"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed")
+
+    result = path_result
+    if query_template is not None:
+        result += "?" + _interpolate(query_template, kwargs, _quote_query_part)
+    if fragment_template is not None:
+        result += "#" + _interpolate(fragment_template, kwargs, _quote_fragment_part)
+
+    return result

{nimble_python-0.12.0 → nimble_python-0.14.0}/src/nimble_python/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "nimble_python"
-__version__ = "0.12.0"  # x-release-please-version
+__version__ = "0.14.0"  # x-release-please-version

{nimble_python-0.12.0 → nimble_python-0.14.0}/src/nimble_python/resources/__init__.py

@@ -24,6 +24,14 @@ from .tasks import (
     TasksResourceWithStreamingResponse,
     AsyncTasksResourceWithStreamingResponse,
 )
+from .batches import (
+    BatchesResource,
+    AsyncBatchesResource,
+    BatchesResourceWithRawResponse,
+    AsyncBatchesResourceWithRawResponse,
+    BatchesResourceWithStreamingResponse,
+    AsyncBatchesResourceWithStreamingResponse,
+)
 
 __all__ = [
     "AgentResource",
@@ -44,4 +52,10 @@ __all__ = [
     "AsyncTasksResourceWithRawResponse",
     "TasksResourceWithStreamingResponse",
     "AsyncTasksResourceWithStreamingResponse",
+    "BatchesResource",
+    "AsyncBatchesResource",
+    "BatchesResourceWithRawResponse",
+    "AsyncBatchesResourceWithRawResponse",
+    "BatchesResourceWithStreamingResponse",
+    "AsyncBatchesResourceWithStreamingResponse",
 ]

{nimble_python-0.12.0 → nimble_python-0.14.0}/src/nimble_python/resources/agent.py

@@ -9,7 +9,7 @@ import httpx
 
 from ..types import agent_run_params, agent_list_params, agent_run_async_params
 from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
-from .._utils import maybe_transform, async_maybe_transform
+from .._utils import path_template, maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -131,7 +131,7 @@ class AgentResource(SyncAPIResource):
         if not template_name:
             raise ValueError(f"Expected a non-empty value for `template_name` but received {template_name!r}")
         return self._get(
-            f"/v1/agents/{template_name}",
+            path_template("/v1/agents/{template_name}", template_name=template_name),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -345,7 +345,7 @@ class AsyncAgentResource(AsyncAPIResource):
         if not template_name:
             raise ValueError(f"Expected a non-empty value for `template_name` but received {template_name!r}")
         return await self._get(
-            f"/v1/agents/{template_name}",
+            path_template("/v1/agents/{template_name}", template_name=template_name),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),