yertle-client
Auto-generated Python client for the Yertle API.
Status: published on PyPI. Generated with
openapi-python-clientfrom the backend's OpenAPI spec.
Install
pip install yertle-client
The yertle_client/ directory in this repo is not committed — it's regenerated fresh at publish time from the backend's OpenAPI spec (see .github/workflows/publish-client.yml). See Local development below if you need the code on your machine.
Usage
from yertle_client import AuthenticatedClient
from yertle_client.api.organizations import list_organizations_orgs_get
client = AuthenticatedClient(
base_url="https://api.yertle.com",
token="<JWT or PAT>", # `yrt_*` PAT recommended for API consumers
)
orgs = list_organizations_orgs_get.sync(client=client)
for org in orgs or []:
print(org.id, org.name)
For a higher-level ergonomic wrapper (import yertle; yertle.orgs.list()), install the SDK facade instead:
pip install yertle
yertle depends on yertle-client transitively — installing it pulls both.
Local development
The clients/python/yertle_client/ directory is .gitignore'd because it's autogenerated. If you need the code locally (for example, to test not-yet-published spec changes against yertle-python), regenerate it:
# From the repo root:
make regen-client # dumps OpenAPI from local backend, then regens
# Or invoke the script directly for spec-source overrides:
bash clients/python/generate.sh # dump from local backend
OPENAPI_PATH=/path/to/spec.json bash clients/python/generate.sh # use a local spec file
OPENAPI_URL=http://localhost:8000/openapi.json bash clients/python/generate.sh # fetch from URL
Then install it into your yertle-python checkout for testing:
# In yertle-python:
uv pip install -e ../yertle/clients/python --force-reinstall
See docs/notes/features/yertle-python/PACKAGING.md "Local dev workflow" (in the backend repo) for the full playbook.
Layout
| Path | Source | Notes |
|---|---|---|
yertle_client/api/ |
generated (gitignored) | one module per API route |
yertle_client/models/ |
generated (gitignored) | request/response models (attrs-based) |
yertle_client/client.py |
generated (gitignored) | Client and AuthenticatedClient |
openapi-config.yaml |
hand-written (tracked) | codegen options (package name, naming) |
generate.sh |
hand-written (tracked) | regeneration script |
pyproject.toml |
hand-written (tracked) | package metadata + build config |
README.md |
hand-written (tracked) | this file |
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yertle_client-0.2.0.tar.gz.
File metadata
- Download URL: yertle_client-0.2.0.tar.gz
- Upload date:
- Size: 76.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
64e0f55a46f933d7dbad9169b20a9c8a8b70c27e90cd6430eed5edcbd929bddb
|
|
| MD5 |
507df32302e606104e4f304d101b75a8
|
|
| BLAKE2b-256 |
5ae05ed8af3743994bad943fda05d83a9cb3f0b19ed045e52fb35a9b0a7b9f4f
|
Provenance
The following attestation bundles were made for yertle_client-0.2.0.tar.gz:
Publisher:
publish-client.yml on albertcmiller1/yertle
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
yertle_client-0.2.0.tar.gz -
Subject digest:
64e0f55a46f933d7dbad9169b20a9c8a8b70c27e90cd6430eed5edcbd929bddb - Sigstore transparency entry: 2467457052
- Sigstore integration time:
-
Permalink:
albertcmiller1/yertle@5d8aca0459dfc1a58cadcee4ae7dee573836fac8 -
Branch / Tag:
refs/tags/yertle-client-v0.2.0 - Owner: https://github.com/albertcmiller1
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@5d8aca0459dfc1a58cadcee4ae7dee573836fac8 -
Trigger Event:
push
-
Statement type:
File details
Details for the file yertle_client-0.2.0-py3-none-any.whl.
File metadata
- Download URL: yertle_client-0.2.0-py3-none-any.whl
- Upload date:
- Size: 257.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cba01f91d4a0c595f959c91ca087ca3bbce1ecc52fab25e41fc24941557379a6
|
|
| MD5 |
2e2e69a92aacb75f464ddbb31d968166
|
|
| BLAKE2b-256 |
5a8e8b8a60a47d26fbc745e11e76bb4705b76eb8dcf049daa679e1ec68f1a559
|
Provenance
The following attestation bundles were made for yertle_client-0.2.0-py3-none-any.whl:
Publisher:
publish-client.yml on albertcmiller1/yertle
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
yertle_client-0.2.0-py3-none-any.whl -
Subject digest:
cba01f91d4a0c595f959c91ca087ca3bbce1ecc52fab25e41fc24941557379a6 - Sigstore transparency entry: 2467457073
- Sigstore integration time:
-
Permalink:
albertcmiller1/yertle@5d8aca0459dfc1a58cadcee4ae7dee573836fac8 -
Branch / Tag:
refs/tags/yertle-client-v0.2.0 - Owner: https://github.com/albertcmiller1
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@5d8aca0459dfc1a58cadcee4ae7dee573836fac8 -
Trigger Event:
push
-
Statement type:
