antfly-sdk 0.0.2.dev2__tar.gz → 0.2.1__tar.gz

antfly_sdk-0.2.1/.openapi-generator-config.yaml

@@ -0,0 +1,10 @@
+project_name_override: antfly
+package_name_override: client_generated
+package_version_override: 0.0.1
+content_type_overrides:
+  # Treat the envelope as bytes while retaining its declared wire Content-Type.
+  application/vnd.antfly.attachments.v1: application/octet-stream
+  application/x-ndjson: application/octet-stream
+  audio/mpeg: application/octet-stream
+  audio/wav: application/octet-stream
+post_hooks: []

antfly_sdk-0.2.1/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 2026 Antfly Contributors
+
+   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.

antfly_sdk-0.2.1/Makefile

@@ -0,0 +1,37 @@
+.PHONY: generate check-generated check-generation-completeness clean install test build publish docs fmt check update-deps
+
+generate:
+	uv run python generate_client.py
+
+check-generated:
+	uv run python generate_client.py --check
+
+check-generation-completeness: check-generated
+
+clean:
+	rm -rf build dist *.egg-info
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete
+
+install:
+	uv sync
+
+test:
+	uv run pytest tests --cov=antfly --cov-report=xml
+
+build: clean generate
+	uv build
+
+publish: build
+	uv publish
+
+docs:
+	cd docs && make html
+
+check:
+	uv run ruff check src tests --fix
+	uv run ruff format src tests --fix
+	uv run pyright src tests
+
+update-deps:
+	uv lock --upgrade && uv sync

antfly_sdk-0.2.1/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.5
+Name: antfly-sdk
+Version: 0.2.1
+Summary: Python SDK for Antfly distributed key-value store and search engine
+Project-URL: Homepage, https://github.com/antflydb/antfly-py
+Project-URL: Documentation, https://antfly-sdk-python.readthedocs.io
+Project-URL: Repository, https://github.com/antflydb/antfly-py
+Project-URL: Issues, https://github.com/antflydb/antfly-py/issues
+Author-email: "Antfly, Inc." <ajroetker@antfly.io>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: antfly,database,distributed,key-value,search
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29.0,>=0.23.0
+Requires-Dist: python-dateutil<3.0.0,>=2.8.0
+Description-Content-Type: text/markdown
+
+# Antfly Python SDK
+
+[![PyPI version](https://badge.fury.io/py/antfly-sdk.svg)](https://badge.fury.io/py/antfly-sdk)
+[![Python](https://img.shields.io/pypi/pyversions/antfly.svg)](https://pypi.org/project/antfly-sdk/)
+
+Python SDK for [Antfly](https://github.com/antflydb/antfly) - a distributed key-value store and search engine.
+
+Supported Python versions: 3.11 through 3.14.
+
+The examples here target the pinned development source below. The inspected
+PyPI `0.0.2.dev2` wheel lacks `AntflyClient.query`; TestPyPI `0.0.1` has `query`
+but lacks current read-requirement helpers and media chunking. TestPyPI is not a
+fallback for this API surface (package contents checked 2026-10-22).
+
+## Installation
+
+```bash
+pip install "antfly-sdk @ git+https://github.com/antflydb/antfly.git@ddba6584b38b59c62e261ef63e0374dc1f711617#subdirectory=py/packages/sdk"
+```
+
+## Quick Start
+
+```python
+from antfly import AntflyClient
+
+# Initialize client
+client = AntflyClient(
+    base_url="http://localhost:8080",
+    username="admin",
+    password="password"
+)
+
+# Create a table
+client.create_table(
+    name="users",
+    num_shards=4,
+    schema={
+        "default_type": "user",
+        "document_schemas": {
+            "user": {
+                "schema": {
+                    "type": "object",
+                    "properties": {
+                        "name": {"type": "string"},
+                        "email": {"type": "string"},
+                        "age": {"type": "integer"},
+                        "created_at": {"type": "string", "format": "date-time"}
+                    }
+                }
+            }
+        }
+    }
+)
+
+# Insert data
+client.batch(
+    table="users",
+    inserts={
+        "user:1": {
+            "name": "John Doe",
+            "email": "john@example.com",
+            "age": 30
+        },
+        "user:2": {
+            "name": "Jane Smith",
+            "email": "jane@example.com",
+            "age": 25
+        }
+    }
+)
+
+# Query data
+results = client.query(
+    table="users",
+    full_text_search={"query": "John"},
+    limit=10
+)
+
+# Get specific record
+user = client.get(table="users", key="user:1")
+```
+
+## Features
+
+- **Simple API**: Intuitive interface for all Antfly operations
+- **Type Safety**: Full type hints for better IDE support
+- **Authentication**: Built-in support for basic authentication
+- **Error Handling**: Comprehensive error handling with custom exceptions
+- **Auto-generated Client**: Based on OpenAPI specification for accuracy
+
+## Native KV checkpoints
+
+The native Gemma 4 E4B CUDA route can export a binary checkpoint and resume it
+with the same model revision, tokenizer, template, and KV layout. The streaming
+helpers keep checkpoint transfers out of Python's full-response buffers and
+publish a downloaded file only after integrity checks succeed.
+
+FP16, FP8 and rotated4 checkpoints passed the bounded E4B Q4_0/L4/eager-CUDA
+production qualification at 8K and 32K. The
+[qualification record](../../../docs/design/inference/native-kv-compaction.md#bounded-qualification-2026-10-23)
+documents the tested model revision, answer-quality coverage and latency limits.
+
+Configure the serving runtime and inference memory budgets using the
+[native checkpoint serving guide](../../../zig/pkg/inference/OPENAI.md#portable-native-kv-checkpoints).
+The default scratch budget is insufficient for preparation.
+
+```python
+from pathlib import Path
+from antfly import AntflyClient
+from antfly.client_generated.models import InferenceGenerateRequest
+
+client = AntflyClient("http://localhost:8080", timeout=1800)
+request = InferenceGenerateRequest.from_dict({
+    "model": "google/gemma-4-E4B-it-qat-q4_0-gguf",
+    "messages": [{"role": "user", "content": Path("history.txt").read_text()}],
+    "max_tokens": 64,
+    "temperature": 0,
+    "chat_template_kwargs": {"enable_thinking": False},
+})
+checkpoint = client.prepare_native_kv_checkpoint(request, "history.kv")  # lossless f16 storage
+# Optional fitted-history FP8 disk encoding with validated f16 fallback:
+# checkpoint = client.prepare_native_kv_checkpoint(request, "history-fp8.kv", encoding="fp8")
+# Optional V4 compressed CUDA state; no experimental process switch required:
+# checkpoint = client.prepare_native_kv_checkpoint(request, "history-rotated4.kv", encoding="rotated4")
+# Use encoding="f32" for legacy V2 readers.
+print(checkpoint.metadata["outcome"], checkpoint.metadata["global_savings_ratio"])
+
+# The server can be restarted before this call, using the same model revision.
+result = client.resume_native_kv_checkpoint(request, "history.kv")
+print(result.choices[0].message.content)
+```
+
+Preparation generates no answer. `unchanged_insufficient_savings` means the file
+contains the exact original cache because fitting did not meet the savings
+threshold. Resume requests supply the full messages; their rendered tokens must
+extend the saved prefix exactly. A different model revision or rewritten prefix
+is rejected. `resume_native_kv_checkpoint_stream` is a context manager yielding
+SSE chunks; exiting its context closes both the upload file and response. Set
+the client timeout to cover original prompt ingestion and compaction.
+
+## Development
+
+### Setup
+
+1. Clone the repository
+2. Install development dependencies:
+
+```bash
+uv sync
+```
+
+
+### Generate Client
+
+The SDK uses an auto-generated client based on the Antfly OpenAPI specification:
+
+```bash
+make generate
+```
+
+Run `make check-generation-completeness` to fail on any endpoint or schema the generator omits.
+The normal generation target remains available while existing upstream incompatibilities are resolved.
+
+### Run Tests
+
+```bash
+make test
+```
+
+### Build Package
+
+```bash
+make build
+```
+
+## Documentation
+
+`make docs` will generate the documentation in the `docs/` folder.
+
+
+## License
+
+Apache License 2.0
+
+## Warning
+
+The strict completeness check currently reports models that
+[cannot be autogenerated from the spec](https://github.com/openapi-generators/openapi-python-client/issues/1123).
+
+## Model-aware media chunks
+
+`client.chunk_and_embed` accepts text, PDF, images, GIF, audio and video and
+returns typed descriptor/vector pairs:
+
+```python
+response = client.chunk_and_embed({
+    "input": "A long document…",
+    "embedding": {"model": "embeddinggemma2", "task_type": "RETRIEVAL_DOCUMENT"},
+    "policy": {"target_tokens": 500, "overlap_tokens": 50},
+    "include_content": True,
+})
+for chunk in response.data:
+    print(chunk.descriptor.coordinates, chunk.embedding)
+```
+
+Check `status`, `gaps` and `next_continuation` before declaring complete coverage.
+Resume with the same request plus `continuation`. For bounded delivery, use
+`with client.chunk_and_embed_stream(request) as events:` and consume start
+context, chunk objects and the final response. Exiting the context closes the
+connection; EOF without terminal coverage raises. Retain the start context's
+model identity with vectors. Set `embedding.execute` to `False` for planning only.
+Inline media uses `{"type": "media", "mime_type": ..., "data": ...}` with base64
+data; immutable HTTP/S3 sources use a version-pinned source reference. See the
+[shared contract](../../../docs/plans/model-aware-media-chunking.md) for policies,
+security, limits and database integration.
+
+### Reliable writes and cursor reads (0.2.1)
+
+`batch(..., sync_level="full_index")` returns a typed `BatchResponse`. Inspect
+`status`: `committed_pending` has not established requested visibility, while
+`committed_repair_required` means the document committed but materialization
+needs repair. Do not replay a committed mutation to repair indexing. Timeouts
+can have unknown commit outcomes; this client does not automatically retry them.
+Atomic `transforms` are accepted as a list of mappings.
+
+Lookup raises `AntflyNotFoundError` only for HTTP 404; other HTTP errors retain
+`status_code` on `AntflyHTTPError`. `get(..., fields=["_embeddings"])` reads
+persisted vectors, and `get_with_version()` returns the document and exact OCC
+version token. Ordered pagination must replay the response's `remote_snapshot`
+alongside `search_after`; `query()` exposes both.
+
+`embed()`, `rerank()`, and `models()` provide bounded public inference JSON
+access. `request()` is the public authenticated transport for other `/db/v1/`
+and `/ai/v1/` operations. Use `close()` or a context manager to release the
+client's HTTP pool.