anduril-lattice-sdk-test


Nameanduril-lattice-sdk-test JSON
Version 2.0.0a0 PyPI version JSON
download
home_pageNone
SummaryHTTP clients for the Anduril Lattice SDK
upload_time2025-07-22 20:50:41
maintainerNone
docs_urlNone
authorAnduril Industries
requires_python<4.0,>=3.8
licenseNone
keywords anduril lattice
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Anduril Python Library

![](https://www.anduril.com/lattice-sdk/)

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fanduril%2Flattice-sdk-python)
[![pypi](https://img.shields.io/pypi/v/anduril-lattice-sdk-test)](https://pypi.python.org/pypi/anduril-lattice-sdk-test)

The Anduril Python library provides convenient access to the Anduril API from Python.

## Documentation

API reference documentation is available [here](https://developer.anduril.com/).

## Requirements

To use the SDK please ensure you have the following installed:

* [Python 3](https://www.python.org/doc/versions)

## Installation

```sh
pip install anduril-lattice-sdk-test
```

## Support

For support with this library please reach out to your Anduril representative.

## Reference

A full reference for this library is available [here](https://github.com/anduril/lattice-sdk-python/blob/HEAD/./reference.md).

## Usage

Instantiate and use the client with the following:

```python
from anduril import Lattice

client = Lattice(
    token="YOUR_TOKEN",
)
client.entities.long_poll_entity_events(
    session_token="sessionToken",
)
```

## Async Client

The SDK also exports an `async` client so that you can make non-blocking calls to our API.

```python
import asyncio

from anduril import AsyncLattice

client = AsyncLattice(
    token="YOUR_TOKEN",
)


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.

```python
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)
```

## Pagination

Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.

```python
from anduril import Lattice

client = Lattice(
    token="YOUR_TOKEN",
)
response = client.objects.list_objects()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page
```

## 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.

```python
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.data)  # access the underlying object
pager = client.objects.list_objects(...)
print(pager.response.headers)  # access the response headers for the first page
for item in pager:
    print(item)  # access the underlying object(s)
for page in pager.iter_pages():
    print(page.response.headers)  # access the response headers for each page
    for item in page:
        print(item)  # access the underlying object(s)
```

### 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).

A request is deemed retryable when any of the following HTTP status codes is returned:

- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)

Use the `max_retries` request option to configure this behavior.

```python
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.

```python

from anduril import Lattice

client = Lattice(
    ...,
    timeout=20.0,
)


# Override timeout for a specific method
client.entities.long_poll_entity_events(..., request_options={
    "timeout_in_seconds": 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.

```python
import httpx
from anduril import Lattice

client = Lattice(
    ...,
    httpx_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)
```

## Contributing

While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "anduril-lattice-sdk-test",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "anduril, lattice",
    "author": "Anduril Industries",
    "author_email": "lattice-developers@anduril.com",
    "download_url": "https://files.pythonhosted.org/packages/e4/01/bf53bdd36cb3deb77a4abaf5798052057f842126fa888f045426b7f4f622/anduril_lattice_sdk_test-2.0.0a0.tar.gz",
    "platform": null,
    "description": "# Anduril Python Library\n\n![](https://www.anduril.com/lattice-sdk/)\n\n[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fanduril%2Flattice-sdk-python)\n[![pypi](https://img.shields.io/pypi/v/anduril-lattice-sdk-test)](https://pypi.python.org/pypi/anduril-lattice-sdk-test)\n\nThe Anduril Python library provides convenient access to the Anduril API from Python.\n\n## Documentation\n\nAPI reference documentation is available [here](https://developer.anduril.com/).\n\n## Requirements\n\nTo use the SDK please ensure you have the following installed:\n\n* [Python 3](https://www.python.org/doc/versions)\n\n## Installation\n\n```sh\npip install anduril-lattice-sdk-test\n```\n\n## Support\n\nFor support with this library please reach out to your Anduril representative.\n\n## Reference\n\nA full reference for this library is available [here](https://github.com/anduril/lattice-sdk-python/blob/HEAD/./reference.md).\n\n## Usage\n\nInstantiate and use the client with the following:\n\n```python\nfrom anduril import Lattice\n\nclient = Lattice(\n    token=\"YOUR_TOKEN\",\n)\nclient.entities.long_poll_entity_events(\n    session_token=\"sessionToken\",\n)\n```\n\n## Async Client\n\nThe SDK also exports an `async` client so that you can make non-blocking calls to our API.\n\n```python\nimport asyncio\n\nfrom anduril import AsyncLattice\n\nclient = AsyncLattice(\n    token=\"YOUR_TOKEN\",\n)\n\n\nasync def main() -> None:\n    await client.entities.long_poll_entity_events(\n        session_token=\"sessionToken\",\n    )\n\n\nasyncio.run(main())\n```\n\n## Exception Handling\n\nWhen the API returns a non-success status code (4xx or 5xx response), a subclass of the following error\nwill be thrown.\n\n```python\nfrom anduril.core.api_error import ApiError\n\ntry:\n    client.entities.long_poll_entity_events(...)\nexcept ApiError as e:\n    print(e.status_code)\n    print(e.body)\n```\n\n## Pagination\n\nPaginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.\n\n```python\nfrom anduril import Lattice\n\nclient = Lattice(\n    token=\"YOUR_TOKEN\",\n)\nresponse = client.objects.list_objects()\nfor item in response:\n    yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n    yield page\n```\n\n## Advanced\n\n### Access Raw Response Data\n\nThe SDK provides access to raw response data, including headers, through the `.with_raw_response` property.\nThe `.with_raw_response` property returns a \"raw\" client that can be used to access the `.headers` and `.data` attributes.\n\n```python\nfrom anduril import Lattice\n\nclient = Lattice(\n    ...,\n)\nresponse = client.entities.with_raw_response.long_poll_entity_events(...)\nprint(response.headers)  # access the response headers\nprint(response.data)  # access the underlying object\npager = client.objects.list_objects(...)\nprint(pager.response.headers)  # access the response headers for the first page\nfor item in pager:\n    print(item)  # access the underlying object(s)\nfor page in pager.iter_pages():\n    print(page.response.headers)  # access the response headers for each page\n    for item in page:\n        print(item)  # access the underlying object(s)\n```\n\n### Retries\n\nThe SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long\nas the request is deemed retryable and the number of retry attempts has not grown larger than the configured\nretry limit (default: 2).\n\nA request is deemed retryable when any of the following HTTP status codes is returned:\n\n- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)\n- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)\n- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)\n\nUse the `max_retries` request option to configure this behavior.\n\n```python\nclient.entities.long_poll_entity_events(..., request_options={\n    \"max_retries\": 1\n})\n```\n\n### Timeouts\n\nThe SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.\n\n```python\n\nfrom anduril import Lattice\n\nclient = Lattice(\n    ...,\n    timeout=20.0,\n)\n\n\n# Override timeout for a specific method\nclient.entities.long_poll_entity_events(..., request_options={\n    \"timeout_in_seconds\": 1\n})\n```\n\n### Custom Client\n\nYou can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies\nand transports.\n\n```python\nimport httpx\nfrom anduril import Lattice\n\nclient = Lattice(\n    ...,\n    httpx_client=httpx.Client(\n        proxies=\"http://my.test.proxy.example.com\",\n        transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n    ),\n)\n```\n\n## Contributing\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nAdditions made directly to this library would have to be moved over to our generation code,\notherwise they would be overwritten upon the next generated release. Feel free to open a PR as\na proof of concept, but know that we will not be able to merge it as-is. We suggest opening\nan issue first to discuss with us!\n\nOn the other hand, contributions to the README are always very welcome!\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "HTTP clients for the Anduril Lattice SDK",
    "version": "2.0.0a0",
    "project_urls": null,
    "split_keywords": [
        "anduril",
        " lattice"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f5b949db954c0d09c52819a5d73f8d5c60b7f7213f4e5fa8da4fc5c0e95e9174",
                "md5": "ae59194bdf6e918fb4152222881eebcd",
                "sha256": "d45b4f5e88ebabf639a9b06da9c2f60a541c45a55d136846fc3c121df548ad86"
            },
            "downloads": -1,
            "filename": "anduril_lattice_sdk_test-2.0.0a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ae59194bdf6e918fb4152222881eebcd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 185932,
            "upload_time": "2025-07-22T20:50:40",
            "upload_time_iso_8601": "2025-07-22T20:50:40.303289Z",
            "url": "https://files.pythonhosted.org/packages/f5/b9/49db954c0d09c52819a5d73f8d5c60b7f7213f4e5fa8da4fc5c0e95e9174/anduril_lattice_sdk_test-2.0.0a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e401bf53bdd36cb3deb77a4abaf5798052057f842126fa888f045426b7f4f622",
                "md5": "c61de6218438a49eb0cb06a1e3ba8c05",
                "sha256": "7f105ffe00caadf9c5fa7de25273ea70ee627a1e9983b6885b130ce450d7cf85"
            },
            "downloads": -1,
            "filename": "anduril_lattice_sdk_test-2.0.0a0.tar.gz",
            "has_sig": false,
            "md5_digest": "c61de6218438a49eb0cb06a1e3ba8c05",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 85895,
            "upload_time": "2025-07-22T20:50:41",
            "upload_time_iso_8601": "2025-07-22T20:50:41.914288Z",
            "url": "https://files.pythonhosted.org/packages/e4/01/bf53bdd36cb3deb77a4abaf5798052057f842126fa888f045426b7f4f622/anduril_lattice_sdk_test-2.0.0a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-22 20:50:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "anduril-lattice-sdk-test"
}
        
Elapsed time: 1.77294s