Metadata-Version: 2.1
Name: benchling-v3-sdk-python
Version: 15.0.0
Summary: SDK for interacting with the Benchling V3 API.
License: Apache-2.0
Keywords: benchling,v3,sdk,python,api
Requires-Python: >=3.10,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Provides-Extra: aiohttp
Requires-Dist: aiohttp (>=3.14.1,<4) ; (python_version >= "3.10") and (extra == "aiohttp")
Requires-Dist: httpx (>=0.21.2)
Requires-Dist: httpx-aiohttp (>=0.1.8,<0.2.0) ; (python_version >= "3.10") and (extra == "aiohttp")
Requires-Dist: jwcrypto (>=1.5.1,<2.0.0)
Requires-Dist: pydantic (>=1.9.2)
Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
Requires-Dist: typing_extensions (>=4.0.0)
Project-URL: Homepage, https://www.benchling.com
Project-URL: Repository, https://github.com/benchling/v3-rest-sdk-python
Description-Content-Type: text/markdown

# Benchling V3 Python SDK

A Python SDK for the [Benchling](https://www.benchling.com/) platform, providing typed access to the
Benchling V3 API.

## Installation

```bash
pip install benchling-v3-sdk-python
```

## Authenticate

You can authenticate with either an **API key** or **OAuth client credentials**.

To use an API key, get one from your Benchling account settings:

<!-- TODO: link to API key setup docs -->

```python
from benchling_v3_sdk import Benchling

benchling = Benchling(
    base_url="https://yourcompany.benchling.com",
    api_key="<your-api-key>",
    early_access="true",
)
```

To use OAuth client credentials, create an app to generate a client ID and secret:

<!-- TODO: link to Developer Platform / app setup docs -->

```python
from benchling_v3_sdk import Benchling

benchling = Benchling(
    base_url="https://yourcompany.benchling.com",
    client_id="<your-client-id>",
    client_secret="<your-client-secret>",
    early_access="true",
)
```

Pass `early_access="true"` to either client to enable beta endpoints.

## Make a request

For example, to list DNA sequences:

```python
for dna_sequence in benchling.dna_sequence.list():
    print(dna_sequence.id, dna_sequence.name)
```

## Support

To report issues with using the SDK, contact [support@benchling.com](mailto:support@benchling.com).

