A client library for accessing Benchling API
Project description
benchling-api-client
A client library for accessing Benchling API
Usage
First, create a client:
from benchling_api_client import Client
client = Client(base_url="https://api.example.com")
If the endpoints you're going to hit require authentication, use AuthenticatedClient
instead:
from benchling_api_client import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
Now call your endpoint and use your models:
from benchling_api_client.models import MyDataModel
from benchling_api_client.api.my_tag import get_my_data_model
my_data: MyDataModel = get_my_data_model(client=client)
Or do the same thing with an async version:
from benchling_api_client.models import MyDataModel
from benchling_api_client.async_api.my_tag import get_my_data_model
my_data: MyDataModel = await get_my_data_model(client=client)
Things to know:
- Every path/method combo becomes a Python function with type annotations.
- All path/query params, and bodies become method arguments.
- If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
- Any endpoint which did not have a tag will be in
benchling_api_client.api.default
- If the API returns a response code that was not declared in the OpenAPI document, a
benchling_api_client.api.errors.ApiResponseError
wil be raised with theresponse
attribute set to thehttpx.Response
that was received.
Building / publishing this Client
This project uses Poetry to manage dependencies and packaging. Here are the basics:
- Update the metadata in pyproject.toml (e.g. authors, version)
- If you're using a private repository, configure it with Poetry
poetry config repositories.<your-repository-name> <url-to-your-repository>
poetry config http-basic.<your-repository-name> <username> <password>
- Publish the client with
poetry publish --build -r <your-repository-name>
or, if for public PyPI, justpoetry publish --build
If you want to install this client into another project without publishing it (e.g. for development) then:
- If that project is using Poetry, you can simply do
poetry add <path-to-this-client>
from that project - If that project is not using Poetry:
- Build a wheel with
poetry build -f wheel
- Install that wheel from the other project
pip install <path-to-wheel>
- Build a wheel with
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for benchling-api-client-0.1.1a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7b5d5b16ca3fa3a28ef9917d0dddb874ab1fda3000b59024db7ad3768b94261 |
|
MD5 | 6a41f9067e50e4caecaabda2173bb2d0 |
|
BLAKE2b-256 | 473064b67fde08e1c2bfcf44e57bb8d1db5d09d87c4666c5a3382c0e17435d55 |
Close
Hashes for benchling_api_client-0.1.1a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4e141040f853d5238deed54e88a2873c3205e23696ff79026a96ec4f4603269 |
|
MD5 | 743b82a907112a9037544bd2b1a2f41f |
|
BLAKE2b-256 | dcbf44706d9a176aba70cccc4f221b599f32761a77c2f0a9335a7515876f1203 |