tzBJC 0.2.16

Convert binary files to signed JSON and back, with zstd compression.

tzBJC - TaggedZ's Binary to JSON Converter

tzBJC is a utility for encoding and decoding binary files to signed JSON format with Zstandard compression. It provides both a command-line interface (CLI) and a graphical user interface (GUI) built with PySide6.

---

✨ Features

• 🔐 Encodes binary files into signed JSON format
• 🔌 Library for easy integration into other projects
• 🧩 Uses Zstandard compression with Base64 URL-safe encoding
• 📦 CLI and GUI support
• ✅ Stream-based processing for large files
• 📋 Clipboard-friendly JSON output (via GUI)
• 🧪 Thorough test coverage with Pytest and Pytest-Qt

---

The Process

[Original Binary File]
        |
        |  (1. Read binary content)
        v
[SHA-256 Digest (hex string)]
        |
        |  (2. Compute SHA-256 of compressed data)
        v
[Binary Content]
        |
        |  (3. Compress using Zstandard)
        v
[Zstandard Compressed Binary Content]
        |
        |  (4. Encode with base64-url-safe)
        v
      [JSON File | stdout | StringIO | Clipboard-friendly JSON format (GUI)]
        {
          "filename": "example.bin",
          "data": "<zstd compressed base64 string>",
          "sha256": "<hash of original data>"
        }

--- Later ---

      [JSON File]
        |
        |  (5. Extract compressed base64 + hash)
        v
[Base64-urlsafe String]
        |
        |  (6. Decode base64-urlsafe)
        v
[Compressed Data]
        |
        |  (7. Decompress with Zstandard)
        v
       [Valid?]
        |
        |  (7. Verify checksum)
        v
[Original Binary Data]
        |
        |  (8. Write to output path)
        v
[Restored Binary File]

📦 Installation

pip install tzBJC

Or from source:

git clone https://github.com/taggedzi/tzBJC.git
cd tzBJC
pip install .

---

🖥️ Command Line Usage

See CLI help:

tzBJC-cli --help

Encode example:

tzBJC-cli encode -i input.bin -o output.json

Decode example:

tzBJC-cli decode -i output.json -o restored.bin

---

🪟 GUI Usage

tzBJC-gui

Drag-and-drop or select binary or JSON files to convert between formats. The GUI supports:

• File output
• Clipboard-friendly output
• Overwrite protection (with force option)

---

🛠 Developer Instructions

Set up a local development environment:

git clone https://github.com/taggedzi/tzBJC.git
cd tzBJC
python -m venv .venv
source .venv/bin/activate  # on Windows: .venv\Scripts\activate
pip install -e .[dev]

Run tests with coverage:

pytest --cov=src

Build the package:

python -m build

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🌐 Links

• 📦 PyPI Project Page
• 🐙 GitHub Repository
• 🗃️ Project README
• 📖 Documentation