ktables 0.1.0__tar.gz

ktables-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # OIDC for PyPI trusted publishing — no API token needed
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Build sdist and wheel
+        run: uv build
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

ktables-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,17 @@
+name: Release Please
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          release-type: python

ktables-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Run unit tests (integration auto-skips without a broker)
+        run: uv run --python ${{ matrix.python-version }} pytest -rs
+
+  integration:
+    runs-on: ubuntu-latest
+    services:
+      kafka:
+        image: apache/kafka:3.9.0
+        ports:
+          - 9092:9092
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Wait for Kafka
+        run: |
+          for i in $(seq 1 30); do
+            (echo > /dev/tcp/localhost/9092) 2>/dev/null && exit 0
+            sleep 2
+          done
+          echo "Kafka did not become reachable" >&2
+          exit 1
+      - name: Run full suite against the broker
+        run: uv run --python 3.12 pytest -rs

ktables-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

ktables-0.1.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (2026-06-10)
+
+
+### Features
+
+* KafkaTable and KafkaTableWriter — a GlobalKTable for asyncio Python ([#1](https://github.com/ryan-yuuu/ktables/issues/1)) ([4a2b0b9](https://github.com/ryan-yuuu/ktables/commit/4a2b0b9ecfea398d6c8bdcfcfba23f828c1566b0))

ktables-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ktables-0.1.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: ktables
+Version: 0.1.0
+Summary: Materialize a Kafka topic into an in-memory, compacted dict — a GlobalKTable for asyncio Python.
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: aiokafka>=0.10
+Description-Content-Type: text/markdown
+
+# ktables
+
+[![Tests](https://github.com/ryan-yuuu/ktables/actions/workflows/test.yml/badge.svg)](https://github.com/ryan-yuuu/ktables/actions/workflows/test.yml)
+![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+Materialize a Kafka topic into an in-memory, compacted dict — a GlobalKTable for asyncio Python.
+
+Every process that opens a `KafkaTable` replays the topic from the beginning
+into a local read-only mapping, then keeps consuming for live updates; a
+`KafkaTableWriter` maintains the topic with keyed upserts and tombstones.
+Built for small, broadly-needed reference data — service registries,
+capability advertisements, feature flags, config maps — not for large or
+high-churn state.
+
+## Table of Contents
+
+- [Background](#background)
+- [Install](#install)
+- [Usage](#usage)
+- [Consistency contract](#consistency-contract)
+- [API](#api)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Background
+
+Kafka Streams (JVM) has two table abstractions over changelog topics: the
+partition-sharded `KTable`, where each application instance holds a slice of
+the keys, and `GlobalKTable`, where every instance bootstraps and maintains a
+full local copy — the right shape for lookup data that any instance may need
+at any moment. The Python ecosystem has several maintained stream-processing
+frameworks, but all of them implement only the sharded shape, with
+framework-owned changelog topics and their own process runtimes. ktables fills
+the gap with just the global-table piece, as a plain asyncio library over
+`aiokafka`: your topic, your message format, your event loop.
+
+The Kafka semantics the implementation relies on (group-less consumers,
+catch-up gating against end offsets, compaction independence) are documented,
+with provenance, in the module docstring of
+[`kafka_table.py`](./ktables/kafka_table.py).
+
+## Install
+
+ktables is not yet published to PyPI. Until the first release, vendor the
+package — copy the `ktables/` directory into your project — and install its
+single runtime dependency:
+
+```sh
+$ pip install aiokafka
+```
+
+Requires Python 3.10+. Pydantic is **not** required — the `.json()` presets
+accept any class with pydantic-v2's JSON methods.
+
+## Usage
+
+Maintain a registry from one service:
+
+```python
+from ktables import KafkaTableWriter
+
+writer = KafkaTableWriter.json(
+    bootstrap_servers="localhost:9092", topic="my.registry", model=ServiceRecord
+)
+async with writer:
+    await writer.set("billing", record)      # upsert (broker-acked)
+    ...
+    await writer.delete("billing")           # tombstone: removes the key
+```
+
+Consume it from any other process:
+
+```python
+from ktables import KafkaTable
+
+table = KafkaTable.json(
+    bootstrap_servers="localhost:9092", topic="my.registry", model=ServiceRecord
+)
+async with table:               # replays the topic; returns once caught up
+    record = table.get("billing")
+    if table.status != "caught_up":   # "degraded": catch-up timed out
+        ...
+```
+
+Non-pydantic payloads: construct directly with your own codecs —
+`KafkaTable(..., value_decoder=bytes_to_value)` /
+`KafkaTableWriter(..., value_encoder=value_to_bytes)`.
+
+### Removing a key on clean shutdown
+
+There is deliberately no `delete_on_close` option (shutdown-time deletion is
+application policy, and no library can promise it on a crash). Compose it:
+
+```python
+async with writer:
+    await writer.set(my_key, my_record)
+    try:
+        ...  # serve
+    finally:
+        await writer.delete(my_key)   # acked before the producer stops
+```
+
+### Locked-down clusters
+
+Both classes ensure their topic exists at start (idempotent create,
+compacted). If the application lacks topic-create ACLs, pass
+`ensure_topic=False` and create the topic out-of-band (the module-level
+`ensure_topic()` function is the deploy-time primitive).
+
+## Consistency contract
+
+`KafkaTable` is eventually consistent. Precisely:
+
+1. When `start()` / `async with` returns, contents are complete as of the
+   topic's end offsets at start time — unless `status == "degraded"`
+   (catch-up timed out; data may be partial).
+2. Thereafter, updates appear within milliseconds of the broker write — but
+   **there is no read-your-own-writes**: after `await writer.set(k, v)`, a
+   table in the same process may briefly still return the old value.
+3. Contents are stable between your awaits (single event loop; only the
+   reader task mutates). Use `snapshot()` for a copy held across awaits.
+4. Correctness does not depend on broker-side compaction: last-write-wins
+   over the full log yields the same dict; compaction only bounds replay time.
+
+A tombstone is a record with a **null** value (`b""` is data, not a tombstone).
+If the background reader dies (non-retriable error, e.g. authorization),
+contents freeze at the last applied state: `status` becomes `"failed"` and
+`failure` holds the exception — gate liveness decisions on `status`, never on
+reads alone. Transient broker outages do not kill the reader; it resumes.
+
+## API
+
+### `KafkaTable[V]` — read-only `Mapping[str, V]`
+
+| Member | Description |
+|---|---|
+| `KafkaTable(*, bootstrap_servers, topic, value_decoder, key_decoder=utf-8, catchup_timeout=30.0, poll_timeout_ms=200, ensure_topic=True, topic_configs=None)` | Construct (does not connect). |
+| `KafkaTable.json(*, bootstrap_servers, topic, model, **kwargs)` | Preset wiring `model.model_validate_json` as the decoder. |
+| `start()` / `stop()` / `async with` | Lifecycle. `start()` raises on double-start, missing topic, or reader death during catch-up; on catch-up *timeout* it serves degraded. |
+| `table[key]`, `key in table`, `iter`, `len`, `.get(key, default=None)` | Mapping reads. Raise `RuntimeError` before `start()`. |
+| `snapshot()` | Shallow-copy dict, safe to hold across awaits. |
+| `status` | `"unstarted" \| "loading" \| "caught_up" \| "degraded" \| "failed"`. |
+| `failure` | Exception that killed the reader, else `None`. |
+| `is_caught_up` / `wait_until_caught_up(timeout=None)` | Catch-up gate; the wait returns `False` on timeout or reader death. |
+| `stats` | Frozen `ViewStats` snapshot (see below). |
+
+Equality is **identity** and instances are hashable: a running table is a
+resource handle, not a value.
+
+### `KafkaTableWriter[V]`
+
+| Member | Description |
+|---|---|
+| `KafkaTableWriter(*, bootstrap_servers, topic, value_encoder, key_encoder=utf-8, ensure_topic=True, topic_configs=None, enable_idempotence=True)` | Construct. Idempotence implies `acks=all` (registry-grade durability); opt out for throwaway data. |
+| `KafkaTableWriter.json(*, bootstrap_servers, topic, model=None, **kwargs)` | Preset encoding via `model_dump_json()` (`model` is typing-only). |
+| `set(key, value)` | Keyed upsert; awaits broker ack. Re-`set` periodically as a heartbeat. |
+| `delete(key)` | Publishes a null-value tombstone; awaits broker ack. |
+| `start()` / `stop()` / `async with` | Lifecycle; `set`/`delete` before start raise `RuntimeError`. |
+
+The key encoder must be deterministic and stable across processes — on a
+multi-partition topic, per-key ordering holds only if a key always hashes to
+the same partition.
+
+### Module level
+
+| Member | Description |
+|---|---|
+| `ensure_topic(bootstrap_servers, topic, *, num_partitions=1, replication_factor=1, topic_configs=None) -> bool` | Idempotent explicit create; `True` if this call created it. Defaults are dev-grade — production registries want RF≥3, `min.insync.replicas=2`, `acks=all`. |
+| `DEFAULT_TOPIC_CONFIGS` | `{"cleanup.policy": "compact"}` (read-only mapping). |
+| `ViewStats` | Frozen counters: `records_applied`, `tombstones_applied`, `keyless_records`, `key_decode_errors`, `value_decode_errors`, `catch_up_seconds`, `replayed_at_catch_up`. |
+| `SupportsJsonModel` | Protocol the `.json()` presets require (`model_dump_json` / `model_validate_json`). |
+| `TableStatus` | The `status` literal type. |
+
+## Contributing
+
+Questions and bug reports are welcome as issues, and PRs are accepted. Please
+run the test suite before submitting:
+
+```sh
+$ pytest tests
+```
+
+Unit tests always run; integration tests need a Kafka broker on
+`localhost:9092` and skip otherwise
+(`docker run -d -p 9092:9092 apache/kafka:3.9.0`).
+
+## License
+
+[MIT](LICENSE)