antfly-sdk 0.0.2.dev2__tar.gz

antfly_sdk-0.0.2.dev2/.gitignore

@@ -0,0 +1,27 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# venv
+.venv/
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage
+.aider*

antfly_sdk-0.0.2.dev2/.goreleaser.yaml

@@ -0,0 +1,9 @@
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+version: 2
+builds:
+  - id: wheel
+    builder: uv
+    buildmode: wheel
+  - id: sdist
+    builder: uv
+    buildmode: sdist

antfly_sdk-0.0.2.dev2/.openapi-generator-config.yaml

@@ -0,0 +1,6 @@
+project_name_override: antfly
+package_name_override: client_generated
+package_version_override: 0.0.1
+post_hooks:
+  - "ruff check client_generated --fix"
+  - "ruff format client_generated"

antfly_sdk-0.0.2.dev2/Makefile

@@ -0,0 +1,34 @@
+.PHONY: generate clean install test build publish docs fmt check update-deps
+
+generate:
+	uv run openapi-python-client generate --path ../../../openapi.yaml --output-path src/antfly --overwrite --config .openapi-generator-config.yaml
+	uv run ruff check src/antfly/client_generated --fix
+	uv run ruff format src/antfly/client_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.0.2.dev2/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: antfly-sdk
+Version: 0.0.2.dev2
+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
+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.9
+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.9
+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.svg)](https://badge.fury.io/py/antfly)
+[![Python](https://img.shields.io/pypi/pyversions/antfly.svg)](https://pypi.org/project/antfly/)
+
+Python SDK for [Antfly](https://github.com/antflydb/antfly) - a distributed key-value store and search engine.
+
+For the nightly version, visit the [TestPyPI page](https://test.pypi.org/project/antfly-sdk/).
+
+## Installation
+
+```bash
+pip install antfly-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={
+        "key": "user_id",
+        "document_types": {
+            "user": {
+                "fields": {
+                    "name": {"type": "string"},
+                    "email": {"type": "keyword"},
+                    "age": {"type": "int"},
+                    "created_at": {"type": "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
+
+## 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 Tests
+
+```bash
+make test
+```
+
+### Build Package
+
+```bash
+make build
+```
+
+## Documentation
+
+`make docs` will generate the documentation in the `docs/` folder.
+
+Full documentation is available at [https://antfly-sdk-python.readthedocs.io](https://antfly-sdk-python.readthedocs.io)
+
+## License
+
+Apache License 2.0
+
+## Warning
+
+[Some models cannot be autogenerated from the spec](https://github.com/openapi-generators/openapi-python-client/issues/1123)

antfly_sdk-0.0.2.dev2/README.md

@@ -0,0 +1,127 @@
+# Antfly Python SDK
+
+[![PyPI version](https://badge.fury.io/py/antfly.svg)](https://badge.fury.io/py/antfly)
+[![Python](https://img.shields.io/pypi/pyversions/antfly.svg)](https://pypi.org/project/antfly/)
+
+Python SDK for [Antfly](https://github.com/antflydb/antfly) - a distributed key-value store and search engine.
+
+For the nightly version, visit the [TestPyPI page](https://test.pypi.org/project/antfly-sdk/).
+
+## Installation
+
+```bash
+pip install antfly-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={
+        "key": "user_id",
+        "document_types": {
+            "user": {
+                "fields": {
+                    "name": {"type": "string"},
+                    "email": {"type": "keyword"},
+                    "age": {"type": "int"},
+                    "created_at": {"type": "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
+
+## 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 Tests
+
+```bash
+make test
+```
+
+### Build Package
+
+```bash
+make build
+```
+
+## Documentation
+
+`make docs` will generate the documentation in the `docs/` folder.
+
+Full documentation is available at [https://antfly-sdk-python.readthedocs.io](https://antfly-sdk-python.readthedocs.io)
+
+## License
+
+Apache License 2.0
+
+## Warning
+
+[Some models cannot be autogenerated from the spec](https://github.com/openapi-generators/openapi-python-client/issues/1123)

antfly_sdk-0.0.2.dev2/docs/.gitignore

@@ -0,0 +1 @@
+_build

antfly_sdk-0.0.2.dev2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

antfly_sdk-0.0.2.dev2/docs/api_reference.rst

@@ -0,0 +1,28 @@
+API Reference
+=============
+
+This section provides detailed documentation for all classes and methods in the Antfly SDK.
+
+Main Client
+-----------
+
+.. automodule:: antfly.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Exceptions
+----------
+
+.. automodule:: antfly.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Full Module Reference
+---------------------
+
+.. automodule:: antfly
+   :members:
+   :undoc-members:
+   :show-inheritance:

antfly_sdk-0.0.2.dev2/docs/conf.py

@@ -0,0 +1,74 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+from pathlib import Path
+
+# Set environment variable to indicate we're building docs
+os.environ['SPHINX_BUILD'] = 'true'
+
+# Add source directory to path for autodoc
+sys.path.insert(0, str(Path(__file__).parent.parent / 'src'))
+
+# Also add the generated client to path
+sys.path.insert(0, str(Path(__file__).parent.parent / 'antfly-sdk'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'antfly-sdk'
+copyright = '2025, ajroetker@antfly.io'
+author = 'ajroetker@antfly.io'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autodoc.typehints',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
+]
+
+# Mock imports that might not be available during docs build
+autodoc_mock_imports = [
+    'httpx',
+    'attrs',
+    'antfly.client_generated',
+    'antfly.client_generated.api',
+    'antfly.client_generated.api.table_management',
+    'antfly.client_generated.api.index_management',
+    'antfly.client_generated.models',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# Autodoc settings
+autodoc_default_options = {
+    'members': True,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': True,
+    'exclude-members': '__weakref__'
+}
+
+# Napoleon settings for Google/NumPy style docstrings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+
+# Intersphinx mapping for linking to other project docs
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+}
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

antfly_sdk-0.0.2.dev2/docs/examples.rst

@@ -0,0 +1 @@
+Examples

antfly_sdk-0.0.2.dev2/docs/index.rst

@@ -0,0 +1,72 @@
+.. antfly-sdk documentation master file
+
+Welcome to Antfly SDK Documentation
+====================================
+
+The Antfly SDK is a Python client library for interacting with the Antfly database system - a distributed key-value store with powerful search capabilities.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   quickstart
+   api_reference
+   examples
+
+Features
+--------
+
+* **Simple, intuitive API** for database operations
+* **Support for authenticated and unauthenticated** connections
+* **Full-text and semantic search** capabilities
+* **Batch operations** for efficient data manipulation
+* **Type-safe operations** with Python type hints
+* **Comprehensive error handling** with specific exception types
+
+Quick Example
+-------------
+
+.. code-block:: python
+
+   from antfly import AntflyClient
+
+   # Create a client
+   client = AntflyClient(
+       base_url="http://localhost:8080",
+       username="admin",
+       password="password"
+   )
+
+   # Create a table
+   table = client.create_table(
+       name="users",
+       num_shards=2
+   )
+
+   # Insert data
+   client.batch(
+       table="users",
+       inserts={
+           "user:1": {"name": "Alice", "age": 30},
+           "user:2": {"name": "Bob", "age": 25}
+       }
+   )
+
+   # Query data
+   results = client.query(
+       table="users",
+       full_text_search={"query": "Alice"}
+   )
+
+   # Get a specific record
+   user = client.get(table="users", key="user:1")
+   print(user["name"])  # Output: Alice
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

antfly_sdk-0.0.2.dev2/docs/installation.rst

@@ -0,0 +1,65 @@
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.9 or higher
+* pip package manager
+
+Install from PyPI
+-----------------
+
+The easiest way to install the Antfly SDK is using pip:
+
+.. code-block:: bash
+
+   pip install antfly-sdk
+
+Install from Source
+-------------------
+
+To install from source, clone the repository and install in development mode:
+
+.. code-block:: bash
+
+   git clone https://github.com/yourusername/antfly-sdk.git
+   cd antfly-sdk
+   pip install -e .
+
+Development Installation
+------------------------
+
+For development, install with additional dependencies:
+
+.. code-block:: bash
+
+   pip install -e .[dev]
+
+This will install:
+
+* pytest for testing
+* black and ruff for code formatting and linting
+* mypy for type checking
+* sphinx for documentation
+
+Generating the Client
+---------------------
+
+The SDK uses an auto-generated client based on the Antfly OpenAPI specification. To regenerate the client:
+
+.. code-block:: bash
+
+   make generate
+
+This requires the ``openapi-python-client`` package to be installed.
+
+Verifying Installation
+----------------------
+
+To verify the installation:
+
+.. code-block:: python
+
+   import antfly
+   print(antfly.__version__)

antfly_sdk-0.0.2.dev2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd