sltcore 0.2.0__tar.gz → 0.2.1__tar.gz

sltcore-0.2.1/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: sltcore
+Version: 0.2.1
+Summary: A toolkit for handling structured data layouts and bit-level operations.
+Project-URL: Homepage, https://github.com/fangface-hub/StructLayoutToolkitCore
+Project-URL: Documentation, https://readthedocs.org
+Project-URL: Repository, https://github.com/fangface-hub/StructLayoutToolkitCore
+Project-URL: Issues, https://github.com/fangface-hub/StructLayoutToolkitCore/issues
+Author: fangface
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bit,byte,data,deserialization,layout,serialization,struct
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# StructLayoutToolkitCore
+
+stlcore is a minimal, high‑cohesion core library for bit‑accurate binary slicing. It provides the fundamental primitives (bits_get, bits_set, InfoSize) required to build struct layout analyzers, binary editors, protocol inspectors, and low‑level testing tools. Designed for clarity, correctness, and composability.
+
+## What You Can Do After Installing sltcore
+
+sltcore provides a minimal and consistent bit-level abstraction layer for building higher‑level tools such as binary editors, protocol analyzers, and structured layout systems.
+
+After installing the package, you can:
+
+- Extract arbitrary bit ranges from a bytearray using bits_get
+- Write arbitrary bit ranges into a bytearray using bits_set
+- Represent sizes and offsets uniformly with InfoSize
+- Build structured binary layouts on top of a stable bit‑operation core
+
+## Quick Examples: bits_get / bits_set
+
+```python
+
+from sltcore.types import InfoSize, Info
+from sltcore.bits import bits_get, bits_set
+
+buf = bytearray(b"\x12\x34\x56\x78")
+
+# Extract 4 bits at offset (1 byte, 0 bits)
+value = bits_get(buf, InfoSize(1, 0), InfoSize(0, 4))
+print(value.to_hex)  # 0x3
+
+# Write 5 bits at offset (2 bytes, 3 bits)
+bits_set(buf, InfoSize(2, 3), InfoSize(0, 5), 0b10101)
+print(buf.hex()) # 12345578
+
+```
+
+## sltcore.type.InfoSize
+
+InfoSize is a type that represents offsets and sizes in a unified way.
+It supports addition and subtraction, and stores both byte and bit components.
+
+- byte: the byte component
+- bit: the bit component (0–7)
+
+always normalized so that bit < 8
+
+It is used for both offset and size, allowing consistent structural layout definitions.
+
+## sltcore.type.Info
+
+Info stores an InfoSize and a raw integer value.
+
+- The value returned by bits_get is an Info instance
+- The value passed to bits_set is also an Info instance
+
+This allows higher‑level code to treat extracted fields as structured units rather than plain integers.
+
+## sltcore.bits.bits_get
+
+bits_get extracts a field from a bytearray using an offset and size, and returns an Info object.
+
+Input:
+
+- bytearray buffer
+- InfoSize offset
+- InfoSize size
+
+Output:
+
+- Info containing the extracted value and its size
+
+## sltcore.bits.bits_set
+
+bits_set writes a value into a bytearray at the specified offset.
+
+Input:
+
+- bytearray buffer
+- InfoSize offset
+- Info value (which includes its size)
+
+The function masks and replaces the target bit range inside the buffer.
+
+## Documentation
+
+For detailed usage, examples, and parameter descriptions, refer to the docstrings via:
+
+python
+
+- help(sltcore.type.InfoSize)
+- help(sltcore.type.Info)
+- help(sltcore.bits.bits_get)
+- help(sltcore.bits.bits_set)

sltcore-0.2.1/README.md

@@ -0,0 +1,91 @@
+# StructLayoutToolkitCore
+
+stlcore is a minimal, high‑cohesion core library for bit‑accurate binary slicing. It provides the fundamental primitives (bits_get, bits_set, InfoSize) required to build struct layout analyzers, binary editors, protocol inspectors, and low‑level testing tools. Designed for clarity, correctness, and composability.
+
+## What You Can Do After Installing sltcore
+
+sltcore provides a minimal and consistent bit-level abstraction layer for building higher‑level tools such as binary editors, protocol analyzers, and structured layout systems.
+
+After installing the package, you can:
+
+- Extract arbitrary bit ranges from a bytearray using bits_get
+- Write arbitrary bit ranges into a bytearray using bits_set
+- Represent sizes and offsets uniformly with InfoSize
+- Build structured binary layouts on top of a stable bit‑operation core
+
+## Quick Examples: bits_get / bits_set
+
+```python
+
+from sltcore.types import InfoSize, Info
+from sltcore.bits import bits_get, bits_set
+
+buf = bytearray(b"\x12\x34\x56\x78")
+
+# Extract 4 bits at offset (1 byte, 0 bits)
+value = bits_get(buf, InfoSize(1, 0), InfoSize(0, 4))
+print(value.to_hex)  # 0x3
+
+# Write 5 bits at offset (2 bytes, 3 bits)
+bits_set(buf, InfoSize(2, 3), InfoSize(0, 5), 0b10101)
+print(buf.hex()) # 12345578
+
+```
+
+## sltcore.type.InfoSize
+
+InfoSize is a type that represents offsets and sizes in a unified way.
+It supports addition and subtraction, and stores both byte and bit components.
+
+- byte: the byte component
+- bit: the bit component (0–7)
+
+always normalized so that bit < 8
+
+It is used for both offset and size, allowing consistent structural layout definitions.
+
+## sltcore.type.Info
+
+Info stores an InfoSize and a raw integer value.
+
+- The value returned by bits_get is an Info instance
+- The value passed to bits_set is also an Info instance
+
+This allows higher‑level code to treat extracted fields as structured units rather than plain integers.
+
+## sltcore.bits.bits_get
+
+bits_get extracts a field from a bytearray using an offset and size, and returns an Info object.
+
+Input:
+
+- bytearray buffer
+- InfoSize offset
+- InfoSize size
+
+Output:
+
+- Info containing the extracted value and its size
+
+## sltcore.bits.bits_set
+
+bits_set writes a value into a bytearray at the specified offset.
+
+Input:
+
+- bytearray buffer
+- InfoSize offset
+- Info value (which includes its size)
+
+The function masks and replaces the target bit range inside the buffer.
+
+## Documentation
+
+For detailed usage, examples, and parameter descriptions, refer to the docstrings via:
+
+python
+
+- help(sltcore.type.InfoSize)
+- help(sltcore.type.Info)
+- help(sltcore.bits.bits_get)
+- help(sltcore.bits.bits_set)

{sltcore-0.2.0 → sltcore-0.2.1}/pyproject.toml

@@ -1,6 +1,8 @@
 [project]
 name = "sltcore"
-version = "0.2.0"
+version = "0.2.1"
+license = "MIT"
+license-files = ["LICENSE"]
 description = "A toolkit for handling structured data layouts and bit-level operations."
 readme = "README.md"
 authors = [
@@ -8,13 +10,20 @@ authors = [
 ]
 requires-python = ">=3.12"
 dependencies = []
+keywords = ["struct", "byte", "bit", "layout", "data", "serialization", "deserialization"]
+
+[project.urls]
+Homepage = "https://github.com/fangface-hub/StructLayoutToolkitCore"
+Documentation = "https://readthedocs.org"
+Repository = "https://github.com/fangface-hub/StructLayoutToolkitCore"
+Issues = "https://github.com/fangface-hub/StructLayoutToolkitCore/issues"
 
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]
-packages = ["sltcore"]
+packages = ["src/sltcore"]
 
 [dependency-groups]
 dev = [

sltcore-0.2.0/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.4
-Name: sltcore
-Version: 0.2.0
-Summary: A toolkit for handling structured data layouts and bit-level operations.
-Author: fangface
-License-File: LICENSE
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-
-# StructLayoutToolkitCore
-
-stlcore is a minimal, high‑cohesion core library for bit‑accurate binary slicing. It provides the fundamental primitives (bits_get, bits_set, InfoSize) required to build struct layout analyzers, binary editors, protocol inspectors, and low‑level testing tools. Designed for clarity, correctness, and composability.

sltcore-0.2.0/README.md

@@ -1,3 +0,0 @@
-# StructLayoutToolkitCore
-
-stlcore is a minimal, high‑cohesion core library for bit‑accurate binary slicing. It provides the fundamental primitives (bits_get, bits_set, InfoSize) required to build struct layout analyzers, binary editors, protocol inspectors, and low‑level testing tools. Designed for clarity, correctness, and composability.