Lattice SDK Python Library
The Lattice SDK Python library provides convenient access to the Lattice SDK APIs from Python.
Table of Contents
- Documentation
- Requirements
- Installation
- Support
- Reference
- Usage
- Environments
- Async Client
- Exception Handling
- Streaming
- Pagination
- Oauth Token Override
- Advanced
Documentation
API reference documentation is available here.
Requirements
To use the SDK please ensure you have the following installed:
Installation
pip install anduril-lattice-sdk
Support
For support with this library please reach out to your Anduril representative.
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from anduril import Lattice
client = Lattice(
client_id="<clientId>",
client_secret="<clientSecret>",
)
client.entities.long_poll_entity_events(
session_token="sessionToken",
)
Environments
This SDK allows you to configure different environments for API requests.
from anduril import Lattice
from anduril.environment import LatticeEnvironment
client = Lattice(
environment=LatticeEnvironment.DEFAULT,
)
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).
import asyncio
from anduril import AsyncLattice
client = AsyncLattice(
client_id="<clientId>",
client_secret="<clientSecret>",
)
async def main() -> None:
await client.entities.long_poll_entity_events(
session_token="sessionToken",
)
asyncio.run(main())
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
from anduril.core.api_error import ApiError
try:
client.entities.long_poll_entity_events(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Streaming
The SDK supports streaming responses, as well, the response will be a generator that you can loop over.
from anduril import Lattice
client = Lattice(
client_id="<clientId>",
client_secret="<clientSecret>",
)
client.entities.stream_entities()
Pagination
Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.
from anduril import Lattice
client = Lattice(
client_id="<clientId>",
client_secret="<clientSecret>",
)
client.objects.list_objects()
# You can also iterate through pages and access the typed response per page
pager = client.objects.list_objects(...)
for page in pager.iter_pages():
print(page.response) # access the typed response for each page
for item in page:
print(item)
Oauth Token Override
This SDK supports two authentication methods: OAuth client credentials flow (automatic token management) or direct bearer token authentication. You can choose between these options when initializing the client:
from anduril import Lattice
# Option 1: Direct bearer token (bypass OAuth flow)
client = Lattice(
...,
token="my-pre-generated-bearer-token",
)
# Option 2: OAuth client credentials flow (automatic token management)
client = Lattice(
...,
client_id="your-client-id",
client_secret="your-client-secret",
)
Advanced
Access Raw Response Data
The SDK provides access to raw response data, including headers, through the .with_raw_response property.
The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.
from anduril import Lattice
client = Lattice(...)
response = client.entities.with_raw_response.long_poll_entity_events(...)
print(response.headers) # access the response headers
print(response.status_code) # access the response status code
print(response.data) # access the underlying object
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
Which status codes are retried depends on the retryStatusCodes generator configuration:
legacy (current default): retries on
recommended: retries on
- 408 (Timeout)
- 409 (Conflict)
- 429 (Too Many Requests)
- 502 (Bad Gateway)
- 503 (Service Unavailable)
- 504 (Gateway Timeout)
Use the max_retries request option to configure this behavior.
client.entities.long_poll_entity_events(..., request_options={
"max_retries": 1
})
Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
from anduril import Lattice
client = Lattice(..., timeout=20.0)
# Override timeout for a specific method
client.entities.long_poll_entity_events(..., request_options={
"timeout": 1
})
Custom Client
You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
import httpx
from anduril import Lattice
client = Lattice(
...,
httpx_client=httpx.Client(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
1 maintainer
Metadata
1 maintainer
Release files for anduril-lattice-sdk 5.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| anduril_lattice_sdk-5.1.0.tar.gz | 169.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| anduril_lattice_sdk-5.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 498.3 kB
Release files / anduril_lattice_sdk-5.1.0.tar.gz
| Download URL | anduril_lattice_sdk-5.1.0.tar.gz |
|---|---|
| Size | 169.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2baf2bf804574a88a71a0bbd2cc08e89365b3e204ea44afbd1b1445886b66463
|
|
BLAKE2b-256 checksum How to use checksums |
d68e6f19dc8b1af9d8ccf1be9f1ae7b6937c0efb7366dd74bc60c42171f1b0d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure
|
Release files / anduril_lattice_sdk-5.1.0-py3-none-any.whl
| Download URL | anduril_lattice_sdk-5.1.0-py3-none-any.whl |
|---|---|
| Size | 329.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
004145084012cfb2ad9f5d51a68b126bd6a058a870a1f932a4e9279bf0373c55
|
|
BLAKE2b-256 checksum How to use checksums |
3ede8679718812c9e8751a98bfbbf467b8f9472c4d29230a6665e1fe1f85345b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure
|
