| Name | nemo-microservices JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | The official Python library for the NeMo Microservices API |
| upload_time | 2025-07-10 00:09:20 |
| maintainer | None |
| docs_url | None |
| author | NVIDIA Corporation |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NVIDIA NeMo Microservices Python SDK
[)](https://pypi.org/project/nemo-microservices/)
The NVIDIA NeMo Microservices Python SDK provides convenient access to the NeMo Microservices REST API from any Python 3.8+
application. The SDK includes type definitions for all request parameters and response fields,
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
[Stainless](https://www.stainless.com/) generates this SDK from the [NVIDIA NeMo Microservices REST API](https://docs.nvidia.com/nemo/microservices/latest/api/index.html).
## Documentation
You can find the platform documentation at [NVIDIA NeMo Microservices Documentation](https://docs.nvidia.com/nemo/microservices/latest/about/index.html).
The [NVIDIA NeMo Microservice APIs](https://docs.nvidia.com/nemo/microservices/latest/api/index.html) section documents the REST API.
## Installation
This project downloads and installs additional third-party open source software projects. Review the license terms of these open source projects before use.
```sh
pip install nemo-microservices
```
## Usage
This section describes how to use the NeMo microservices Python SDK.
### Import the Main Client Class
Import the main client class from the `nemo_microservices` package and create a client instance as follows:
```python
from nemo_microservices import NeMoMicroservices
client = NeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test"
)
# Sample API call
page = client.namespaces.list()
print(page.data)
```
- For the `base_url`, point to the default host for NeMo microservices. This sets up the client to interact with the NeMo microservices APIs except the NIM Proxy microservice APIs.
- For the `inference_base_url`, point to the host for the NIM Proxy microservice. You can also directly point to the host for a NIM microservice if the cluster admin in your organization has deployed it, or point to a NIM microservice on build.nvidia.com.
After creating the client instance, you can use the client to interact with the NeMo microservices APIs.
## Async Usage
If you want to use the asynchronous client, simply import `AsyncNeMoMicroservices` instead of `NeMoMicroservices` and use `await` with each API call:
```python
import asyncio
from nemo_microservices import AsyncNeMoMicroservices
client = AsyncNeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test"
)
# Sample API call
async def main() -> None:
page = await client.namespaces.list()
print(page.data)
asyncio.run(main())
```
Functionality between the synchronous and asynchronous clients is otherwise identical.
### With aiohttp
By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
You can enable this by installing `aiohttp`:
```sh
pip install 'nemo-microservices[aiohttp]'
```
Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
```python
import asyncio
from nemo_microservices import DefaultAioHttpClient
from nemo_microservices import AsyncNeMoMicroservices
async def main() -> None:
async with AsyncNeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test",
http_client=DefaultAioHttpClient(),
) as client:
page = await client.namespaces.list()
print(page.data)
asyncio.run(main())
```
## Using Types
Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
- Serializing back into JSON, `model.to_json()`
- Converting to a dictionary, `model.to_dict()`
Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs, set `python.analysis.typeCheckingMode` to `basic`.
## Pagination
List methods in the NeMo microservices API are paginated.
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
```python
from nemo_microservices import NeMoMicroservices
client = NeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test"
)
all_projects = []
# Automatically fetches more pages as needed.
for project in client.projects.list():
# Do something with project here
all_projects.append(project)
print(all_projects)
```
Or, asynchronously:
```python
import asyncio
from nemo_microservices import AsyncNeMoMicroservices
client = AsyncNeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test"
)
async def main() -> None:
all_projects = []
# Iterate through items across all pages, issuing requests as needed.
async for project in client.projects.list():
all_projects.append(project)
print(all_projects)
asyncio.run(main())
```
Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
```python
first_page = await client.projects.list()
if first_page.has_next_page():
print(f"will fetch next page using these details: {first_page.next_page_info()}")
next_page = await first_page.get_next_page()
print(f"number of items we just fetched: {len(next_page.data)}")
# Remove `await` for non-async usage.
```
Or just work directly with the returned data:
```python
first_page = await client.projects.list()
for project in first_page.data:
print(project.created_at)
# Remove `await` for non-async usage.
```
## Nested Parameters
Nested parameters are dictionaries, typed using `TypedDict`, for example:
```python
from nemo_microservices import NeMoMicroservices
client = NeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test"
)
customization_config = client.customization.configs.create(
max_seq_length=0,
training_options=[
{
"finetuning_type": "p_tuning",
"micro_batch_size": 0,
"num_gpus": 0,
"training_type": "sft",
}
],
ownership={},
)
print(customization_config.ownership)
```
## Handling Errors
The library raises errors when it cannot connect to the API or when the API returns a non-success status code.
### API Connection Errors
When the library cannot connect to the API (for example, due to network connection problems or a timeout), it raises a subclass of `nemo_microservices.APIConnectionError`.
When the API returns a non-success status code (that is, 4xx or 5xx
response), it raises a subclass of `nemo_microservices.APIStatusError`, containing `status_code` and `response` properties.
All errors inherit from `nemo_microservices.APIError`.
```python
import nemo_microservices
from nemo_microservices import NeMoMicroservices
client = NeMoMicroservices()
try:
client.namespaces.list()
except nemo_microservices.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except nemo_microservices.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except nemo_microservices.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)
```
Error codes are as follows:
| Status Code | Error Type |
| ----------- | -------------------------- |
| 400 | `BadRequestError` |
| 401 | `AuthenticationError` |
| 403 | `PermissionDeniedError` |
| 404 | `NotFoundError` |
| 422 | `UnprocessableEntityError` |
| 429 | `RateLimitError` |
| >=500 | `InternalServerError` |
| N/A | `APIConnectionError` |
## Retries
Certain errors are automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.
You can use the `max_retries` option to configure or disable retry settings:
```python
from nemo_microservices import NeMoMicroservices
# Configure the default for all requests:
client = NeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test",
# default is 2
max_retries=0,
)
# Or, configure per-request:
client.with_options(max_retries=5).namespaces.list()
```
## Timeouts
By default, requests time out after 1 minute. 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 nemo_microservices import NeMoMicroservices
# Configure the default for all requests:
client = NeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test",
# 20 seconds (default is 1 minute)
timeout=20.0,
)
# More granular control:
client = NeMoMicroservices(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)
# Override per-request:
client.with_options(timeout=5.0).namespaces.list()
```
On timeout, an `APITimeoutError` is thrown.
Note that requests that time out are [retried twice by default](https://github.com/stainless-sdks/nemo-microservices-v1-python/tree/main/#retries).
## Advanced Usage
### Logging
We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
You can enable logging by setting the environment variable `NEMO_MICROSERVICES_LOG` to `info`.
```shell
$ export NEMO_MICROSERVICES_LOG=info
```
Or to `debug` for more verbose logging.
#### How to Tell Whether `None` Means `null` or Missing
In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
```py
if response.my_field is None:
if 'my_field' not in response.model_fields_set:
print('Got json like {}, without a "my_field" key present at all.')
else:
print('Got json like {"my_field": null}.')
```
### Accessing Raw Response Data (e.g. Headers)
You can access the "raw" response object by prefixing `.with_raw_response.` to any HTTP method call, for example:
```py
from nemo_microservices import NeMoMicroservices
client = NeMoMicroservices(base_url="http://nemo.test", inference_base_url="http://nim.test")
response = client.namespaces.with_raw_response.list()
print(response.headers.get('X-My-Header'))
namespace = response.parse() # get the object that `namespaces.list()` would have returned
print(namespace.id)
```
These methods return an `APIResponse` object.
The async client returns an `AsyncAPIResponse` with the same structure, the only difference being `await`able methods for reading the response content.
#### `.with_streaming_response`
The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
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.namespaces.with_streaming_response.list() as response:
print(response.headers.get("X-My-Header"))
for line in response.iter_lines():
print(line)
```
The context manager is required so that the response will reliably be closed.
### Making Custom/Undocumented Requests
This library is typed for convenient access to the documented API.
If you need to access undocumented endpoints, params, or response properties, you can still use the library.
#### Undocumented Endpoints
To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
http verbs. The client will respect options (such as retries) when making this request.
```py
import httpx
response = client.post(
"/foo",
cast_to=httpx.Response,
body={"my_param": True},
)
print(response.headers.get("x-foo"))
```
#### Undocumented Request Params
If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
options.
#### Undocumented Response Properties
To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
can also get all the extra fields on the Pydantic model as a dict with
[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
### Configuring the HTTP Client
You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)
- Custom [transports](https://www.python-httpx.org/advanced/transports/)
- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
```python
import httpx
from nemo_microservices import NeMoMicroservices, DefaultHttpxClient
client = NeMoMicroservices(
base_url="http://nemo.test",
inference_base_url="http://nim.test",
http_client=DefaultHttpxClient(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
```
You can also customize the client on a per-request basis by using `with_options()`:
```python
client.with_options(http_client=DefaultHttpxClient(...))
```
### Managing HTTP Resources
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 use a context manager that closes when exiting.
```py
from nemo_microservices import NeMoMicroservices
with NeMoMicroservices() as client:
# make requests here
...
# HTTP client is now closed
```
## Versioning
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, while it might release certain backwards-incompatible changes as minor versions:
1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. Open a GitHub issue to let us know if you are relying on such internals.
3. Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We welcome your feedback; please contact us with questions, bugs, or suggestions.
### Determining the Installed Version
If you've upgraded to the latest version but can't find any new features you were expecting, your Python environment is likely still using an older version.
You can determine the version that is being used at runtime with:
```py
import nemo_microservices
print(nemo_microservices.__version__)
```
## Requirements
Python 3.8 or higher.
Raw data
{
"_id": null,
"home_page": null,
"name": "nemo-microservices",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "NVIDIA Corporation",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# NVIDIA NeMo Microservices Python SDK\n\n[)](https://pypi.org/project/nemo-microservices/)\n\nThe NVIDIA NeMo Microservices Python SDK provides convenient access to the NeMo Microservices REST API from any Python 3.8+\napplication. The SDK includes type definitions for all request parameters and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n[Stainless](https://www.stainless.com/) generates this SDK from the [NVIDIA NeMo Microservices REST API](https://docs.nvidia.com/nemo/microservices/latest/api/index.html).\n\n## Documentation\n\nYou can find the platform documentation at [NVIDIA NeMo Microservices Documentation](https://docs.nvidia.com/nemo/microservices/latest/about/index.html).\nThe [NVIDIA NeMo Microservice APIs](https://docs.nvidia.com/nemo/microservices/latest/api/index.html) section documents the REST API.\n\n## Installation\n\nThis project downloads and installs additional third-party open source software projects. Review the license terms of these open source projects before use.\n\n```sh\npip install nemo-microservices\n```\n\n## Usage\n\nThis section describes how to use the NeMo microservices Python SDK.\n\n### Import the Main Client Class\n\nImport the main client class from the `nemo_microservices` package and create a client instance as follows:\n\n```python\nfrom nemo_microservices import NeMoMicroservices\n\nclient = NeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\"\n)\n\n# Sample API call \npage = client.namespaces.list()\nprint(page.data)\n```\n\n- For the `base_url`, point to the default host for NeMo microservices. This sets up the client to interact with the NeMo microservices APIs except the NIM Proxy microservice APIs.\n- For the `inference_base_url`, point to the host for the NIM Proxy microservice. You can also directly point to the host for a NIM microservice if the cluster admin in your organization has deployed it, or point to a NIM microservice on build.nvidia.com.\n\nAfter creating the client instance, you can use the client to interact with the NeMo microservices APIs.\n\n## Async Usage\n\nIf you want to use the asynchronous client, simply import `AsyncNeMoMicroservices` instead of `NeMoMicroservices` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom nemo_microservices import AsyncNeMoMicroservices\n\nclient = AsyncNeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\"\n)\n\n# Sample API call\nasync def main() -> None:\n page = await client.namespaces.list()\n print(page.data)\n\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\npip install 'nemo-microservices[aiohttp]'\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom nemo_microservices import DefaultAioHttpClient\nfrom nemo_microservices import AsyncNeMoMicroservices\n\n\nasync def main() -> None:\n async with AsyncNeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\",\n http_client=DefaultAioHttpClient(),\n ) as client:\n page = await client.namespaces.list()\n print(page.data)\n\n\nasyncio.run(main())\n```\n\n## Using Types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the NeMo microservices API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom nemo_microservices import NeMoMicroservices\n\nclient = NeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\"\n)\n\nall_projects = []\n# Automatically fetches more pages as needed.\nfor project in client.projects.list():\n # Do something with project here\n all_projects.append(project)\nprint(all_projects)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom nemo_microservices import AsyncNeMoMicroservices\n\nclient = AsyncNeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\"\n)\n\nasync def main() -> None:\n all_projects = []\n # Iterate through items across all pages, issuing requests as needed.\n async for project in client.projects.list():\n all_projects.append(project)\n print(all_projects)\n\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.projects.list()\nif first_page.has_next_page():\n print(f\"will fetch next page using these details: {first_page.next_page_info()}\")\n next_page = await first_page.get_next_page()\n print(f\"number of items we just fetched: {len(next_page.data)}\")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.projects.list()\nfor project in first_page.data:\n print(project.created_at)\n\n# Remove `await` for non-async usage.\n```\n\n## Nested Parameters\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom nemo_microservices import NeMoMicroservices\n\nclient = NeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\"\n)\n\ncustomization_config = client.customization.configs.create(\n max_seq_length=0,\n training_options=[\n {\n \"finetuning_type\": \"p_tuning\",\n \"micro_batch_size\": 0,\n \"num_gpus\": 0,\n \"training_type\": \"sft\",\n }\n ],\n ownership={},\n)\nprint(customization_config.ownership)\n```\n\n## Handling Errors\n\nThe library raises errors when it cannot connect to the API or when the API returns a non-success status code.\n\n### API Connection Errors\n\nWhen the library cannot connect to the API (for example, due to network connection problems or a timeout), it raises a subclass of `nemo_microservices.APIConnectionError`.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), it raises a subclass of `nemo_microservices.APIStatusError`, containing `status_code` and `response` properties.\n\nAll errors inherit from `nemo_microservices.APIError`.\n\n```python\nimport nemo_microservices\nfrom nemo_microservices import NeMoMicroservices\n\nclient = NeMoMicroservices()\n\ntry:\n client.namespaces.list()\nexcept nemo_microservices.APIConnectionError as e:\n print(\"The server could not be reached\")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept nemo_microservices.RateLimitError as e:\n print(\"A 429 status code was received; we should back off a bit.\")\nexcept nemo_microservices.APIStatusError as e:\n print(\"Another non-200-range status code was received\")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n## Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom nemo_microservices import NeMoMicroservices\n\n# Configure the default for all requests:\nclient = NeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\",\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries=5).namespaces.list()\n```\n\n## Timeouts\n\nBy default, requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom nemo_microservices import NeMoMicroservices\n\n# Configure the default for all requests:\nclient = NeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\",\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = NeMoMicroservices(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout=5.0).namespaces.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](https://github.com/stainless-sdks/nemo-microservices-v1-python/tree/main/#retries).\n\n## Advanced Usage\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `NEMO_MICROSERVICES_LOG` to `info`.\n\n```shell\n$ export NEMO_MICROSERVICES_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n#### How to Tell Whether `None` Means `null` or Missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if 'my_field' not in response.model_fields_set:\n print('Got json like {}, without a \"my_field\" key present at all.')\n else:\n print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing Raw Response Data (e.g. Headers)\n\nYou can access the \"raw\" response object by prefixing `.with_raw_response.` to any HTTP method call, for example:\n\n```py\nfrom nemo_microservices import NeMoMicroservices\n\nclient = NeMoMicroservices(base_url=\"http://nemo.test\", inference_base_url=\"http://nim.test\")\nresponse = client.namespaces.with_raw_response.list()\nprint(response.headers.get('X-My-Header'))\n\nnamespace = response.parse() # get the object that `namespaces.list()` would have returned\nprint(namespace.id)\n```\n\nThese methods return an `APIResponse` object.\n\nThe async client returns an `AsyncAPIResponse` with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo 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.\n\n```python\nwith client.namespaces.with_streaming_response.list() as response:\n print(response.headers.get(\"X-My-Header\"))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making Custom/Undocumented Requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, you can still use the library.\n\n#### Undocumented Endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. The client will respect options (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n \"/foo\",\n cast_to=httpx.Response,\n body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented Request Params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented Response Properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP Client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom nemo_microservices import NeMoMicroservices, DefaultHttpxClient\n\nclient = NeMoMicroservices(\n base_url=\"http://nemo.test\",\n inference_base_url=\"http://nim.test\",\n http_client=DefaultHttpxClient(\n proxy=\"http://my.test.proxy.example.com\",\n transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n ),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP Resources\n\nBy 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 use a context manager that closes when exiting.\n\n```py\nfrom nemo_microservices import NeMoMicroservices\n\nwith NeMoMicroservices() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, while it might release certain backwards-incompatible changes as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. Open a GitHub issue to let us know if you are relying on such internals.\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe welcome your feedback; please contact us with questions, bugs, or suggestions.\n\n### Determining the Installed Version\n\nIf you've upgraded to the latest version but can't find any new features you were expecting, your Python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport nemo_microservices\nprint(nemo_microservices.__version__)\n```\n\n## Requirements\n\nPython 3.8 or higher.",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The official Python library for the NeMo Microservices API",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://docs.nvidia.com/nemo/microservices/latest/about/index.html"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9264b0492e4015c03138c8d86d499d9a13bf73837409489657f4568c9f734eea",
"md5": "252209e626c5be157602bf20fb3401b3",
"sha256": "2e6c6f6c5f1cee5d8277d26d62530d5133cd0808f259a8a54fca6fa6bf2f1bcd"
},
"downloads": -1,
"filename": "nemo_microservices-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "252209e626c5be157602bf20fb3401b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 614409,
"upload_time": "2025-07-10T00:09:20",
"upload_time_iso_8601": "2025-07-10T00:09:20.151404Z",
"url": "https://files.pythonhosted.org/packages/92/64/b0492e4015c03138c8d86d499d9a13bf73837409489657f4568c9f734eea/nemo_microservices-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 00:09:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nemo-microservices"
}
