pkt-builder 0.1.0__py3-none-any.whl

pkt_builder/__init__.py

@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""pkt_builder -- build Packet Tracer .pkt files from a YAML description.
+
+Modules
+-------
+``miniyaml``  dependency-free YAML subset parser (no ``pip install`` needed)
+``config``    the YAML schema: normalisation and validation
+``ports``     per-model port catalogues, abbreviated-name resolution
+``builder``   LabSpec -> .pkt (the verified add/link/power/config order)
+``verify``    structural checks that predict "Incompatible File"
+``exporter``  .pkt -> YAML
+``resources`` access to the bundled donors and the acceptance harness
+``cli``       command line interface (the ``pkt-builder`` script)
+
+The vendored ``pkt_core`` library lives in ``pkt_builder/_vendor/pkt_core/``
+(GPL-3.0-or-later, unmodified upstream); this module puts
+``pkt_builder/_vendor`` on ``sys.path`` so the rest of the package can simply
+``import pkt_core``.  ``pkt_core`` uses absolute imports internally
+(``from pkt_core.x import y``), so keeping the upstream package name is the
+smallest possible shim.
+"""
+import pathlib
+import sys
+
+_HERE = pathlib.Path(__file__).resolve().parent
+
+_candidate = _HERE / "_vendor"
+if (_candidate / "pkt_core" / "__init__.py").is_file():
+    _path = str(_candidate)
+    if _path not in sys.path:
+        sys.path.insert(0, _path)
+
+from pkt_builder.config import ConfigError, DeviceSpec, LabSpec, LinkSpec, parse_spec
+from pkt_builder.ports import PortError, port_catalogue, resolve_port
+
+__all__ = [
+    "ConfigError",
+    "DeviceSpec",
+    "LabSpec",
+    "LinkSpec",
+    "PortError",
+    "parse_spec",
+    "port_catalogue",
+    "resolve_port",
+]
+
+__version__ = "0.1.0"

pkt_builder/__main__.py

@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""``python -m pkt_builder`` -- run the command line interface."""
+
+import sys
+
+from pkt_builder.cli import main
+
+if __name__ == "__main__":
+    try:
+        sys.exit(main())
+    except KeyboardInterrupt:
+        print("\ninterrupted", file=sys.stderr)
+        sys.exit(130)

pkt_builder/_vendor/__init__.py

@@ -0,0 +1,7 @@
+"""Third-party code vendored into pkt_builder.
+
+``pkt_core`` is bundled here so that ``pip install pkt-builder`` brings
+everything needed to read and write ``.pkt`` files.  It is unmodified upstream
+code and keeps its own ``pkt_core`` package name; :mod:`pkt_builder` puts this
+directory on ``sys.path`` before importing anything from it.
+"""

pkt_builder/_vendor/pkt_core/__init__.py

@@ -0,0 +1,83 @@
+"""pkt-core — type-safe reader/writer for Cisco Packet Tracer ``.pkt``/``.pka`` files.
+
+Library entry point. Everything needed to open, inspect, modify and re-write a
+Packet Tracer save file is re-exported here; the CLI is a separate, thin consumer
+and is never imported by this package.
+
+Quick start::
+
+    from pkt_core import decode, encode_bytes
+
+    container = decode("lab.pkt")          # verifier-based format detection
+    print(container.root_tag)              # 'PACKETTRACER5'
+    xml = container.xml                    # the inner XML document
+    rebuilt = encode_bytes(xml, container.format_name)
+
+The container is fully deterministic (fixed key + fixed IV), so re-encoding the
+same XML yields the same bytes.
+"""
+
+from __future__ import annotations
+
+from pkt_core.codec.container import (
+    DEFAULT_FORMAT,
+    Container,
+    decode,
+    decode_bytes,
+    detect_format,
+    encode,
+    encode_bytes,
+    root_tag,
+)
+from pkt_core.codec.qcompress import qcompress, quncompress
+from pkt_core.crypto.keys import FORMATS, BLOCK_SIZE, TAG_SIZE, FormatSpec, get_format
+from pkt_core.crypto.primitives import eax_open, eax_seal, eax_verify
+from pkt_core.errors import (
+    CompressionError,
+    FormatError,
+    IntegrityError,
+    PacketTracerError,
+    TruncatedFileError,
+    UnsupportedCipherError,
+)
+
+from pkt_core.builder import Lab, Layout, load_templates
+
+__version__ = "0.4.1"
+
+__all__ = [
+    # container
+    "Container",
+    "decode",
+    "decode_bytes",
+    "encode",
+    "encode_bytes",
+    "detect_format",
+    "root_tag",
+    "DEFAULT_FORMAT",
+    # key schedule
+    "FORMATS",
+    "FormatSpec",
+    "get_format",
+    "BLOCK_SIZE",
+    "TAG_SIZE",
+    # crypto primitives
+    "eax_seal",
+    "eax_open",
+    "eax_verify",
+    # framing
+    "qcompress",
+    "quncompress",
+    # errors
+    "PacketTracerError",
+    "FormatError",
+    "IntegrityError",
+    "TruncatedFileError",
+    "CompressionError",
+    "UnsupportedCipherError",
+    "__version__",
+    # authoring (imported last: the builder imports the codec above)
+    "Lab",
+    "Layout",
+    "load_templates",
+]