pktfmt 0.1.0__tar.gz

pktfmt-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: pktfmt
+Version: 0.1.0
+Summary: Generate RFC-style ASCII packet diagrams from field definitions
+License-Expression: MIT
+Keywords: packet,diagram,ascii,rfc,network,protocol
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# pktfmt
+
+Generate RFC-style ASCII packet diagrams from field definitions.
+
+## Installation
+
+```bash
+pip install pktfmt
+```
+
+## Usage
+
+### Inline format
+
+```bash
+pktfmt "Type:16,Length:16,Payload:*"
+```
+
+Output:
+```
+ 0                  1                  2                  3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|              Type             |             Length            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+:                            Payload                            :
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+### JSON file
+
+```bash
+pktfmt packet.json
+```
+
+```json
+{
+  "name": "MyPacket",
+  "fields": [
+    {"name": "Type", "bits": 16},
+    {"name": "Length", "bits": 16},
+    {"name": "Payload", "bits": "*"}
+  ]
+}
+```
+
+### Options
+
+```bash
+pktfmt "Type:16,Data:32" --bits-per-row 16   # Custom row width
+pktfmt "Type:32" --no-ruler                   # Omit bit number header
+```
+
+## Field syntax
+
+- `Name:N` - Fixed-width field of N bits
+- `Name:*` - Variable-length field (rendered with `:` borders)
+
+## License
+
+MIT

pktfmt-0.1.0/README.md

@@ -0,0 +1,61 @@
+# pktfmt
+
+Generate RFC-style ASCII packet diagrams from field definitions.
+
+## Installation
+
+```bash
+pip install pktfmt
+```
+
+## Usage
+
+### Inline format
+
+```bash
+pktfmt "Type:16,Length:16,Payload:*"
+```
+
+Output:
+```
+ 0                  1                  2                  3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|              Type             |             Length            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+:                            Payload                            :
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+### JSON file
+
+```bash
+pktfmt packet.json
+```
+
+```json
+{
+  "name": "MyPacket",
+  "fields": [
+    {"name": "Type", "bits": 16},
+    {"name": "Length", "bits": 16},
+    {"name": "Payload", "bits": "*"}
+  ]
+}
+```
+
+### Options
+
+```bash
+pktfmt "Type:16,Data:32" --bits-per-row 16   # Custom row width
+pktfmt "Type:32" --no-ruler                   # Omit bit number header
+```
+
+## Field syntax
+
+- `Name:N` - Fixed-width field of N bits
+- `Name:*` - Variable-length field (rendered with `:` borders)
+
+## License
+
+MIT

pktfmt-0.1.0/pktfmt/__init__.py

@@ -0,0 +1,3 @@
+"""pktfmt - Generate RFC-style ASCII packet diagrams."""
+
+__version__ = "0.1.0"

pktfmt-0.1.0/pktfmt/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for python -m pktfmt."""
+
+from pktfmt.cli import main
+
+if __name__ == "__main__":
+    main()

pktfmt-0.1.0/pktfmt/cli.py

@@ -0,0 +1,87 @@
+"""Command-line interface for pktfmt."""
+
+import argparse
+import sys
+from typing import List, Optional
+
+from . import __version__
+from .parser import parse_input
+from .renderer import render_diagram
+
+
+def create_parser() -> argparse.ArgumentParser:
+    """Create the argument parser."""
+    parser = argparse.ArgumentParser(
+        prog="pktfmt",
+        description="Generate RFC-style ASCII packet diagrams from field definitions.",
+        epilog="""
+Examples:
+  pktfmt "Type:16,Length:16,Payload:*"
+  pktfmt packet.json
+  pktfmt "Type:16,Data:32" --bits-per-row 16
+        """,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument(
+        "input",
+        help="Field definition (inline 'Name:bits,...' format) or path to JSON file",
+    )
+
+    parser.add_argument(
+        "-b", "--bits-per-row",
+        type=int,
+        default=32,
+        metavar="N",
+        help="Number of bits per row (default: 32)",
+    )
+
+    parser.add_argument(
+        "--no-ruler",
+        action="store_true",
+        help="Omit the bit number header",
+    )
+
+    parser.add_argument(
+        "-v", "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    return parser
+
+
+def main(argv: Optional[List[str]] = None) -> int:
+    """Main entry point for the CLI.
+
+    Args:
+        argv: Command-line arguments (defaults to sys.argv[1:])
+
+    Returns:
+        Exit code (0 for success, non-zero for errors)
+    """
+    parser = create_parser()
+    args = parser.parse_args(argv)
+
+    try:
+        fields = parse_input(args.input)
+        diagram = render_diagram(
+            fields,
+            bits_per_row=args.bits_per_row,
+            show_ruler=not args.no_ruler,
+        )
+        print(diagram)
+        return 0
+    except FileNotFoundError as e:
+        print(f"Error: {e}", file=sys.stderr)
+        return 1
+    except ValueError as e:
+        print(f"Error: {e}", file=sys.stderr)
+        return 1
+    except Exception as e:
+        print(f"Unexpected error: {e}", file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pktfmt-0.1.0/pktfmt/parser.py

@@ -0,0 +1,142 @@
+"""Parse packet field definitions from inline strings and JSON files."""
+
+import json
+from pathlib import Path
+from typing import List, Union
+
+
+class Field:
+    """Represents a packet field with a name and bit width."""
+
+    def __init__(self, name: str, bits: Union[int, str]):
+        self.name = name
+        self.bits = bits  # int for fixed width, "*" for variable
+
+    @property
+    def is_variable(self) -> bool:
+        return self.bits == "*"
+
+    def __repr__(self) -> str:
+        return f"Field({self.name!r}, {self.bits!r})"
+
+
+def parse_inline(definition: str) -> List[Field]:
+    """Parse inline format: 'Name:bits,Name:bits,Name:*'
+
+    Args:
+        definition: Comma-separated field definitions
+
+    Returns:
+        List of Field objects
+
+    Raises:
+        ValueError: If the format is invalid
+    """
+    fields = []
+
+    for part in definition.split(","):
+        part = part.strip()
+        if not part:
+            continue
+
+        if ":" not in part:
+            raise ValueError(f"Invalid field format: '{part}' (expected 'Name:bits')")
+
+        name, bits_str = part.rsplit(":", 1)
+        name = name.strip()
+        bits_str = bits_str.strip()
+
+        if not name:
+            raise ValueError(f"Field name cannot be empty: '{part}'")
+
+        if bits_str == "*":
+            bits = "*"
+        else:
+            try:
+                bits = int(bits_str)
+                if bits <= 0:
+                    raise ValueError(f"Bit width must be positive: '{part}'")
+            except ValueError:
+                raise ValueError(f"Invalid bit width: '{bits_str}' in '{part}'")
+
+        fields.append(Field(name, bits))
+
+    if not fields:
+        raise ValueError("No fields defined")
+
+    return fields
+
+
+def parse_json(json_input: Union[str, Path]) -> List[Field]:
+    """Parse JSON format for packet definition.
+
+    Args:
+        json_input: JSON string or path to JSON file
+
+    Returns:
+        List of Field objects
+
+    Raises:
+        ValueError: If the JSON format is invalid
+    """
+    # Try to load as file first
+    if isinstance(json_input, Path) or (isinstance(json_input, str) and not json_input.strip().startswith("{")):
+        path = Path(json_input)
+        if path.exists():
+            with open(path, "r", encoding="utf-8") as f:
+                data = json.load(f)
+        else:
+            raise FileNotFoundError(f"File not found: {json_input}")
+    else:
+        data = json.loads(json_input)
+
+    if not isinstance(data, dict):
+        raise ValueError("JSON must be an object with a 'fields' array")
+
+    if "fields" not in data:
+        raise ValueError("JSON must contain a 'fields' array")
+
+    fields = []
+    for i, field_data in enumerate(data["fields"]):
+        if not isinstance(field_data, dict):
+            raise ValueError(f"Field {i} must be an object")
+
+        if "name" not in field_data:
+            raise ValueError(f"Field {i} missing 'name'")
+
+        if "bits" not in field_data:
+            raise ValueError(f"Field {i} missing 'bits'")
+
+        name = field_data["name"]
+        bits = field_data["bits"]
+
+        if bits != "*" and not isinstance(bits, int):
+            raise ValueError(f"Field '{name}': bits must be an integer or '*'")
+
+        if isinstance(bits, int) and bits <= 0:
+            raise ValueError(f"Field '{name}': bit width must be positive")
+
+        fields.append(Field(name, bits))
+
+    if not fields:
+        raise ValueError("No fields defined")
+
+    return fields
+
+
+def parse_input(input_str: str) -> List[Field]:
+    """Auto-detect and parse input format (inline or JSON file).
+
+    Args:
+        input_str: Either an inline definition or a path to a JSON file
+
+    Returns:
+        List of Field objects
+    """
+    # Check if it's a file path
+    path = Path(input_str)
+    if path.exists() and path.suffix.lower() == ".json":
+        return parse_json(path)
+
+    # Otherwise treat as inline format
+    return parse_inline(input_str)

pktfmt-0.1.0/pktfmt/renderer.py

@@ -0,0 +1,158 @@
+"""Render ASCII packet diagrams in RFC style."""
+
+from typing import List, Optional
+from .parser import Field
+
+
+def render_diagram(fields: List[Field], bits_per_row: int = 32, show_ruler: bool = True) -> str:
+    """Render fields as an RFC-style ASCII packet diagram.
+
+    Args:
+        fields: List of Field objects to render
+        bits_per_row: Number of bits per row (default 32)
+        show_ruler: Whether to show the bit number header
+
+    Returns:
+        ASCII diagram string
+    """
+    lines = []
+
+    # Generate ruler
+    if show_ruler:
+        lines.extend(_generate_ruler(bits_per_row))
+
+    # Build list of rows, each row is list of (name, width, is_variable, is_continuation)
+    rows = []
+    current_row = []
+    current_bit = 0
+
+    for field in fields:
+        if field.is_variable:
+            # Flush current row if any
+            if current_row:
+                rows.append(current_row)
+                current_row = []
+                current_bit = 0
+
+            # Variable field gets its own full-width row
+            rows.append([(field.name, bits_per_row, True, False)])
+        else:
+            bits_remaining = field.bits
+            is_first_part = True
+
+            while bits_remaining > 0:
+                space_in_row = bits_per_row - current_bit
+
+                if bits_remaining <= space_in_row:
+                    # Field fits in current row
+                    current_row.append((field.name, bits_remaining, False, not is_first_part))
+                    current_bit += bits_remaining
+                    bits_remaining = 0
+
+                    # If row is complete, flush it
+                    if current_bit == bits_per_row:
+                        rows.append(current_row)
+                        current_row = []
+                        current_bit = 0
+                else:
+                    # Field spans to next row
+                    current_row.append((field.name, space_in_row, False, not is_first_part))
+                    rows.append(current_row)
+                    current_row = []
+                    current_bit = 0
+                    bits_remaining -= space_in_row
+                    is_first_part = False
+
+    # Flush any remaining partial row
+    if current_row:
+        rows.append(current_row)
+
+    # Render rows
+    separator = "+" + "-+" * bits_per_row
+    prev_continues_to_next = False
+
+    for i, row in enumerate(rows):
+        row_width = sum(f[1] for f in row)
+        is_full_row = row_width == bits_per_row
+        has_variable = any(f[2] for f in row)
+
+        # Check if first field in this row is a continuation
+        first_is_continuation = row[0][3] if row else False
+
+        # Check if last field continues to next row
+        continues_to_next = False
+        if i + 1 < len(rows) and row:
+            next_row = rows[i + 1]
+            if next_row and next_row[0][3]:  # Next row's first field is continuation
+                continues_to_next = True
+
+        # Add separator (skip if this row continues from previous)
+        if not first_is_continuation:
+            if is_full_row:
+                lines.append(separator)
+            else:
+                lines.append("+" + "-+" * row_width)
+            # Render the row content
+            lines.append(_render_field_row(row, bits_per_row, has_variable))
+        else:
+            # Continuation row - just side borders, blank inside (no separator, no content row)
+            lines.append("|" + " " * (bits_per_row * 2 - 1) + "|")
+
+        prev_continues_to_next = continues_to_next
+
+    # Final separator
+    if rows:
+        last_row = rows[-1]
+        last_width = sum(f[1] for f in last_row)
+        lines.append("+" + "-+" * last_width)
+
+    return "\n".join(lines)
+
+
+def _generate_ruler(bits_per_row: int) -> List[str]:
+    """Generate the bit number ruler header."""
+    # First line: byte markers (0, 1, 2, 3 for 32-bit)
+    byte_line = " "
+    for byte_num in range(bits_per_row // 8):
+        byte_line += f"{byte_num:<19}"
+    byte_line = byte_line[:bits_per_row * 2]
+
+    # Second line: bit numbers within each byte (0-9, repeating)
+    bit_line = " "
+    for i in range(bits_per_row):
+        bit_line += f"{i % 10} "
+    bit_line = bit_line.rstrip()
+
+    return [byte_line.rstrip(), bit_line]
+
+
+def _render_field_row(row_fields: List[tuple], bits_per_row: int, has_variable: bool) -> str:
+    """Render a single row of fields.
+
+    Args:
+        row_fields: List of (name, width, is_variable, is_continuation) tuples
+        bits_per_row: Number of bits per row
+        has_variable: Whether this row contains a variable-length field
+
+    Returns:
+        Rendered row string
+    """
+    border = ":" if has_variable else "|"
+    result = border
+
+    for name, width, is_var, is_continuation in row_fields:
+        cell_width = width * 2 - 1
+
+        if is_continuation:
+            # Show blank or continuation indicator for multi-row fields
+            display_name = " " * cell_width
+        else:
+            # Center the name
+            if len(name) > cell_width:
+                display_name = name[:cell_width]
+            else:
+                display_name = name.center(cell_width)
+
+        result += display_name + border
+
+    return result

pktfmt-0.1.0/pktfmt.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: pktfmt
+Version: 0.1.0
+Summary: Generate RFC-style ASCII packet diagrams from field definitions
+License-Expression: MIT
+Keywords: packet,diagram,ascii,rfc,network,protocol
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# pktfmt
+
+Generate RFC-style ASCII packet diagrams from field definitions.
+
+## Installation
+
+```bash
+pip install pktfmt
+```
+
+## Usage
+
+### Inline format
+
+```bash
+pktfmt "Type:16,Length:16,Payload:*"
+```
+
+Output:
+```
+ 0                  1                  2                  3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|              Type             |             Length            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+:                            Payload                            :
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+### JSON file
+
+```bash
+pktfmt packet.json
+```
+
+```json
+{
+  "name": "MyPacket",
+  "fields": [
+    {"name": "Type", "bits": 16},
+    {"name": "Length", "bits": 16},
+    {"name": "Payload", "bits": "*"}
+  ]
+}
+```
+
+### Options
+
+```bash
+pktfmt "Type:16,Data:32" --bits-per-row 16   # Custom row width
+pktfmt "Type:32" --no-ruler                   # Omit bit number header
+```
+
+## Field syntax
+
+- `Name:N` - Fixed-width field of N bits
+- `Name:*` - Variable-length field (rendered with `:` borders)
+
+## License
+
+MIT

pktfmt-0.1.0/pktfmt.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+pktfmt/__init__.py
+pktfmt/__main__.py
+pktfmt/cli.py
+pktfmt/parser.py
+pktfmt/renderer.py
+pktfmt.egg-info/PKG-INFO
+pktfmt.egg-info/SOURCES.txt
+pktfmt.egg-info/dependency_links.txt
+pktfmt.egg-info/entry_points.txt
+pktfmt.egg-info/top_level.txt

pktfmt-0.1.0/pktfmt.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pktfmt-0.1.0/pktfmt.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pktfmt = pktfmt.cli:main

pktfmt-0.1.0/pktfmt.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+pktfmt

pktfmt-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pktfmt"
+version = "0.1.0"
+description = "Generate RFC-style ASCII packet diagrams from field definitions"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = ["packet", "diagram", "ascii", "rfc", "network", "protocol"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: System :: Networking",
+]
+
+[project.scripts]
+pktfmt = "pktfmt.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["."]

pktfmt-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+