sherpa-client

A client library for accessing Sherpa API documentation

Usage

First, create a client:

from sherpa_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 httpx import BasicAuth
from sherpa_client import AuthenticatedClient, ApiKeyAuth, BearerAuth

client = AuthenticatedClient(base_url="https://api.example.com", auth=BasicAuth(username="finley", password="secret"))
or
client = AuthenticatedClient(base_url="https://api.example.com", auth=BearerAuth("access-token-previously-retrieved")
or
client = AuthenticatedClient(base_url="https://api.example.com", auth=ApiKeyAuth("api-key-token-provided-by-kairtech"))

Now call your endpoint and use your models:

from sherpa_client.models import MyDataModel
from sherpa_client.api.my_tag import get_my_data_model
from sherpa_client.types import Response

with client as client:
    my_data: MyDataModel = get_my_data_model.sync(client=client)
    # or if you need more info (e.g. status_code)
    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

Or do the same thing with an async version:

from sherpa_client.models import MyDataModel
from sherpa_client.api.my_tag import get_my_data_model
from sherpa_client.types import Response

async with client as client:
    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

You can also disable certificate validation altogether, but beware that this is a security risk.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken", 
    verify_ssl=False
)

Things to know:

Every path/method combo becomes a Python module with four functions:
1. sync: Blocking request that returns parsed data (if successful) or None
2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
3. asyncio: Like sync but async instead of blocking
4. asyncio_detailed: Like sync_detailed but async instead of blocking
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 sherpa_client.api.default

Advanced customizations

There are more settings on the generated Client class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying httpx.Client or httpx.AsyncClient (depending on your use-case):

from sherpa_client import Client

def log_request(request):
    print(f"Request event hook: {request.method} {request.url} - Waiting for response")

def log_response(response):
    request = response.request
    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")

client = Client(
    base_url="https://api.example.com",
    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
)

# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()

You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):

import httpx
from sherpa_client import Client

client = Client(
    base_url="https://api.example.com",
)
# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))

Building / publishing this package

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
1. poetry config repositories.<your-repository-name> <url-to-your-repository>
2. 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, just poetry 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:
1. Build a wheel with poetry build -f wheel
2. Install that wheel from the other project pip install <path-to-wheel>

Metadata

Release files for sherpa-client 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sherpa-client 1.1.3
File	Size	Uploaded	Provenance
sherpa_client-1.1.3.tar.gz	160.4 kB	Jul 31, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for sherpa-client 1.1.3
File	Interpreter	ABI	Platform	Reset
sherpa_client-1.1.3-py3-none-any.whl 554.4 kB Jul 31, 2026 Without provenance	Python 3	none	any	Details

Total release size: 714.8 kB

Release files / sherpa_client-1.1.3.tar.gz

Download URL	sherpa_client-1.1.3.tar.gz
Size	160.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`0962b99d09e18d43819357e23acce3174110d1768a69a1dff48f764f298f36ab`
BLAKE2b-256 checksum How to use checksums	`972c6eb3e6f3226e132c0704061f09bc06be5cc6b76f56211343f883c3f31332`
Upload date	Jul 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.5 CPython/3.12.3 Linux/5.15.0-186-generic`

Release files / sherpa_client-1.1.3-py3-none-any.whl

Download URL	sherpa_client-1.1.3-py3-none-any.whl
Size	554.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2f910c02db6c44681323217aacf4240179d1162d105c6d7001c060707c67dc51`
BLAKE2b-256 checksum How to use checksums	`083c00dcbca41afc774f8684d88ee624c5d5e6570ed8d5ed0566e65c1acab7fd`
Upload date	Jul 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.5 CPython/3.12.3 Linux/5.15.0-186-generic`

Security for sherpa-client 1.1.3

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.