lnc-client 0.1.0__tar.gz

lnc_client-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# 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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

lnc_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nitecon
+
+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.

lnc_client-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: lnc-client
+Version: 0.1.0
+Summary: Python client for the Lance Wire Protocol (LWP) — high-performance, low-latency data streaming
+Project-URL: Homepage, https://github.com/nitecon/lnc-client-py
+Project-URL: Documentation, https://github.com/nitecon/lnc-client-py#readme
+Project-URL: Issues, https://github.com/nitecon/lnc-client-py/issues
+Author-email: Will Hattingh <nitecon@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Nitecon
+        
+        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.
+License-File: LICENSE
+Keywords: data-ingestion,high-performance,lance,lwp,streaming
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Requires-Dist: crc32c>=2.7
+Requires-Dist: lz4>=4.3
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.3; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# lnc-client
+
+[![PyPI version](https://img.shields.io/pypi/v/lnc-client.svg)](https://pypi.org/project/lnc-client/)
+[![Python](https://img.shields.io/pypi/pyversions/lnc-client.svg)](https://pypi.org/project/lnc-client/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Python client for the **Lance Wire Protocol (LWP)** — high-performance, low-latency data streaming.
+
+[Lance](https://github.com/nitecon/lance) is an io\_uring-based streaming server designed to saturate 100G NICs with minimal latency. This client implements the full LWP binary protocol for Python applications.
+
+## Installation
+
+```bash
+pip install lnc-client
+```
+
+**Requirements:** Python 3.10+
+
+## Quick Start
+
+### Producer
+
+```python
+import asyncio
+from lnc_client import Producer, ProducerConfig
+
+async def main():
+    producer = await Producer.connect("localhost:1992", ProducerConfig())
+
+    # Send with ACK (guaranteed delivery)
+    batch_id = await producer.send(topic_id=1, data=b'{"price": 6942.25}')
+
+    # Send without waiting for ACK (pipelined, higher throughput)
+    batch_id = await producer.send_async(topic_id=1, data=b'fire and forget')
+
+    await producer.close()
+
+asyncio.run(main())
+```
+
+### Consumer
+
+```python
+import asyncio
+from lnc_client import StandaloneConsumer, StandaloneConfig
+
+async def main():
+    consumer = await StandaloneConsumer.connect(
+        "localhost:1992",
+        StandaloneConfig(consumer_name="my-app", topic_id=1),
+    )
+
+    while True:
+        result = await consumer.poll()
+        if result is None:
+            await asyncio.sleep(0.05)
+            continue
+
+        for record in result.records:
+            print(f"Type={record.record_type}, Data={record.value}")
+
+        print(f"Lag: {result.lag} bytes")
+
+asyncio.run(main())
+```
+
+### Topic Management
+
+```python
+import asyncio
+from lnc_client import LanceClient, ClientConfig
+
+async def main():
+    async with LanceClient(ClientConfig(host="localhost")) as client:
+        topics = await client.list_topics()
+
+        topic = await client.create_topic("my-events")
+
+        # Create with retention (7-day, 1GB max)
+        topic = await client.create_topic_with_retention(
+            "logs", max_age_secs=7*86400, max_bytes=1024**3
+        )
+
+        await client.set_retention(topic["id"], max_age_secs=86400)
+
+asyncio.run(main())
+```
+
+## Configuration
+
+### ProducerConfig
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `batch_size` | `32768` | Max batch size in bytes |
+| `linger_ms` | `5` | Max wait before sending partial batch |
+| `compression` | `False` | Enable LZ4 compression |
+| `max_pending_acks` | `64` | Max unacknowledged batches |
+
+### StandaloneConfig
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `consumer_name` | `""` | Consumer identifier |
+| `topic_id` | `0` | Topic to consume from |
+| `max_fetch_bytes` | `65536` | Max bytes per fetch |
+| `start_offset` | `0` | Initial byte offset |
+| `poll_interval_ms` | `50` | Polling interval when idle |
+
+### ClientConfig
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `host` | `"localhost"` | Lance server hostname |
+| `port` | `1992` | Lance server port |
+
+## TLV Record Types
+
+Records use Type-Length-Value encoding:
+
+| Type | Code | Description |
+|------|------|-------------|
+| RawData | `0x01` | Unstructured binary |
+| JSON | `0x02` | JSON-encoded record |
+| MessagePack | `0x03` | MessagePack-encoded |
+| KeyValue | `0x10` | Key-value pair |
+| Timestamped | `0x11` | Timestamp + data |
+| Null | `0xFF` | Tombstone/empty |
+
+## Error Handling
+
+```python
+from lnc_client import (
+    LanceError,
+    ConnectionError,
+    BackpressureError,
+    TopicNotFoundError,
+    InvalidFrameError,
+)
+
+try:
+    await producer.send(topic_id=99, data=b"test")
+except TopicNotFoundError:
+    print("Topic doesn't exist")
+except BackpressureError:
+    print("Server is overloaded, slow down")
+except ConnectionError:
+    print("Connection lost")
+```
+
+## Protocol Details
+
+This client implements the [Lance Wire Protocol (LWP)](https://github.com/nitecon/lance) v1.0:
+
+- **44-byte fixed header** with CRC32C validation
+- **Hardware-accelerated checksums** (SSE4.2 / ARM CRC)
+- **Backpressure signaling** from server
+- **Keepalive** with 30-second timeout
+- **Batched production** with ACK tracking
+- **Offset-based consumption** with seek/rewind
+- **LZ4 compression** (optional, per-batch)
+- **Reconnection** with exponential backoff (100ms base, 30s max, jitter)
+
+## Development
+
+```bash
+git clone https://github.com/nitecon/lnc-client-py.git
+cd lnc-client-py
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest -v
+```
+
+39 tests covering protocol parsing, CRC32C validation, TLV encoding/decoding, and frame builders.
+
+## License
+
+[MIT](LICENSE)

lnc_client-0.1.0/README.md

@@ -0,0 +1,179 @@
+# lnc-client
+
+[![PyPI version](https://img.shields.io/pypi/v/lnc-client.svg)](https://pypi.org/project/lnc-client/)
+[![Python](https://img.shields.io/pypi/pyversions/lnc-client.svg)](https://pypi.org/project/lnc-client/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Python client for the **Lance Wire Protocol (LWP)** — high-performance, low-latency data streaming.
+
+[Lance](https://github.com/nitecon/lance) is an io\_uring-based streaming server designed to saturate 100G NICs with minimal latency. This client implements the full LWP binary protocol for Python applications.
+
+## Installation
+
+```bash
+pip install lnc-client
+```
+
+**Requirements:** Python 3.10+
+
+## Quick Start
+
+### Producer
+
+```python
+import asyncio
+from lnc_client import Producer, ProducerConfig
+
+async def main():
+    producer = await Producer.connect("localhost:1992", ProducerConfig())
+
+    # Send with ACK (guaranteed delivery)
+    batch_id = await producer.send(topic_id=1, data=b'{"price": 6942.25}')
+
+    # Send without waiting for ACK (pipelined, higher throughput)
+    batch_id = await producer.send_async(topic_id=1, data=b'fire and forget')
+
+    await producer.close()
+
+asyncio.run(main())
+```
+
+### Consumer
+
+```python
+import asyncio
+from lnc_client import StandaloneConsumer, StandaloneConfig
+
+async def main():
+    consumer = await StandaloneConsumer.connect(
+        "localhost:1992",
+        StandaloneConfig(consumer_name="my-app", topic_id=1),
+    )
+
+    while True:
+        result = await consumer.poll()
+        if result is None:
+            await asyncio.sleep(0.05)
+            continue
+
+        for record in result.records:
+            print(f"Type={record.record_type}, Data={record.value}")
+
+        print(f"Lag: {result.lag} bytes")
+
+asyncio.run(main())
+```
+
+### Topic Management
+
+```python
+import asyncio
+from lnc_client import LanceClient, ClientConfig
+
+async def main():
+    async with LanceClient(ClientConfig(host="localhost")) as client:
+        topics = await client.list_topics()
+
+        topic = await client.create_topic("my-events")
+
+        # Create with retention (7-day, 1GB max)
+        topic = await client.create_topic_with_retention(
+            "logs", max_age_secs=7*86400, max_bytes=1024**3
+        )
+
+        await client.set_retention(topic["id"], max_age_secs=86400)
+
+asyncio.run(main())
+```
+
+## Configuration
+
+### ProducerConfig
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `batch_size` | `32768` | Max batch size in bytes |
+| `linger_ms` | `5` | Max wait before sending partial batch |
+| `compression` | `False` | Enable LZ4 compression |
+| `max_pending_acks` | `64` | Max unacknowledged batches |
+
+### StandaloneConfig
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `consumer_name` | `""` | Consumer identifier |
+| `topic_id` | `0` | Topic to consume from |
+| `max_fetch_bytes` | `65536` | Max bytes per fetch |
+| `start_offset` | `0` | Initial byte offset |
+| `poll_interval_ms` | `50` | Polling interval when idle |
+
+### ClientConfig
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `host` | `"localhost"` | Lance server hostname |
+| `port` | `1992` | Lance server port |
+
+## TLV Record Types
+
+Records use Type-Length-Value encoding:
+
+| Type | Code | Description |
+|------|------|-------------|
+| RawData | `0x01` | Unstructured binary |
+| JSON | `0x02` | JSON-encoded record |
+| MessagePack | `0x03` | MessagePack-encoded |
+| KeyValue | `0x10` | Key-value pair |
+| Timestamped | `0x11` | Timestamp + data |
+| Null | `0xFF` | Tombstone/empty |
+
+## Error Handling
+
+```python
+from lnc_client import (
+    LanceError,
+    ConnectionError,
+    BackpressureError,
+    TopicNotFoundError,
+    InvalidFrameError,
+)
+
+try:
+    await producer.send(topic_id=99, data=b"test")
+except TopicNotFoundError:
+    print("Topic doesn't exist")
+except BackpressureError:
+    print("Server is overloaded, slow down")
+except ConnectionError:
+    print("Connection lost")
+```
+
+## Protocol Details
+
+This client implements the [Lance Wire Protocol (LWP)](https://github.com/nitecon/lance) v1.0:
+
+- **44-byte fixed header** with CRC32C validation
+- **Hardware-accelerated checksums** (SSE4.2 / ARM CRC)
+- **Backpressure signaling** from server
+- **Keepalive** with 30-second timeout
+- **Batched production** with ACK tracking
+- **Offset-based consumption** with seek/rewind
+- **LZ4 compression** (optional, per-batch)
+- **Reconnection** with exponential backoff (100ms base, 30s max, jitter)
+
+## Development
+
+```bash
+git clone https://github.com/nitecon/lnc-client-py.git
+cd lnc-client-py
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest -v
+```
+
+39 tests covering protocol parsing, CRC32C validation, TLV encoding/decoding, and frame builders.
+
+## License
+
+[MIT](LICENSE)

lnc_client-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lnc-client"
+version = "0.1.0"
+description = "Python client for the Lance Wire Protocol (LWP) — high-performance, low-latency data streaming"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10"
+authors = [
+    { name = "Will Hattingh", email = "nitecon@gmail.com" },
+]
+keywords = ["lance", "lwp", "streaming", "data-ingestion", "high-performance"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: System :: Networking",
+]
+dependencies = [
+    "crc32c>=2.7",
+    "lz4>=4.3",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+    "pytest-timeout>=2.3",
+    "ruff>=0.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/nitecon/lnc-client-py"
+Documentation = "https://github.com/nitecon/lnc-client-py#readme"
+Issues = "https://github.com/nitecon/lnc-client-py/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lnc_client"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/", "tests/", "LICENSE", "README.md", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"