Skip to content

Commit 1bd246c

Browse files
Alexandre Bergereclaude
andcommitted
feat: the Kaiten Python SDK
A typed Python client for both Kaiten APIs, generated and tested against the contract of kaitencloud/kaiten@22031b95. - Core API: KaitenClient and AsyncKaitenClient over 95 of the contract's 98 operations. The three left out are the console's rule-editor tooling, which kaiten's own SDK coverage test excludes for the same reason. - Platform API: KaitenPlatformClient and AsyncKaitenPlatformClient over all 10. - Models for every response and every published webhook event, generated from openapi/ by scripts/generate_models.py: snake_case attributes, lenient about the fields and enum values the API grows after a release, and to_dict() for the exact wire shape. - One implementation, two clients: src/kaitencloud/_sync is generated from _async by scripts/unasync.py, so they cannot drift. The behaviours are the ones go-sdk and the JS SDK learned the hard way: - list() walks every page at the API's maximum page size, and raises PaginationError rather than hand back a list the API said was incomplete -- a single unpaged read would have kept working until the 51st row existed. - Retries cover only what is safe to repeat. A usage report is never retried: with no idempotency key on the wire, a report replayed after a lost response is usage counted twice, and usage is what customers are billed on. - Errors are typed and keep the RFC 9457 problem -- code, detail, errorId -- with ThresholdExceededError for a report refused at the licence's cap. - A credential of the wrong class is refused before anything is sent, rather than meeting the listener's deliberately uninformative refusal. Tests: 618, none of which opens a socket. Every mapped operation is called on both clients against a fake API generated from the contract, and every request body is validated against that operation's schema with readOnly properties removed -- once with every argument, once with only the required ones. That is the class of bug that made entitlement and licence writes 422 on every call in go-sdk until TestRequestBodiesMatchTheirSpecBodies existed. Webhook signature verification is cross-checked against the svix library and its published reference vector. CI runs the generated-code check, ruff, mypy --strict, the suite on Python 3.10 to 3.14 and on the oldest supported dependencies, and the build. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 6c0b925 commit 1bd246c

97 files changed

Lines changed: 28135 additions & 2 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/ci.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
pull_request:
7+
branches: ["main"]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
checks:
14+
name: Generated code, lint & types
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v5
18+
19+
- uses: astral-sh/setup-uv@v6
20+
with:
21+
enable-cache: true
22+
23+
- run: uv sync --locked
24+
25+
# The models come from openapi/ and the sync client from the async one. A commit that
26+
# edits either source without regenerating would ship code the repository cannot
27+
# reproduce, so the check regenerates and compares.
28+
- name: Generated code is up to date
29+
run: |
30+
uv run python scripts/generate_models.py --check
31+
uv run python scripts/unasync.py --check
32+
33+
- run: uv run ruff check .
34+
- run: uv run ruff format --check .
35+
- run: uv run mypy
36+
37+
test:
38+
name: Tests (Python ${{ matrix.python-version }})
39+
runs-on: ubuntu-latest
40+
strategy:
41+
fail-fast: false
42+
matrix:
43+
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
44+
steps:
45+
- uses: actions/checkout@v5
46+
47+
- uses: astral-sh/setup-uv@v6
48+
with:
49+
enable-cache: true
50+
python-version: ${{ matrix.python-version }}
51+
52+
- run: uv sync --locked
53+
- run: uv run pytest --cov --cov-report=term-missing
54+
55+
lowest-dependencies:
56+
name: Tests on the lowest supported dependencies
57+
runs-on: ubuntu-latest
58+
steps:
59+
- uses: actions/checkout@v5
60+
61+
- uses: astral-sh/setup-uv@v6
62+
with:
63+
python-version: "3.10"
64+
65+
# The lower bounds in pyproject.toml are a promise to every consumer; this is what keeps
66+
# them honest.
67+
- run: uv sync --resolution lowest-direct
68+
- run: uv run pytest
69+
70+
build:
71+
name: Build
72+
runs-on: ubuntu-latest
73+
steps:
74+
- uses: actions/checkout@v5
75+
- uses: astral-sh/setup-uv@v6
76+
- run: uv build
77+
- run: uvx twine check --strict dist/*

‎.github/workflows/release.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags: ["v*"]
6+
7+
jobs:
8+
publish:
9+
name: Publish to PyPI
10+
runs-on: ubuntu-latest
11+
environment: pypi
12+
permissions:
13+
contents: read
14+
id-token: write # PyPI trusted publishing: no API token is stored anywhere.
15+
steps:
16+
- uses: actions/checkout@v5
17+
- uses: astral-sh/setup-uv@v6
18+
19+
- name: The tag names the package version
20+
run: |
21+
version=$(sed -n 's/^__version__ = "\(.*\)"$/\1/p' src/kaitencloud/_version.py)
22+
if [ "v$version" != "$GITHUB_REF_NAME" ]; then
23+
echo "tag $GITHUB_REF_NAME does not match the package version $version" >&2
24+
exit 1
25+
fi
26+
27+
- run: uv sync --locked
28+
- run: uv run pytest
29+
30+
- run: uv build
31+
- run: uvx twine check --strict dist/*
32+
- run: uv publish --trusted-publishing always

‎.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Python
2+
__pycache__/
3+
*.py[cod]
4+
*.egg-info/
5+
build/
6+
dist/
7+
8+
# Tooling
9+
.venv/
10+
.pytest_cache/
11+
.mypy_cache/
12+
.ruff_cache/
13+
.coverage
14+
.coverage.*
15+
coverage.xml
16+
htmlcov/
17+
18+
.DS_Store

‎CHANGELOG.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented here. The format follows
4+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project adheres to
5+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html): until 1.0.0, a minor version may
6+
change the public API, and a patch version never does.
7+
8+
## [0.1.0] - Unreleased
9+
10+
The first release of the Kaiten Python SDK, generated and tested against the contract of
11+
[`kaitencloud/kaiten@22031b95`](https://github.com/kaitencloud/kaiten/commit/22031b95c4a71f83428f2a0718b53c4cf6c2c459).
12+
13+
### Added
14+
15+
- `KaitenClient` and `AsyncKaitenClient` for the Core API: customers, instances, licenses,
16+
entitlements and entitlement groups, usage reporting, feature flags and their OFREP
17+
evaluation, deployment zones, releases, components, metadata fields, service accounts,
18+
connectors and integrations -- 95 of the contract's 98 operations. The three left out are the
19+
console's rule-editor tooling, which Kaiten's own SDK coverage excludes too.
20+
- `KaitenPlatformClient` and `AsyncKaitenPlatformClient` for the Platform API: all 10 operations.
21+
- Models for every response and every webhook event, generated from the contract with
22+
pydantic v2: snake_case attributes, lenient about fields and enum values added after a
23+
release, and `to_dict()` for the exact wire shape.
24+
- List methods that walk every page, and fail with `PaginationError` rather than return a list
25+
the API said was incomplete.
26+
- Automatic retries with exponential backoff for requests that are safe to repeat -- never a
27+
usage report -- honouring `Retry-After`.
28+
- Typed errors for every failure, carrying the RFC 9457 problem: `code`, `detail`, `error_id`.
29+
`ThresholdExceededError` for a usage report refused at the license's cap.
30+
- A credential guard that refuses a platform credential on the Core client, an organization
31+
token on the platform client, and a webhook secret on either, before anything is sent.
32+
- `kaitencloud.webhooks`: Svix signature verification, and a typed model for each of the 49
33+
published events.
34+
- `kaitencloud.targeting`, builders for feature flag variants, rollouts and targeting rules.
35+
- `kaitencloud.usage`, the enforcement arithmetic the API applies to a grant and its overage
36+
allowance.

‎LICENSE‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on behalf of Yourself, assuming sole
171+
responsibility, not on behalf of any other Contributor, and only
172+
if You agree to indemnify, defend, and hold each Contributor
173+
harmless for any liability incurred by, or claims asserted against,
174+
such Contributor by reason of your accepting any such warranty or
175+
additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2026 Kaiten
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

0 commit comments

Comments
 (0)