twilic 3.0.0__tar.gz

twilic-3.0.0/.gitignore

@@ -0,0 +1,26 @@
+# Python / uv
+.venv/
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+.coverage.*
+htmlcov/
+dist/
+build/
+*.so
+*.whl
+
+# Node (markdown tooling)
+node_modules/
+
+# Rust interop scripts
+/scripts/rust-client-check/target/
+/scripts/rust-server-fixtures/target/
+
+# OS
+.DS_Store

twilic-3.0.0/LICENSE

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

twilic-3.0.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: twilic
+Version: 3.0.0
+Summary: Python implementation of a fast, compact binary wire format for modern data transport.
+Project-URL: Homepage, https://github.com/twilic/twilic-python
+Project-URL: Repository, https://github.com/twilic/twilic-python
+Project-URL: Issues, https://github.com/twilic/twilic-python/issues
+Author-email: Twilic <maintained-by-minagishl@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: binary,serialization,twilic,wire-format
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Twilic (Python)
+
+Python implementation of the Twilic wire format and session-aware encoder/decoder.
+
+This package's default `encode` / `decode` API targets Twilic v2.
+
+## What this package provides
+
+- Dynamic encoding/decoding (`encode`, `decode`)
+- Schema-aware encoding (`encode_with_schema`)
+- Batch and micro-batch encoding (`encode_batch`, `SessionEncoder.encode_micro_batch`)
+- Stateful features (base snapshots, state patch, template batch, control stream, trained dictionary)
+
+## Project layout
+
+```text
+twilic-python/
+  src/twilic/                     # wire, model, codec, session, protocol, v2
+  tests/                          # spec conformance and interop tests
+  scripts/                        # Rust interop fixtures and smoke checks
+  docs/
+```
+
+## Requirements
+
+- Python 3.12 or later
+- [uv](https://docs.astral.sh/uv/) for development
+
+## Install
+
+```bash
+pip install twilic
+```
+
+Or with uv:
+
+```bash
+uv add twilic
+```
+
+## Quick start
+
+```python
+import twilic
+
+value = twilic.new_map(
+    twilic.entry("id", twilic.new_u64(1001)),
+    twilic.entry("name", twilic.new_string("alice")),
+)
+
+data = twilic.encode(value)
+decoded = twilic.decode(data)
+
+print(twilic.equal(decoded, value))
+```
+
+## Session encoder example
+
+```python
+import twilic
+
+enc = twilic.new_session_encoder(twilic.default_session_options())
+
+value = twilic.new_map(
+    twilic.entry("id", twilic.new_u64(1)),
+    twilic.entry("role", twilic.new_string("admin")),
+)
+
+enc.encode(value)
+```
+
+## Development
+
+Run checks locally:
+
+```bash
+uv sync
+uv run ruff format --check .
+uv run ruff check .
+uv run pytest
+```
+
+Rust client interop smoke check (Python server -> Rust client):
+
+```bash
+bash scripts/check-rust-client-interop.sh
+```
+
+Python client interop smoke check (Rust server -> Python client):
+
+```bash
+bash scripts/check-python-client-interop.sh
+```
+
+Run both directions:
+
+```bash
+bash scripts/check-interop.sh
+```
+
+Note: interop scripts expect `../twilic-rust` to exist as a sibling directory.
+
+## Markdown formatting
+
+Documentation is formatted and linted with Prettier and markdownlint (see [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md)).
+
+## CI and release (GitHub Actions)
+
+- CI workflow: `.github/workflows/ci.yml`
+- Interop workflow: `.github/workflows/interop.yml`
+- Release workflow: `.github/workflows/publish-pypi.yml` (tag `v*` must match `pyproject.toml` version)
+
+## Spec parity
+
+This package mirrors the Twilic wire format spec at [twilic/twilic](https://github.com/twilic/twilic) and stays in lockstep with the [Rust](https://github.com/twilic/twilic-rust), [Go](https://github.com/twilic/twilic-go), and [Zig](https://github.com/twilic/twilic-zig) reference implementations.
+
+See [`docs/SPEC-TEST-TRACEABILITY.md`](docs/SPEC-TEST-TRACEABILITY.md) for the spec-section to test mapping.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

twilic-3.0.0/README.md

@@ -0,0 +1,121 @@
+# Twilic (Python)
+
+Python implementation of the Twilic wire format and session-aware encoder/decoder.
+
+This package's default `encode` / `decode` API targets Twilic v2.
+
+## What this package provides
+
+- Dynamic encoding/decoding (`encode`, `decode`)
+- Schema-aware encoding (`encode_with_schema`)
+- Batch and micro-batch encoding (`encode_batch`, `SessionEncoder.encode_micro_batch`)
+- Stateful features (base snapshots, state patch, template batch, control stream, trained dictionary)
+
+## Project layout
+
+```text
+twilic-python/
+  src/twilic/                     # wire, model, codec, session, protocol, v2
+  tests/                          # spec conformance and interop tests
+  scripts/                        # Rust interop fixtures and smoke checks
+  docs/
+```
+
+## Requirements
+
+- Python 3.12 or later
+- [uv](https://docs.astral.sh/uv/) for development
+
+## Install
+
+```bash
+pip install twilic
+```
+
+Or with uv:
+
+```bash
+uv add twilic
+```
+
+## Quick start
+
+```python
+import twilic
+
+value = twilic.new_map(
+    twilic.entry("id", twilic.new_u64(1001)),
+    twilic.entry("name", twilic.new_string("alice")),
+)
+
+data = twilic.encode(value)
+decoded = twilic.decode(data)
+
+print(twilic.equal(decoded, value))
+```
+
+## Session encoder example
+
+```python
+import twilic
+
+enc = twilic.new_session_encoder(twilic.default_session_options())
+
+value = twilic.new_map(
+    twilic.entry("id", twilic.new_u64(1)),
+    twilic.entry("role", twilic.new_string("admin")),
+)
+
+enc.encode(value)
+```
+
+## Development
+
+Run checks locally:
+
+```bash
+uv sync
+uv run ruff format --check .
+uv run ruff check .
+uv run pytest
+```
+
+Rust client interop smoke check (Python server -> Rust client):
+
+```bash
+bash scripts/check-rust-client-interop.sh
+```
+
+Python client interop smoke check (Rust server -> Python client):
+
+```bash
+bash scripts/check-python-client-interop.sh
+```
+
+Run both directions:
+
+```bash
+bash scripts/check-interop.sh
+```
+
+Note: interop scripts expect `../twilic-rust` to exist as a sibling directory.
+
+## Markdown formatting
+
+Documentation is formatted and linted with Prettier and markdownlint (see [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md)).
+
+## CI and release (GitHub Actions)
+
+- CI workflow: `.github/workflows/ci.yml`
+- Interop workflow: `.github/workflows/interop.yml`
+- Release workflow: `.github/workflows/publish-pypi.yml` (tag `v*` must match `pyproject.toml` version)
+
+## Spec parity
+
+This package mirrors the Twilic wire format spec at [twilic/twilic](https://github.com/twilic/twilic) and stays in lockstep with the [Rust](https://github.com/twilic/twilic-rust), [Go](https://github.com/twilic/twilic-go), and [Zig](https://github.com/twilic/twilic-zig) reference implementations.
+
+See [`docs/SPEC-TEST-TRACEABILITY.md`](docs/SPEC-TEST-TRACEABILITY.md) for the spec-section to test mapping.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

twilic-3.0.0/pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "twilic"
+version = "3.0.0"
+description = "Python implementation of a fast, compact binary wire format for modern data transport."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [{ name = "Twilic", email = "maintained-by-minagishl@users.noreply.github.com" }]
+keywords = ["twilic", "serialization", "binary", "wire-format"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/twilic/twilic-python"
+Repository = "https://github.com/twilic/twilic-python"
+Issues = "https://github.com/twilic/twilic-python/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/twilic"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/twilic", "LICENSE", "README.md"]
+
+[dependency-groups]
+dev = ["pytest>=8.0", "ruff>=0.9"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["E501"]
+"scripts/**" = ["E402"]
+
+[tool.ruff.format]
+quote-style = "double"