rombob 1.0.0__tar.gz

rombob-1.0.0/LICENSE

@@ -0,0 +1,207 @@
+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:
+
+    1. You must give any other recipients of the Work or Derivative Works a
+    copy of this License; and
+
+    2. You must cause any modified files to carry prominent notices stating
+    that You changed the files; and
+
+    3. 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
+
+    4. 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 loudblow
+
+        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.

rombob-1.0.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: rombob
+Version: 1.0.0
+Summary: Fast binary serialization, driven by plain type hints.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: loudblow
+Author-email: 145815114+loudblow@users.noreply.github.com
+Requires-Python: >=3.10
+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: Programming Language :: Python :: 3.14
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# 🧩 Rombob
+
+**Binary serialization for Python, driven by plain type hints.**
+
+Describe your wire format as a [dataclass] or a [NamedTuple] — get a fast, validated encoder and decoder for free. Zero dependencies, pure python.
+
+[Installation](#-installation) ·
+[Quick Start](#-quick-start) ·
+[Advanced Example](#-advanced-example) ·
+[Annotations](#-annotations-cheat-sheet) ·
+[Types](#-supported-types) ·
+[Contributing](#-contributing)
+
+</div>
+
+---
+
+## ✨ Why Rombob?
+
+- 🏷️ **Just type hints** — no schema files, no code generation step, no base classes.
+- ⚡ **Fast** — consecutive fixed-size fields are compiled into a single `struct` call.
+- 🔗 **Dependent fields** — lengths and optional fields can depend on values read earlier.
+- 🛡️ **Validated** — constraints (`Range`, `Gt`, `Predicate`, ...) are checked on read *and* write.
+- 🔍 **Readable errors** — `trace_errors=True` points at the exact failing field, e.g. `Packet.points[0].x`.
+- 🧠 **Stateless codecs** — build once, share freely.
+
+## 📦 Installation
+
+Install the latest unreleased code straight from Git:
+
+```bash
+pip install git+https://github.com/loudblow/rombob.git@main
+```
+
+## 🚀 Quick Start
+
+```python
+import dataclasses
+import rombob
+
+
+@dataclasses.dataclass
+class Player:
+    id: rombob.U8_B   # 1 byte, big-endian
+    username: str     # UTF-8 with a 2-byte length prefix
+
+
+# 📤 Serialize
+encoded = rombob.encode(Player(id=1, username="Archer"))
+print(encoded)  # b'\x01\x00\x06Archer'
+
+# 📥 Deserialize
+player = rombob.decode(encoded, cls=Player)
+print(player)  # Player(id=1, username='Archer')
+```
+
+## 🔬 Advanced Example
+
+A tiny network packet that uses most of the features at once: magic bytes, an enum,
+a length taken from an earlier field, a conditional field, validation, nested
+structures, and a raw tail.
+
+```python
+import dataclasses
+import enum
+from typing import Annotated, Literal
+
+import rombob
+from rombob import (
+    I16_L, U8_B, Len, Named, Prefix, Range, Raw, When,
+)
+
+
+class Kind(enum.IntEnum):
+    PING = 1
+    CHAT = 2
+
+
+@dataclasses.dataclass
+class Point:
+    x: I16_L                                    # little-endian int16
+    y: I16_L
+
+
+@dataclasses.dataclass
+class Packet:
+    magic: Literal[b"RB"]                       # constant, checked on read
+    version: Annotated[Literal[1, 2], U8_B]     # only 1 or 2 is accepted
+    kind: Annotated[Kind, U8_B]                 # enum stored as one byte
+    count: Named[U8_B]                          # remembered as "count"
+    points: Annotated[list[Point], Len(ref="count")]   # length = count
+    has_token: Named[bool]
+    token: Annotated[str | None, When(ref="has_token")]  # only if has_token
+    hp: Annotated[U8_B, Range(0, 100)]          # validated 0..100
+    tags: Annotated[list[Annotated[str, Prefix(U8_B)]], Prefix(U8_B)]
+    payload: Raw                                # everything that is left
+
+
+packet = Packet(
+    magic=b"RB",
+    version=1,
+    kind=Kind.CHAT,
+    count=2,
+    points=[Point(1, 2), Point(-3, 4)],
+    has_token=True,
+    token="secret",
+    hp=80,
+    tags=["a", "bc"],
+    payload=b"\xde\xad",
+)
+
+data = rombob.encode(packet)
+assert rombob.decode(data, cls=Packet) == packet
+```
+
+Something went wrong? Ask for a trace and get the exact location:
+
+```python
+import dataclasses
+
+rombob.encode(dataclasses.replace(packet, hp=200), trace_errors=True)
+# BytesOperationError: Encoding failed at length 22 (Packet.hp):
+#     200 violates Range(lo=0, hi=100)
+
+rombob.decode(data[:5], cls=Packet, trace_errors=True)
+# BytesOperationError: Decoding failed at offset 5 (Packet.points[0].x): ...
+```
+
+## 🧰 Annotations Cheat Sheet
+
+Everything lives in `rombob.metadata` and is importable from `rombob`.
+
+| Annotation | What it does | Example |
+| ---------- | ------------ | ------- |
+| `LE` / `BE` | Byte order for `IntCodec` (or use the `*_L` / `*_B` aliases) | `U16_L` |
+| `Len(n)` | Exact length, no length prefix | `Annotated[str, Len(10)]` |
+| `Len(ref=...)` | Length from an earlier `Named` field (or `lambda ctx: ...`); checked on write | `Len(ref="count")` |
+| `Prefix(codec)` | Integer type of the length prefix (U16 big-endian by default) | `Prefix(U8_B)` |
+| `Named[T]` | Remember the value so later fields can refer to it | `Named[U8_B]` |
+| `When(...)` | Make a field conditional on earlier fields | `When(ref="has_token")` |
+| `Optional[T]` / `T \| None` | Present while there is data left | `int \| None` |
+| `Skip[T]` | Neither read nor written (needs a default) | `Skip[int]` |
+| `Gt` `Ge` `Lt` `Le` `Range` | Numeric constraints, checked on read and write | `Range(1, 10)` |
+| `Predicate(func)` | Any custom check | `Predicate(lambda v: v % 2 == 0)` |
+| `Literal[...]` | Constants; `bytes`/`str` literals need no codec, `int` literals do | `Annotated[Literal[1, 2], U8_B]` |
+
+## 🧱 Supported Types
+
+Fields can be bools, integers, floats, strings, bytes, lists, tuples, sets,
+frozensets, enums, named tuples, or other dataclasses — plus `Optional`, `Literal`,
+`Generic`/`TypeVar`, fixed- and variable-length collections, and heterogeneous
+tuples such as `tuple[int, str]`.
+
+### Plain Python types (defaults)
+
+| Python type | Encoding | Notes |
+| ----------- | -------- | ----- |
+| `bool` | `?` | Writes 1 or 0 |
+| `str` | `U16(BE)` length + UTF-8 bytes | |
+| `bytes` | `U16(BE)` length + bytes | |
+| `int` | `I64(BE)` | Signed 64-bit |
+| `float` | `F64(BE)` | IEEE 754 double |
+
+### Aliases
+
+Every alias comes in two flavors: `_B` (big-endian) and `_L` (little-endian).
+
+| Family | Aliases |
+| ------ | ------- |
+| Unsigned ints | `U8` `U16` `U24` `U32` `U48` `U64` |
+| Signed ints | `I8` `I16` `I24` `I32` `I48` `I64` |
+| Floats | `F16` `F32` `F64` |
+| Variable-length | `UVInt` (unsigned), `IVInt` (signed) |
+| Rest of the buffer | `Raw` |
+
+## ⚙️ Going Further
+
+- **Fast paths** — `Codec.encode/decode` with an explicit codec, or `Factory` for
+  dispatch by primary field. See `rombob.get_codec(cls)` to build and inspect a codec.
+- **Streaming** — pass `reader=` / `writer=` to `decode` / `encode` to continue an
+  existing buffer.
+- **Benchmarks** — see [`benchmarks/`](benchmarks) (`bench.py`, `bench_int24.py`).
+
+## 🤝 Contributing
+
+```bash
+make install   # poetry install + pre-commit hooks
+make test      # pytest + coverage
+make format    # ruff format
+make lint      # pre-commit run
+```
+
+Pull requests and issues are welcome!
+
+## 📚 References & Inspiration
+
+- [bytechomp](https://github.com/AndrewSpittlemeister/bytechomp/tree/main)
+- [bstruct](https://github.com/flxbe/bstruct)
+- [pyserde](https://github.com/yukinarit/pyserde/tree/main)
+- [pdc_struct](https://github.com/boxcake/pdc_struct)
+- [dataclasses-struct](https://github.com/harrymander/dataclasses-struct)
+
+[dataclass]: https://docs.python.org/3/library/dataclasses.html
+[NamedTuple]: https://docs.python.org/3/library/typing.html#typing.NamedTuple
+

rombob-1.0.0/README.md

@@ -0,0 +1,206 @@
+<div align="center">
+
+# 🧩 Rombob
+
+**Binary serialization for Python, driven by plain type hints.**
+
+Describe your wire format as a [dataclass] or a [NamedTuple] — get a fast, validated encoder and decoder for free. Zero dependencies, pure python.
+
+[Installation](#-installation) ·
+[Quick Start](#-quick-start) ·
+[Advanced Example](#-advanced-example) ·
+[Annotations](#-annotations-cheat-sheet) ·
+[Types](#-supported-types) ·
+[Contributing](#-contributing)
+
+</div>
+
+---
+
+## ✨ Why Rombob?
+
+- 🏷️ **Just type hints** — no schema files, no code generation step, no base classes.
+- ⚡ **Fast** — consecutive fixed-size fields are compiled into a single `struct` call.
+- 🔗 **Dependent fields** — lengths and optional fields can depend on values read earlier.
+- 🛡️ **Validated** — constraints (`Range`, `Gt`, `Predicate`, ...) are checked on read *and* write.
+- 🔍 **Readable errors** — `trace_errors=True` points at the exact failing field, e.g. `Packet.points[0].x`.
+- 🧠 **Stateless codecs** — build once, share freely.
+
+## 📦 Installation
+
+Install the latest unreleased code straight from Git:
+
+```bash
+pip install git+https://github.com/loudblow/rombob.git@main
+```
+
+## 🚀 Quick Start
+
+```python
+import dataclasses
+import rombob
+
+
+@dataclasses.dataclass
+class Player:
+    id: rombob.U8_B   # 1 byte, big-endian
+    username: str     # UTF-8 with a 2-byte length prefix
+
+
+# 📤 Serialize
+encoded = rombob.encode(Player(id=1, username="Archer"))
+print(encoded)  # b'\x01\x00\x06Archer'
+
+# 📥 Deserialize
+player = rombob.decode(encoded, cls=Player)
+print(player)  # Player(id=1, username='Archer')
+```
+
+## 🔬 Advanced Example
+
+A tiny network packet that uses most of the features at once: magic bytes, an enum,
+a length taken from an earlier field, a conditional field, validation, nested
+structures, and a raw tail.
+
+```python
+import dataclasses
+import enum
+from typing import Annotated, Literal
+
+import rombob
+from rombob import (
+    I16_L, U8_B, Len, Named, Prefix, Range, Raw, When,
+)
+
+
+class Kind(enum.IntEnum):
+    PING = 1
+    CHAT = 2
+
+
+@dataclasses.dataclass
+class Point:
+    x: I16_L                                    # little-endian int16
+    y: I16_L
+
+
+@dataclasses.dataclass
+class Packet:
+    magic: Literal[b"RB"]                       # constant, checked on read
+    version: Annotated[Literal[1, 2], U8_B]     # only 1 or 2 is accepted
+    kind: Annotated[Kind, U8_B]                 # enum stored as one byte
+    count: Named[U8_B]                          # remembered as "count"
+    points: Annotated[list[Point], Len(ref="count")]   # length = count
+    has_token: Named[bool]
+    token: Annotated[str | None, When(ref="has_token")]  # only if has_token
+    hp: Annotated[U8_B, Range(0, 100)]          # validated 0..100
+    tags: Annotated[list[Annotated[str, Prefix(U8_B)]], Prefix(U8_B)]
+    payload: Raw                                # everything that is left
+
+
+packet = Packet(
+    magic=b"RB",
+    version=1,
+    kind=Kind.CHAT,
+    count=2,
+    points=[Point(1, 2), Point(-3, 4)],
+    has_token=True,
+    token="secret",
+    hp=80,
+    tags=["a", "bc"],
+    payload=b"\xde\xad",
+)
+
+data = rombob.encode(packet)
+assert rombob.decode(data, cls=Packet) == packet
+```
+
+Something went wrong? Ask for a trace and get the exact location:
+
+```python
+import dataclasses
+
+rombob.encode(dataclasses.replace(packet, hp=200), trace_errors=True)
+# BytesOperationError: Encoding failed at length 22 (Packet.hp):
+#     200 violates Range(lo=0, hi=100)
+
+rombob.decode(data[:5], cls=Packet, trace_errors=True)
+# BytesOperationError: Decoding failed at offset 5 (Packet.points[0].x): ...
+```
+
+## 🧰 Annotations Cheat Sheet
+
+Everything lives in `rombob.metadata` and is importable from `rombob`.
+
+| Annotation | What it does | Example |
+| ---------- | ------------ | ------- |
+| `LE` / `BE` | Byte order for `IntCodec` (or use the `*_L` / `*_B` aliases) | `U16_L` |
+| `Len(n)` | Exact length, no length prefix | `Annotated[str, Len(10)]` |
+| `Len(ref=...)` | Length from an earlier `Named` field (or `lambda ctx: ...`); checked on write | `Len(ref="count")` |
+| `Prefix(codec)` | Integer type of the length prefix (U16 big-endian by default) | `Prefix(U8_B)` |
+| `Named[T]` | Remember the value so later fields can refer to it | `Named[U8_B]` |
+| `When(...)` | Make a field conditional on earlier fields | `When(ref="has_token")` |
+| `Optional[T]` / `T \| None` | Present while there is data left | `int \| None` |
+| `Skip[T]` | Neither read nor written (needs a default) | `Skip[int]` |
+| `Gt` `Ge` `Lt` `Le` `Range` | Numeric constraints, checked on read and write | `Range(1, 10)` |
+| `Predicate(func)` | Any custom check | `Predicate(lambda v: v % 2 == 0)` |
+| `Literal[...]` | Constants; `bytes`/`str` literals need no codec, `int` literals do | `Annotated[Literal[1, 2], U8_B]` |
+
+## 🧱 Supported Types
+
+Fields can be bools, integers, floats, strings, bytes, lists, tuples, sets,
+frozensets, enums, named tuples, or other dataclasses — plus `Optional`, `Literal`,
+`Generic`/`TypeVar`, fixed- and variable-length collections, and heterogeneous
+tuples such as `tuple[int, str]`.
+
+### Plain Python types (defaults)
+
+| Python type | Encoding | Notes |
+| ----------- | -------- | ----- |
+| `bool` | `?` | Writes 1 or 0 |
+| `str` | `U16(BE)` length + UTF-8 bytes | |
+| `bytes` | `U16(BE)` length + bytes | |
+| `int` | `I64(BE)` | Signed 64-bit |
+| `float` | `F64(BE)` | IEEE 754 double |
+
+### Aliases
+
+Every alias comes in two flavors: `_B` (big-endian) and `_L` (little-endian).
+
+| Family | Aliases |
+| ------ | ------- |
+| Unsigned ints | `U8` `U16` `U24` `U32` `U48` `U64` |
+| Signed ints | `I8` `I16` `I24` `I32` `I48` `I64` |
+| Floats | `F16` `F32` `F64` |
+| Variable-length | `UVInt` (unsigned), `IVInt` (signed) |
+| Rest of the buffer | `Raw` |
+
+## ⚙️ Going Further
+
+- **Fast paths** — `Codec.encode/decode` with an explicit codec, or `Factory` for
+  dispatch by primary field. See `rombob.get_codec(cls)` to build and inspect a codec.
+- **Streaming** — pass `reader=` / `writer=` to `decode` / `encode` to continue an
+  existing buffer.
+- **Benchmarks** — see [`benchmarks/`](benchmarks) (`bench.py`, `bench_int24.py`).
+
+## 🤝 Contributing
+
+```bash
+make install   # poetry install + pre-commit hooks
+make test      # pytest + coverage
+make format    # ruff format
+make lint      # pre-commit run
+```
+
+Pull requests and issues are welcome!
+
+## 📚 References & Inspiration
+
+- [bytechomp](https://github.com/AndrewSpittlemeister/bytechomp/tree/main)
+- [bstruct](https://github.com/flxbe/bstruct)
+- [pyserde](https://github.com/yukinarit/pyserde/tree/main)
+- [pdc_struct](https://github.com/boxcake/pdc_struct)
+- [dataclasses-struct](https://github.com/harrymander/dataclasses-struct)
+
+[dataclass]: https://docs.python.org/3/library/dataclasses.html
+[NamedTuple]: https://docs.python.org/3/library/typing.html#typing.NamedTuple

rombob-1.0.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "rombob"
+version = "1.0.0"
+description = "Fast binary serialization, driven by plain type hints."
+authors = [
+    {name = "loudblow", email = "145815114+loudblow@users.noreply.github.com"}
+]
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = []
+
+[dependency-groups]
+dev = [
+    "pytest (>=9.0.2,<10.0.0)",
+    "pytest-coverage (>=0.0,<0.1)",
+    "ruff (>=0.15.7,<0.16.0)",
+    "pre-commit (>=4.5.1,<5.0.0)"
+]
+
+[tool.poetry]
+packages = [{include = "*", from="src"}]
+package-mode = true
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[tool.ruff]
+src = ["src"]
+fix = true
+show-fixes = true
+output-format = "full"
+line-length = 80
+
+[tool.ruff.lint]
+select = [
+    "B",  # flake8-bugbear
+    "E",  # pycodestyle error
+    "F",  # pyflakes
+    "I",  # isort
+    "UP",  # pyupgrade
+    "W",  # pycodestyle warning
+]
+
+[tool.ruff.lint.isort]
+force-single-line = false
+order-by-type = true
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"