skiva-sdk 0.1.0__tar.gz

skiva_sdk-0.1.0/.github/workflows/python.yml

@@ -0,0 +1,28 @@
+name: Python SDK
+on: [push, pull_request, workflow_dispatch, workflow_call]
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ['3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: python -m pip install '.[dev,pydantic-ai]'
+      - run: ruff check src tests examples
+      - run: pytest -q --cov=skiva_sdk --cov-fail-under=90 --cov-report=term-missing --cov-report=xml:.test-results/coverage.xml --junitxml=.test-results/junit.xml
+      - run: python -m build
+      - run: python examples/offline_demo.py
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: python-${{ matrix.python }}-test-results
+          path: .test-results/
+          include-hidden-files: true

skiva_sdk-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Publish Python SDK
+on:
+  push:
+    tags: ['v*']
+  workflow_dispatch:
+permissions:
+  contents: read
+concurrency:
+  group: pypi-${{ github.ref }}
+  cancel-in-progress: false
+jobs:
+  test:
+    if: startsWith(github.ref, 'refs/tags/v')
+    uses: ./.github/workflows/python.yml
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Validate release version
+        run: |
+          python - <<'PY'
+          import os, tomllib
+          with open('pyproject.toml', 'rb') as f:
+              project = tomllib.load(f)['project']
+          assert project['name'] == 'skiva-sdk'
+          assert os.environ['GITHUB_REF_NAME'] == 'v' + project['version'], 'Tag must match package version'
+          PY
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: python -m twine check --strict dist/*
+      - name: Smoke test installed wheel
+        run: |
+          python -m venv /tmp/skiva-wheel
+          /tmp/skiva-wheel/bin/python -m pip install dist/*.whl
+          /tmp/skiva-wheel/bin/python -c "import os; from importlib.metadata import version; from skiva_sdk import SkivaClient; assert 'v' + version('skiva-sdk') == os.environ['GITHUB_REF_NAME']"
+          /tmp/skiva-wheel/bin/python examples/offline_demo.py
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python-distributions
+          path: dist/
+          if-no-files-found: error
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/project/skiva-sdk/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: python-distributions
+          path: dist/
+      - name: Publish to PyPI with Trusted Publishing
+        uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # release/v1

skiva_sdk-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+.venv/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+.env
+.env.*
+!.env.example
+.coverage
+.coverage.*
+.hypothesis/
+.test-results/
+.DS_Store

skiva_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+English · [简体中文](CHANGELOG.zh-CN.md)
+
+## 0.1.0 — 2026-10-22
+
+- Async distribution/v1 client with immutable manifests and SHA-256 verification.
+- Pinned default and opt-in dynamic sessions with captured batch views.
+- Versioned discovery, content envelopes and expected snapshot/catalog checks.
+- Optional Pydantic AI 2.59.0 discovery instructions refreshed per model request.
+- Online permission checks, bounded memory and temporary directory materialization.
+- No durable task store, offline mode or automatic history cleanup.
+- Expanded regression suite with three multi-file Skill cases in two versions, generated rollback sequences and multi-turn Agent scenarios.
+- Fixed stale `last_refresh_error` after successful pinned refresh recovery.

skiva_sdk-0.1.0/CHANGELOG.zh-CN.md

@@ -0,0 +1,14 @@
+# 更新记录
+
+[English](CHANGELOG.md) · 简体中文
+
+## 0.1.0 — 2026-10-22
+
+- 异步 distribution/v1 客户端，不可变清单与 SHA-256 校验。
+- 默认固定策略、可选动态会话及批次固定视图。
+- 带版本的发现列表、内容包裹和预期快照/目录校验。
+- 可选 Pydantic AI 2.59.0 集成，每次模型请求刷新发现指令。
+- 在线权限检查、有上限的内存缓存和临时目录导出。
+- 不包含持久化任务存储、离线模式或自动历史清理。
+- 增加三组多文件双版本 Skill、自动生成回滚序列及多轮 Agent 场景测试。
+- 修复固定模式刷新恢复成功后仍残留 `last_refresh_error` 的问题。

skiva_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

skiva_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.5
+Name: skiva-sdk
+Version: 0.1.0
+Summary: Version-aware Skill discovery and delivery for Skiva
+Project-URL: Documentation, https://linghechen.github.io/skiva/docs/sdk-python/
+Project-URL: Repository, https://github.com/LingHeChen/skiva-python
+Project-URL: Issues, https://github.com/LingHeChen/skiva-python/issues
+Project-URL: Changelog, https://github.com/LingHeChen/skiva-python/blob/main/CHANGELOG.md
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pyyaml<7,>=6
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: hypothesis>=6; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=6; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.11; extra == 'dev'
+Provides-Extra: pydantic-ai
+Requires-Dist: pydantic-ai-slim==2.59.0; extra == 'pydantic-ai'
+Description-Content-Type: text/markdown
+
+# Skiva Python SDK
+
+English · [简体中文](https://github.com/LingHeChen/skiva-python/blob/main/README.zh-CN.md)
+
+Async Python SDK for Skiva's `/distribution/v1` protocol. Python 3.11+. Package name: `skiva-sdk`; import: `skiva_sdk`. Version: 0.1.0.
+
+[GitHub repository](https://github.com/LingHeChen/skiva-python) · [Skiva server](https://github.com/LingHeChen/skiva)
+
+## Install
+
+Install from PyPI:
+
+```bash
+python -m pip install skiva-sdk==0.1.0
+# Optional framework adapter, tested against exactly Pydantic AI 2.59.0:
+python -m pip install 'skiva-sdk[pydantic-ai]==0.1.0'
+```
+
+Use a **client credential assigned to an enabled Agent Profile**, not an admin/API session token. Use the server origin (or reverse-proxy prefix), without `/distribution/v1`. Use HTTPS outside a trusted local environment.
+
+```bash
+export SKIVA_SERVER_URL=http://localhost:8080
+export SKIVA_CLIENT_TOKEN=your-client-credential
+```
+
+The profile must have a published snapshot and authorized Skills. SDK dynamic mode respects server-side profile pins; it does not bypass them.
+
+## Discovery and loading
+
+```python
+import asyncio
+from skiva_sdk import SkivaClient
+
+async def main():
+    async with SkivaClient.from_env() as client:
+        async with client.bind(task_id="review-42") as skills:
+            catalog = await skills.catalog()
+            print(catalog.render())
+            if catalog.skills:
+                content = await skills.load_skill(
+                    catalog.skills[0].name,
+                    expected_snapshot_id=catalog.ref.snapshot_id,
+                    expected_catalog_digest=catalog.catalog_digest,
+                )
+                print(content.render())
+
+asyncio.run(main())
+```
+
+`Catalog` contains a `SnapshotRef`, immutable Skill metadata and `catalog_digest`. `SkillContent` contains the actual ref, catalog digest, manifest-relative path, file digest and text. Rendered envelopes escape XML markup. Names/descriptions still originate from published Skills: treat publishers as a trust boundary, not as trusted system-policy authors simply because text is escaped.
+
+The discovery prompt tells the model to compare snapshot IDs for equality, not chronological order, and to reload content whose version differs. Rollback is handled the same way as forward updates. `catalog_digest` also changes when the authorized file set changes within one snapshot. This is a model-facing fallback, **not a guarantee that old instructions are forgotten**.
+
+## Fixed and dynamic policies
+
+```python
+async with client.bind(consistency="dynamic") as skills:
+    await skills.refresh()  # explicit reconciliation; raises on failure
+    async with skills.snapshot() as batch:
+        body = await batch.read_text("review/SKILL.md")
+        rules = await batch.read_text("review/references/rules.md")
+        original_ref = batch.ref
+```
+
+- Default `pinned`: one snapshot and filtered manifest for the binding. Future channel changes do not change it.
+- Opt-in `dynamic`: reads/discovery reconcile on access after `refresh_interval` (default 5 seconds). `refresh()` forces reconciliation. No background daemon or SSE subscription.
+- An expected-version load forces dynamic reconciliation even before the interval expires. Snapshot or catalog mismatch raises `VersionMismatch`; no silent substitution.
+- A fully verified candidate replaces the active view atomically. Each operation captures one view; different operations can span versions. `snapshot()` captures one view for related operations, even while the enclosing dynamic session updates.
+- Refresh failure aborts that operation and populates `last_refresh_error`; it never silently reports stale discovery as fresh. Later successful refresh clears the error. `transition_count` counts successful view changes.
+- The client default can be overridden per binding. An explicit `source=SnapshotRef` requires pinned mode. Reuse a ref for an explicit retry, subject to current server grants/permissions.
+- `view.ref` in dynamic mode is a point-in-time observation. Use returned `SkillContent.ref` or `batch.ref` for provenance.
+
+Task/attempt IDs are optional correlation fields and auto-generated if absent. Duplicate active IDs are rejected **within one client**. There is no durable attempt store, crash resume or cross-process exactly-once guarantee in v0.1. Persist refs in your application's own storage for explicit pinned retries. A ref does not grant access and cannot bypass a new credential's permissions.
+
+## Pydantic AI integration
+
+```python
+from pydantic_ai import Agent
+from pydantic_ai.capabilities import Caching
+from skiva_sdk import SkillSession
+from skiva_sdk.integrations.pydantic_ai import SkivaSkills
+
+agent = Agent(
+    model,  # Supply your configured Pydantic AI model/provider.
+    name="skiva-agent",
+    deps_type=SkillSession,
+    capabilities=[Caching(), SkivaSkills()],
+)
+
+async with agent:
+    async with client.bind(consistency="dynamic") as skills:
+        result = await agent.run("Review this change", deps=skills)
+```
+
+`SkivaSkills` provides a named, dynamic discovery instruction part with **rewrite** semantics, evaluated before **every model request**. It explicitly refreshes the session at each request, bypassing the normal polling interval. It also registers `load_skill` and `read_skill_file`, requiring both expected version fields. Version mismatch/not-found become structured tool results; authorization/network failures abort rather than encourage stale fallback. It does not rewrite historical tool returns or erase derived conclusions. Provider wire placement of instructions depends on Pydantic AI and the provider.
+
+Keep business dependencies with `SkivaSkills(get_session=lambda deps: deps.skills)`. Each run must receive its own session; the capability has no mutable run state. Attach one SkivaSkills capability per Agent (tool names are fixed). This is a dedicated discovery/tool integration, **not** a replacement for the native Harness `Skills` workspace backend. Shell/direct filesystem access is not intercepted. Configure application tracing in the host application; the SDK exports no prompts/tokens to an external telemetry service.
+
+An active binding owns both discovery and reads. A pinned binding intentionally advertises its pinned catalog; select dynamic to follow updates within a run. Instructions are not modified while a model request is in flight. Header changes can affect prompt caching.
+
+## Real files when necessary
+
+```python
+async with skills.snapshot() as batch:
+    async with batch.materialize() as directory:
+        # Give this path to a framework or awaited subprocess.
+        # The child process must finish before leaving this block.
+        print(directory)
+```
+
+This exports a complete private copy into a temporary directory, preserving read/execute modes. It does not create a FUSE mount or writable hardlinks to shared objects. It rejects paths incompatible with supported platforms, including case-folding collisions. Cleanup occurs on exit. File modes are not sandbox isolation against the owning process. **Direct reads of exported files bypass SDK authorization; revocation cannot recall exported bytes.** New snapshots require new exports, never rewriting an old directory.
+
+## Validation, authorization and limits
+
+Every snapshot is fully downloaded and validated before publication: Go-compatible manifest canonicalization, SHA-256, sizes, paths and modes. Cache is in memory and private to each view/client; no shared disk/offline cache. Default limits: 10,000 files, 8 MiB per file/manifest, 64 MiB per snapshot, 256 KiB per SKILL.md parsing input. Concurrent/retained views multiply memory use; applications should limit concurrency and release references.
+
+Every public read/catalog/export rechecks the explicit snapshot manifest online, even for cached bytes. Changed permissions invalidate a captured view; explicit credential revocation is sticky for that client instance. Network failure blocks the operation. No offline mode, transparent network retries, or model-task retries. An authorization race after the final check and previously delivered content cannot be undone. HTTP redirects are not followed; bearer tokens are not included in SDK error messages. Raw transport instrumentation can still expose credentials; configure logging accordingly. Environment proxy/CA settings are ignored by default (`trust_env=False`); opt in explicitly with `trust_env=True` if needed, and install `httpx[socks]` for SOCKS proxies. A custom HTTPX transport can supply application TLS/proxy settings.
+
+Useful errors: `VersionMismatch`, `ManifestChanged`, `AuthorizationDenied`, `IntegrityError`, `ProtocolError`, `LimitExceeded`, `SkillNotFound`, `TransportError`, `ClosedError`.
+
+## Development and verification
+
+```bash
+uv sync --extra dev --extra pydantic-ai
+uv run pytest -q
+uv run ruff check src tests examples
+uv run python -m build
+uv run python examples/offline_demo.py
+```
+
+Tests use a controlled distribution fixture and Pydantic's actual `FunctionModel` agent loop, without external model calls. They cover updates/rollback, same-snapshot permission changes, concurrent reads/runs, old-content provenance, corruption, export isolation, and Go-generated manifest fixtures. The offline demo requires no server or credentials. It is not a substitute for deployment acceptance against your Skiva server and selected model provider.
+
+See [examples/](https://github.com/LingHeChen/skiva-python/tree/main/examples/) and [CHANGELOG.md](https://github.com/LingHeChen/skiva-python/blob/main/CHANGELOG.md). Official integration references: [Pydantic capabilities](https://pydantic.dev/docs/ai/capabilities/custom/), [Agent Skills implementation guide](https://agentskills.io/client-implementation/adding-skills-support).
+
+Detailed scenarios and recorded results: [Testing guide](https://github.com/LingHeChen/skiva-python/blob/main/docs/TESTING.md).

skiva_sdk-0.1.0/README.md

@@ -0,0 +1,135 @@
+# Skiva Python SDK
+
+English · [简体中文](https://github.com/LingHeChen/skiva-python/blob/main/README.zh-CN.md)
+
+Async Python SDK for Skiva's `/distribution/v1` protocol. Python 3.11+. Package name: `skiva-sdk`; import: `skiva_sdk`. Version: 0.1.0.
+
+[GitHub repository](https://github.com/LingHeChen/skiva-python) · [Skiva server](https://github.com/LingHeChen/skiva)
+
+## Install
+
+Install from PyPI:
+
+```bash
+python -m pip install skiva-sdk==0.1.0
+# Optional framework adapter, tested against exactly Pydantic AI 2.59.0:
+python -m pip install 'skiva-sdk[pydantic-ai]==0.1.0'
+```
+
+Use a **client credential assigned to an enabled Agent Profile**, not an admin/API session token. Use the server origin (or reverse-proxy prefix), without `/distribution/v1`. Use HTTPS outside a trusted local environment.
+
+```bash
+export SKIVA_SERVER_URL=http://localhost:8080
+export SKIVA_CLIENT_TOKEN=your-client-credential
+```
+
+The profile must have a published snapshot and authorized Skills. SDK dynamic mode respects server-side profile pins; it does not bypass them.
+
+## Discovery and loading
+
+```python
+import asyncio
+from skiva_sdk import SkivaClient
+
+async def main():
+    async with SkivaClient.from_env() as client:
+        async with client.bind(task_id="review-42") as skills:
+            catalog = await skills.catalog()
+            print(catalog.render())
+            if catalog.skills:
+                content = await skills.load_skill(
+                    catalog.skills[0].name,
+                    expected_snapshot_id=catalog.ref.snapshot_id,
+                    expected_catalog_digest=catalog.catalog_digest,
+                )
+                print(content.render())
+
+asyncio.run(main())
+```
+
+`Catalog` contains a `SnapshotRef`, immutable Skill metadata and `catalog_digest`. `SkillContent` contains the actual ref, catalog digest, manifest-relative path, file digest and text. Rendered envelopes escape XML markup. Names/descriptions still originate from published Skills: treat publishers as a trust boundary, not as trusted system-policy authors simply because text is escaped.
+
+The discovery prompt tells the model to compare snapshot IDs for equality, not chronological order, and to reload content whose version differs. Rollback is handled the same way as forward updates. `catalog_digest` also changes when the authorized file set changes within one snapshot. This is a model-facing fallback, **not a guarantee that old instructions are forgotten**.
+
+## Fixed and dynamic policies
+
+```python
+async with client.bind(consistency="dynamic") as skills:
+    await skills.refresh()  # explicit reconciliation; raises on failure
+    async with skills.snapshot() as batch:
+        body = await batch.read_text("review/SKILL.md")
+        rules = await batch.read_text("review/references/rules.md")
+        original_ref = batch.ref
+```
+
+- Default `pinned`: one snapshot and filtered manifest for the binding. Future channel changes do not change it.
+- Opt-in `dynamic`: reads/discovery reconcile on access after `refresh_interval` (default 5 seconds). `refresh()` forces reconciliation. No background daemon or SSE subscription.
+- An expected-version load forces dynamic reconciliation even before the interval expires. Snapshot or catalog mismatch raises `VersionMismatch`; no silent substitution.
+- A fully verified candidate replaces the active view atomically. Each operation captures one view; different operations can span versions. `snapshot()` captures one view for related operations, even while the enclosing dynamic session updates.
+- Refresh failure aborts that operation and populates `last_refresh_error`; it never silently reports stale discovery as fresh. Later successful refresh clears the error. `transition_count` counts successful view changes.
+- The client default can be overridden per binding. An explicit `source=SnapshotRef` requires pinned mode. Reuse a ref for an explicit retry, subject to current server grants/permissions.
+- `view.ref` in dynamic mode is a point-in-time observation. Use returned `SkillContent.ref` or `batch.ref` for provenance.
+
+Task/attempt IDs are optional correlation fields and auto-generated if absent. Duplicate active IDs are rejected **within one client**. There is no durable attempt store, crash resume or cross-process exactly-once guarantee in v0.1. Persist refs in your application's own storage for explicit pinned retries. A ref does not grant access and cannot bypass a new credential's permissions.
+
+## Pydantic AI integration
+
+```python
+from pydantic_ai import Agent
+from pydantic_ai.capabilities import Caching
+from skiva_sdk import SkillSession
+from skiva_sdk.integrations.pydantic_ai import SkivaSkills
+
+agent = Agent(
+    model,  # Supply your configured Pydantic AI model/provider.
+    name="skiva-agent",
+    deps_type=SkillSession,
+    capabilities=[Caching(), SkivaSkills()],
+)
+
+async with agent:
+    async with client.bind(consistency="dynamic") as skills:
+        result = await agent.run("Review this change", deps=skills)
+```
+
+`SkivaSkills` provides a named, dynamic discovery instruction part with **rewrite** semantics, evaluated before **every model request**. It explicitly refreshes the session at each request, bypassing the normal polling interval. It also registers `load_skill` and `read_skill_file`, requiring both expected version fields. Version mismatch/not-found become structured tool results; authorization/network failures abort rather than encourage stale fallback. It does not rewrite historical tool returns or erase derived conclusions. Provider wire placement of instructions depends on Pydantic AI and the provider.
+
+Keep business dependencies with `SkivaSkills(get_session=lambda deps: deps.skills)`. Each run must receive its own session; the capability has no mutable run state. Attach one SkivaSkills capability per Agent (tool names are fixed). This is a dedicated discovery/tool integration, **not** a replacement for the native Harness `Skills` workspace backend. Shell/direct filesystem access is not intercepted. Configure application tracing in the host application; the SDK exports no prompts/tokens to an external telemetry service.
+
+An active binding owns both discovery and reads. A pinned binding intentionally advertises its pinned catalog; select dynamic to follow updates within a run. Instructions are not modified while a model request is in flight. Header changes can affect prompt caching.
+
+## Real files when necessary
+
+```python
+async with skills.snapshot() as batch:
+    async with batch.materialize() as directory:
+        # Give this path to a framework or awaited subprocess.
+        # The child process must finish before leaving this block.
+        print(directory)
+```
+
+This exports a complete private copy into a temporary directory, preserving read/execute modes. It does not create a FUSE mount or writable hardlinks to shared objects. It rejects paths incompatible with supported platforms, including case-folding collisions. Cleanup occurs on exit. File modes are not sandbox isolation against the owning process. **Direct reads of exported files bypass SDK authorization; revocation cannot recall exported bytes.** New snapshots require new exports, never rewriting an old directory.
+
+## Validation, authorization and limits
+
+Every snapshot is fully downloaded and validated before publication: Go-compatible manifest canonicalization, SHA-256, sizes, paths and modes. Cache is in memory and private to each view/client; no shared disk/offline cache. Default limits: 10,000 files, 8 MiB per file/manifest, 64 MiB per snapshot, 256 KiB per SKILL.md parsing input. Concurrent/retained views multiply memory use; applications should limit concurrency and release references.
+
+Every public read/catalog/export rechecks the explicit snapshot manifest online, even for cached bytes. Changed permissions invalidate a captured view; explicit credential revocation is sticky for that client instance. Network failure blocks the operation. No offline mode, transparent network retries, or model-task retries. An authorization race after the final check and previously delivered content cannot be undone. HTTP redirects are not followed; bearer tokens are not included in SDK error messages. Raw transport instrumentation can still expose credentials; configure logging accordingly. Environment proxy/CA settings are ignored by default (`trust_env=False`); opt in explicitly with `trust_env=True` if needed, and install `httpx[socks]` for SOCKS proxies. A custom HTTPX transport can supply application TLS/proxy settings.
+
+Useful errors: `VersionMismatch`, `ManifestChanged`, `AuthorizationDenied`, `IntegrityError`, `ProtocolError`, `LimitExceeded`, `SkillNotFound`, `TransportError`, `ClosedError`.
+
+## Development and verification
+
+```bash
+uv sync --extra dev --extra pydantic-ai
+uv run pytest -q
+uv run ruff check src tests examples
+uv run python -m build
+uv run python examples/offline_demo.py
+```
+
+Tests use a controlled distribution fixture and Pydantic's actual `FunctionModel` agent loop, without external model calls. They cover updates/rollback, same-snapshot permission changes, concurrent reads/runs, old-content provenance, corruption, export isolation, and Go-generated manifest fixtures. The offline demo requires no server or credentials. It is not a substitute for deployment acceptance against your Skiva server and selected model provider.
+
+See [examples/](https://github.com/LingHeChen/skiva-python/tree/main/examples/) and [CHANGELOG.md](https://github.com/LingHeChen/skiva-python/blob/main/CHANGELOG.md). Official integration references: [Pydantic capabilities](https://pydantic.dev/docs/ai/capabilities/custom/), [Agent Skills implementation guide](https://agentskills.io/client-implementation/adding-skills-support).
+
+Detailed scenarios and recorded results: [Testing guide](https://github.com/LingHeChen/skiva-python/blob/main/docs/TESTING.md).