keycloak-sdk 0.1.0__tar.gz

keycloak_sdk-0.1.0/.gitignore

@@ -0,0 +1,91 @@
+# ── Java / Maven ──────────────────────────────────────────────
+target/
+*.class
+*.jar
+*.war
+*.ear
+!.mvn/wrapper/maven-wrapper.jar
+dependency-reduced-pom.xml
+.mvn/timing.properties
+.mvn/wrapper/maven-wrapper.properties
+
+# ── IDE ───────────────────────────────────────────────────────
+.idea/
+*.iml
+*.ipr
+*.iws
+.vscode/
+.settings/
+.project
+.classpath
+*.code-workspace
+
+# ── OS ────────────────────────────────────────────────────────
+.DS_Store
+Thumbs.db
+
+# ── Secrets / credentials (절대 커밋 금지) ────────────────────
+*.gpg
+*.asc
+secring.*
+.env
+.env.*
+settings-security.xml
+.scamanager/token   # SCAManager 인증 토큰 — 로컬 전용(mode 600), 환경변수 SCAMANAGER_TOKEN 대안
+
+# ── SDD 진척 원장 (로컬 스크래치) ─────────────────────────────
+.superpowers/
+
+# ── Python (향후 SDK) ─────────────────────────────────────────
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.coverage
+htmlcov/
+.ruff_cache/
+.pytest_cache/
+
+# ── Node.js / TypeScript ──────────────────────────────────────
+node_modules/
+.vite/
+coverage/
+*.tsbuildinfo
+cover.out
+cover.logic.out
+# rust — `cargo llvm-cov --lcov`가 SonarCloud에 먹일 리포트를 여기에 쓴다(CI가 매 실행마다 생성).
+lcov.info
+
+# ── Gradle / Kotlin (빌드 스크래치) ───────────────────────────
+# kotlin/.gitignore가 SDK 모듈은 이미 덮지만, Gradle 스크래치는 build.gradle.kts가
+# 있는 **아무 디렉터리에서나** 생긴다 — scripts/test/fixtures/doc-guard/src(가드
+# 테스트용 가짜 빌드파일)에서 실제로 .gradle/이 생겨 커밋될 뻔했다. 루트에서 막는다.
+.gradle/
+.kotlin/
+
+# SCAManager 개인 코드리뷰 도구 — 공개 저장소에 포함하지 않는다(개인 저장소/전역 git 템플릿으로 관리)
+.scamanager/
+
+# coverlet(.NET)이 테스트 실행 때마다 테스트 프로젝트 옆에 떨어뜨리는 커버리지 산출물.
+# ⚠️ 절대경로가 박혀 있어 커밋되면 개인 머신 경로가 공개 이력에 남는다(실제로 한 번 유입됨 —
+# 742a01b의 coverage.json에 `F:\DEVELOPMENT\...` 경로가 그대로 들어갔다).
+# ⚠️ 출력 파일명은 `/p:CoverletOutputFormat`이 정한다. 오래 `coverage.json`(기본 json 형식)만
+# 막아뒀는데 dotnet-ci와 harness가 실제로 쓰는 형식은 **cobertura**라, 로컬에서 CI와 같은 명령을
+# 돌리면 무시되지 않는 `coverage.cobertura.xml`이 남았다(실제로 남는 것을 확인). 한 형식만 막으면
+# 나머지가 새므로 coverlet이 내는 형식을 전부 막는다.
+coverage.json
+coverage.cobertura.xml
+coverage.opencover.xml
+coverage.info
+# ⚠️ 단, 커버리지 가드의 테스트 픽스처는 산출물이 아니라 **소스**다. 위 규칙들은 파일명만 보므로
+# `coverage.cobertura.xml` 픽스처를, 그리고 위쪽 `coverage/` 규칙은 디렉터리째 삼킨다 — 그러면
+# 로컬에서는 테스트가 통과하는데 CI에서는 픽스처가 없어 깨진다(실제로 커밋 직전에 걸렸다).
+# ⚠️ 예외는 이 디렉터리로만 좁힌다. `!scripts/test/fixtures/**`처럼 넓게 열면 doc-guard 픽스처
+# 아래 실제 빌드 산출물(.gradle 잠금·바이너리 캐시)까지 추적된다(이것도 실제로 걸렸다).
+!scripts/test/fixtures/coverage-gate/**
+
+# Playwright MCP 브라우저 세션 산출물(스냅샷·콘솔 로그) — 진단용 임시 파일이다.
+.playwright-mcp/

keycloak_sdk-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 xzawed
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

keycloak_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.5
+Name: keycloak-sdk
+Version: 0.1.0
+Summary: Keycloak SDK for Python — auth (OIDC/OAuth2) + Admin REST API, wrapping python-keycloak
+Project-URL: Homepage, https://github.com/xzawed/KeyCloakSDK/tree/main/python
+Project-URL: Repository, https://github.com/xzawed/KeyCloakSDK
+Project-URL: Issues, https://github.com/xzawed/KeyCloakSDK/issues
+Author-email: xzawed <xzawed31@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: admin,keycloak,oauth2,oidc,sso
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: joserfc<2,>=1.7
+Requires-Dist: python-keycloak<8,>=7.1
+Provides-Extra: dev
+Requires-Dist: mypy>=2.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=9.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: testcontainers[keycloak]>=4.14; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Keycloak SDK for Python
+
+Authentication (OIDC / OAuth2) and the Admin REST API for [Keycloak](https://www.keycloak.org/) behind one consistent facade, with hardened JWT validation and a full async mirror.
+
+Part of a **nine-language polyglot SDK** (Java · Python · Node · Go · C# · PHP · Rust · Ruby · Kotlin) — one API surface, isomorphic across all of them: [github.com/xzawed/KeyCloakSDK](https://github.com/xzawed/KeyCloakSDK).
+
+> **Pre-release** — the first release candidate (`0.1.0rc1`) is on PyPI; there is no stable release yet. Note that a bare `pip install keycloak-sdk` currently resolves this RC, because pip falls back to pre-releases when only pre-releases exist.
+
+## Requirements
+
+- Python **3.10+**
+- Ships the PEP 561 `py.typed` marker, so consumers can type-check with `mypy` too
+
+## Install
+
+```bash
+pip install keycloak-sdk
+```
+
+The distribution name is `keycloak-sdk`; the import package is `keycloak_sdk`.
+
+## Quickstart
+
+```python
+from keycloak_sdk import KeycloakClient, KeycloakConfig
+
+config = KeycloakConfig(
+    server_url="https://kc.example.com",
+    realm="myrealm",
+    client_id="admin-cli",
+    client_secret="changeme",  # load the real value from an env var / secrets manager
+)
+
+# The `with` block cleans up the admin and auth sessions on exit.
+with KeycloakClient.create(config) as kc:
+    # 1) Issue a client-credentials token. repr(TokenSet) masks every token value.
+    token = kc.auth.client_credentials_token()
+
+    # 2) Validate it — algorithm pinning, exact iss, aud containment, mandatory exp, clock skew.
+    validated = kc.auth.validate(token.access_token)
+    print(f"subject={validated.subject} aud={validated.audience}")
+
+    # 3) Admin API — admin is created lazily on first access. create() returns the new user id.
+    user_id = kc.admin.users.create({"username": "alice", "enabled": True})
+    users = kc.admin.users.search(first=0, max=20)
+```
+
+`validate()` expects the token's `aud` to contain `client_id` by default, but a stock realm does not put the client id into a client-credentials token. Either set `expected_audience="my-api"` on the config to check the audience your tokens actually carry, or add an audience mapper to the client in Keycloak (Client scopes → dedicated scope → Add mapper → Audience).
+
+### Async
+
+`keycloak_sdk.aio` is a complete async mirror — same method names, value types, and exceptions — so it never blocks the event loop (FastAPI and friends):
+
+```python
+from keycloak_sdk import KeycloakConfig
+from keycloak_sdk.aio import AsyncKeycloakClient
+
+
+async def handler(config: KeycloakConfig) -> None:
+    async with AsyncKeycloakClient.create(config) as kc:
+        token = await kc.auth.client_credentials_token()
+        validated = await kc.auth.validate(token.access_token)
+        users = await kc.admin.users.search(first=0, max=20)
+```
+
+Only `authorization_url` stays synchronous — it assembles a URL and needs no network.
+
+## Security defaults
+
+The SDK replaces the unsafe library defaults rather than inheriting them:
+
+- **Algorithm pinning** — the header-supplied `alg` is never trusted, so `alg: none` and HS/RS confusion are rejected structurally: joserfc decodes against the configured allowlist, and an empty allowlist is refused at construction rather than falling back to joserfc's permissive default set.
+- **Strict claim checks** — exact `iss` match, `aud` containment, mandatory `exp`, `nbf`, and a bounded clock skew.
+- **DoS-safe JWKS** — a refetch is triggered only by an unresolved key ID and never by a bad signature, and is rate-limited to a minimum interval (`jwks_min_refetch_seconds`, 30s by default) — so no volume of forged tokens makes the SDK issue more than one JWKS request per interval.
+- **Secret handling** — `repr()` of the config and token types masks secrets and tokens as `***` (no prefix leak), and TLS verification is on by default.
+
+Masking covers this SDK's own `repr()`; it cannot cover what your logging framework or a traceback does with a value you hand it. Python has no erasable string type, so the client secret lives in an ordinary `str` for its lifetime — masking is defence in depth, not an erasure guarantee.
+
+## Versioning and support
+
+This SDK is **pre-1.0**. Under SemVer a `0.x` **minor** bump may carry breaking changes, so read the release notes before upgrading. Only the newest released version of each language SDK receives security fixes — there are no LTS lines, and older `0.x` releases are not backported to. Full policy: [SECURITY.md](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md).
+
+## Documentation
+
+- [Getting started](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/getting-started.md#python) — install, quickstart, async, and the compatibility matrix
+- [Deploying a Keycloak server](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/deploying-keycloak-server.md) — the server this SDK talks to
+- [Security policy](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md)
+- Full examples: [`quickstart.py`](https://github.com/xzawed/KeyCloakSDK/blob/main/python/examples/quickstart.py) · [`async_quickstart.py`](https://github.com/xzawed/KeyCloakSDK/blob/main/python/examples/async_quickstart.py)
+
+## License
+
+[Apache-2.0](https://github.com/xzawed/KeyCloakSDK/blob/main/python/LICENSE)

keycloak_sdk-0.1.0/README.md

@@ -0,0 +1,92 @@
+# Keycloak SDK for Python
+
+Authentication (OIDC / OAuth2) and the Admin REST API for [Keycloak](https://www.keycloak.org/) behind one consistent facade, with hardened JWT validation and a full async mirror.
+
+Part of a **nine-language polyglot SDK** (Java · Python · Node · Go · C# · PHP · Rust · Ruby · Kotlin) — one API surface, isomorphic across all of them: [github.com/xzawed/KeyCloakSDK](https://github.com/xzawed/KeyCloakSDK).
+
+> **Pre-release** — the first release candidate (`0.1.0rc1`) is on PyPI; there is no stable release yet. Note that a bare `pip install keycloak-sdk` currently resolves this RC, because pip falls back to pre-releases when only pre-releases exist.
+
+## Requirements
+
+- Python **3.10+**
+- Ships the PEP 561 `py.typed` marker, so consumers can type-check with `mypy` too
+
+## Install
+
+```bash
+pip install keycloak-sdk
+```
+
+The distribution name is `keycloak-sdk`; the import package is `keycloak_sdk`.
+
+## Quickstart
+
+```python
+from keycloak_sdk import KeycloakClient, KeycloakConfig
+
+config = KeycloakConfig(
+    server_url="https://kc.example.com",
+    realm="myrealm",
+    client_id="admin-cli",
+    client_secret="changeme",  # load the real value from an env var / secrets manager
+)
+
+# The `with` block cleans up the admin and auth sessions on exit.
+with KeycloakClient.create(config) as kc:
+    # 1) Issue a client-credentials token. repr(TokenSet) masks every token value.
+    token = kc.auth.client_credentials_token()
+
+    # 2) Validate it — algorithm pinning, exact iss, aud containment, mandatory exp, clock skew.
+    validated = kc.auth.validate(token.access_token)
+    print(f"subject={validated.subject} aud={validated.audience}")
+
+    # 3) Admin API — admin is created lazily on first access. create() returns the new user id.
+    user_id = kc.admin.users.create({"username": "alice", "enabled": True})
+    users = kc.admin.users.search(first=0, max=20)
+```
+
+`validate()` expects the token's `aud` to contain `client_id` by default, but a stock realm does not put the client id into a client-credentials token. Either set `expected_audience="my-api"` on the config to check the audience your tokens actually carry, or add an audience mapper to the client in Keycloak (Client scopes → dedicated scope → Add mapper → Audience).
+
+### Async
+
+`keycloak_sdk.aio` is a complete async mirror — same method names, value types, and exceptions — so it never blocks the event loop (FastAPI and friends):
+
+```python
+from keycloak_sdk import KeycloakConfig
+from keycloak_sdk.aio import AsyncKeycloakClient
+
+
+async def handler(config: KeycloakConfig) -> None:
+    async with AsyncKeycloakClient.create(config) as kc:
+        token = await kc.auth.client_credentials_token()
+        validated = await kc.auth.validate(token.access_token)
+        users = await kc.admin.users.search(first=0, max=20)
+```
+
+Only `authorization_url` stays synchronous — it assembles a URL and needs no network.
+
+## Security defaults
+
+The SDK replaces the unsafe library defaults rather than inheriting them:
+
+- **Algorithm pinning** — the header-supplied `alg` is never trusted, so `alg: none` and HS/RS confusion are rejected structurally: joserfc decodes against the configured allowlist, and an empty allowlist is refused at construction rather than falling back to joserfc's permissive default set.
+- **Strict claim checks** — exact `iss` match, `aud` containment, mandatory `exp`, `nbf`, and a bounded clock skew.
+- **DoS-safe JWKS** — a refetch is triggered only by an unresolved key ID and never by a bad signature, and is rate-limited to a minimum interval (`jwks_min_refetch_seconds`, 30s by default) — so no volume of forged tokens makes the SDK issue more than one JWKS request per interval.
+- **Secret handling** — `repr()` of the config and token types masks secrets and tokens as `***` (no prefix leak), and TLS verification is on by default.
+
+Masking covers this SDK's own `repr()`; it cannot cover what your logging framework or a traceback does with a value you hand it. Python has no erasable string type, so the client secret lives in an ordinary `str` for its lifetime — masking is defence in depth, not an erasure guarantee.
+
+## Versioning and support
+
+This SDK is **pre-1.0**. Under SemVer a `0.x` **minor** bump may carry breaking changes, so read the release notes before upgrading. Only the newest released version of each language SDK receives security fixes — there are no LTS lines, and older `0.x` releases are not backported to. Full policy: [SECURITY.md](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md).
+
+## Documentation
+
+- [Getting started](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/getting-started.md#python) — install, quickstart, async, and the compatibility matrix
+- [Deploying a Keycloak server](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/deploying-keycloak-server.md) — the server this SDK talks to
+- [Security policy](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md)
+- Full examples: [`quickstart.py`](https://github.com/xzawed/KeyCloakSDK/blob/main/python/examples/quickstart.py) · [`async_quickstart.py`](https://github.com/xzawed/KeyCloakSDK/blob/main/python/examples/async_quickstart.py)
+
+## License
+
+[Apache-2.0](https://github.com/xzawed/KeyCloakSDK/blob/main/python/LICENSE)

keycloak_sdk-0.1.0/examples/async_quickstart.py

@@ -0,0 +1,46 @@
+"""Async QuickStart — `keycloak-sdk`의 `keycloak_sdk.aio` 최소 사용 예제.
+
+sync `examples/quickstart.py`의 async 미러다. FastAPI 같은 async 프레임워크
+안에서 이벤트 루프를 블로킹하지 않고 Keycloak을 호출하고 싶을 때 이 경로를 쓴다.
+
+이 파일은 정적으로 임포트/타입체크만 되는 것을 목표로 한다(실제 Keycloak 서버 없이도
+`python -c "import ast; ast.parse(...)"`와 `mypy`가 통과해야 한다). 네트워크 호출이
+필요한 로직은 `main()`에 있고 `if __name__ == "__main__":` 가드 뒤에서만 실행되므로,
+모듈을 임포트하는 것만으로는 아무 요청도 나가지 않는다.
+
+실행하려면 실제 Keycloak 서버 정보로 아래 `KeycloakConfig` 값을 채우고
+`python examples/async_quickstart.py`를 실행한다(서비스 계정에 필요한 권한 role 필요).
+"""
+
+from __future__ import annotations
+
+import asyncio
+
+from keycloak_sdk import mask
+from keycloak_sdk.aio import AsyncKeycloakClient
+from keycloak_sdk.config import KeycloakConfig
+
+
+async def main() -> None:
+    config = KeycloakConfig(
+        server_url="https://keycloak.example.com",
+        realm="my-realm",
+        client_id="my-client",
+        client_secret="my-client-secret",  # 실제 값은 환경변수/시크릿 매니저에서 로드할 것
+    )
+
+    # AsyncKeycloakClient.create()는 auth(AsyncAuthClient)를 즉시 조립한다. admin은
+    # 최초 `.admin` 접근 시 지연 생성된다(client_secret 필요 — client-credentials grant).
+    async with AsyncKeycloakClient.create(config) as kc:
+        # 1) client-credentials 토큰 발급 — 토큰 원문은 절대 로그에 남기지 않는다.
+        #    `mask()`는 접두 노출 없이 "***"(값이 있을 때)만 돌려준다 — 존재 여부만 드러낸다.
+        token = await kc.auth.client_credentials_token()
+        print(f"access_token={mask(token.access_token)} token_type={token.token_type}")
+
+        # 2) 관리 API로 사용자 목록 조회(admin이 이 시점에 지연 생성된다).
+        users = await kc.admin.users.search(first=0, max=10)
+        print(f"users={[u.get('username') for u in users]}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

keycloak_sdk-0.1.0/examples/quickstart.py

@@ -0,0 +1,39 @@
+"""QuickStart — `keycloak-sdk` 최소 사용 예제.
+
+이 파일은 정적으로 임포트/타입체크만 되는 것을 목표로 한다(실제 Keycloak 서버 없이도
+`python -c "import ast; ast.parse(...)"`와 `mypy`가 통과해야 한다). 네트워크 호출이
+필요한 로직은 `main()`에 있고 `if __name__ == "__main__":` 가드 뒤에서만 실행되므로,
+모듈을 임포트하는 것만으로는 아무 요청도 나가지 않는다.
+
+실행하려면 실제 Keycloak 서버 정보로 아래 `KeycloakConfig` 값을 채우고
+`python examples/quickstart.py`를 실행한다(서비스 계정에 필요한 권한 role 필요).
+"""
+
+from __future__ import annotations
+
+from keycloak_sdk import KeycloakClient, KeycloakConfig, mask
+
+
+def main() -> None:
+    config = KeycloakConfig(
+        server_url="https://keycloak.example.com",
+        realm="my-realm",
+        client_id="my-client",
+        client_secret="my-client-secret",  # 실제 값은 환경변수/시크릿 매니저에서 로드할 것
+    )
+
+    # KeycloakClient.create()는 auth(AuthClient)를 즉시 조립한다. admin은 최초
+    # `.admin` 접근 시 지연 생성된다(client_secret 필요 — client-credentials grant).
+    with KeycloakClient.create(config) as kc:
+        # 1) client-credentials 토큰 발급 — 토큰 원문은 절대 로그에 남기지 않는다.
+        #    `mask()`는 접두 노출 없이 "***"(값이 있을 때)만 돌려준다 — 존재 여부만 드러낸다.
+        token = kc.auth.client_credentials_token()
+        print(f"access_token={mask(token.access_token)} token_type={token.token_type}")
+
+        # 2) 관리 API로 사용자 목록 조회(admin이 이 시점에 지연 생성된다).
+        users = kc.admin.users.search(first=0, max=10)
+        print(f"users={[u.get('username') for u in users]}")
+
+
+if __name__ == "__main__":
+    main()