sltgui 0.2.0__tar.gz

sltgui-0.2.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: fangface-hub

sltgui-0.2.0/.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,43 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract version from pyproject.toml
+        id: version
+        run: |
+          VERSION=$(grep -m1 '^version = "' pyproject.toml | sed -E 's/^version = "([^"]+)"$/\1/')
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "tag=v$VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: dist
+
+      - name: Create GitHub release and upload artifacts
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.version.outputs.tag }}
+          name: ${{ steps.version.outputs.tag }}
+          generate_release_notes: true
+          files: |
+            dist/*.tar.gz
+            dist/*.whl

sltgui-0.2.0/.github/workflows/publish_to_testpypi.yml

@@ -0,0 +1,24 @@
+name: Publish to TestPyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build wheel
+        run: uv build
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: dist

sltgui-0.2.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# sltgui
+setting.json

sltgui-0.2.0/.python-version

@@ -0,0 +1 @@
+3.14

sltgui-0.2.0/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Pytest (single test)",
+            "type": "python",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "-k", "${input:test_name}"
+            ],
+            "console": "integratedTerminal"
+        }
+    ],
+    "inputs": [
+        {
+            "id": "test_name",
+            "type": "promptString",
+            "description": "Enter pytest -k expression",
+            "default": "test_bits_get_cross_byte"
+        }
+    ]
+}

sltgui-0.2.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/Scripts/python.exe"
+}

sltgui-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fangface
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sltgui-0.2.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.5
+Name: sltgui
+Version: 0.2.0
+Summary: GUI for visualizing and inspecting binary structure layouts defined by StructLayoutToolkit. Provides a hierarchical tree view, precise offset/size display, and interactive inspection of parsed struct instances.
+Project-URL: Homepage, https://github.com/fangface-hub/StructLayoutToolkitGui
+Project-URL: Documentation, https://readthedocs.org
+Project-URL: Repository, https://github.com/fangface-hub/StructLayoutToolkitGui
+Project-URL: Issues, https://github.com/fangface-hub/StructLayoutToolkitGui/issues
+Author: fangface
+License-Expression: MIT
+License-File: LICENSE
+Keywords: byte,deserialization,layout,serialization,struct
+Requires-Python: >=3.14
+Requires-Dist: sltcalc>=0.1.0
+Requires-Dist: sltcodec>=2.1.0
+Requires-Dist: sltcore>=1.5.0
+Requires-Dist: tkinterex>=1.1.3
+Requires-Dist: treeviewex>=1.0.2
+Description-Content-Type: text/markdown
+
+# StructLayoutToolkitGui
+
+StructLayoutToolkitGui is a desktop application for inspecting and editing
+binary files using structure layouts defined by the StructLayoutToolkit
+ecosystem. It combines a hierarchical binary viewer with editors for structure
+and enumeration definitions.
+
+## Features
+
+- Decode binary files with a selected `StructDef`.
+- Display field offsets, raw bytes, names, types, values, and sizes.
+- Inspect nested structures in a hierarchical tree view.
+- Edit decoded field values and encode them back to binary data.
+- View and edit raw hexadecimal data when no structure is selected.
+- Create and edit `StructDef` and `EnumDef` dictionaries.
+- Re-decode loaded data after changing type definitions.
+- Open, save, and save-as both binary and StructLayout files.
+- Configure the number of bytes shown per row in raw mode.
+
+## Requirements
+
+- Python 3.14 or later
+- Tkinter support in the Python installation
+
+Tkinter is included with standard Python installations on Windows and macOS.
+Some Linux distributions provide it as a separate system package.
+
+## Installation
+
+Install the package from PyPI:
+
+```console
+python -m pip install sltgui
+```
+
+## Running the Application
+
+Start the binary editor with:
+
+```console
+python -m sltgui.binary_editor_window
+```
+
+## Basic Workflow
+
+1. Open a StructLayout JSON file from **Type Definition > Open StructLayout**.
+2. Open a binary file from **File > Open Binary**.
+3. Double-click a value cell to edit a decoded field.
+4. Use **Re-decode** after updating Struct or Enum definitions.
+5. Save changes with **Save Binary** or choose a new destination with **Save Binary As**.
+
+The files may also be opened in the opposite order. A binary opened without a
+layout is shown in raw mode and is decoded when a valid StructLayout is loaded.
+
+Static offsets and sizes use `byte,bit` notation. For example, `4,0` represents
+four bytes and `0,3` represents three bits.
+
+## Using the Window from Python
+
+The GUI classes are also available as a Python API:
+
+```python
+import tkinter as tk
+
+from sltgui import BinaryEditorWindow
+
+root = tk.Tk()
+root.withdraw()
+window = BinaryEditorWindow(root)
+window.protocol("WM_DELETE_WINDOW", root.destroy)
+root.mainloop()
+```
+
+The package exports `BinaryEditorWindow`, `StructDefDictEditor`, and
+`EnumDefDictEditor`.
+
+## Related Projects
+
+StructLayoutToolkitGui uses the following StructLayoutToolkit packages:
+
+- `sltcore` for core structure and size types
+- `sltcodec` for StructLayout serialization and binary encoding/decoding
+- `sltcalc` for expression evaluation
+
+## Links
+
+- [Source code](https://github.com/fangface-hub/StructLayoutToolkitGui)
+- [Issue tracker](https://github.com/fangface-hub/StructLayoutToolkitGui/issues)
+- [Developer documentation](https://github.com/fangface-hub/StructLayoutToolkitGui/blob/main/README.md)
+
+## License
+
+StructLayoutToolkitGui is distributed under the MIT License.

sltgui-0.2.0/README.md

@@ -0,0 +1,136 @@
+# StructLayoutToolkitGui
+
+StructLayoutToolkitGui is a Tkinter application for viewing and editing binary
+data using structure layouts defined with StructLayoutToolkit. It also provides
+GUI editors for structure and enumeration definitions.
+
+## Development Environment
+
+- Python 3.14 or later
+- [uv](https://docs.astral.sh/uv/)
+- A Python environment with Tkinter support
+
+The project depends on SltCore for structure definitions, SltCodec for encoding
+and decoding, and SltCalc for expression evaluation. See `pyproject.toml` for
+the exact version requirements.
+
+### Setup
+
+```powershell
+git clone https://github.com/fangface-hub/StructLayoutToolkitGui.git
+Set-Location StructLayoutToolkitGui
+uv sync
+```
+
+### Run
+
+```powershell
+uv run python -m sltgui.binary_editor_window
+```
+
+### Test
+
+Run the complete test suite:
+
+```powershell
+uv run pytest -q
+```
+
+To run a specific test file:
+
+```powershell
+uv run pytest tests/test_binary_editor_window.py -q
+```
+
+## Source Layout
+
+| Path | Responsibility |
+| --- | --- |
+| `src/sltgui/binary_editor_window.py` | Main window for opening, decoding, editing, encoding, and saving binary data |
+| `src/sltgui/struct_def_dict_editor.py` | Modal editor for the `StructDef` dictionary |
+| `src/sltgui/enum_def_dict_editor.py` | Modal editor for the `EnumDef` dictionary |
+| `src/sltgui/__init__.py` | Public API with lazy imports for the GUI classes |
+| `tests/` | Unit tests with GUI dependencies replaced by stubs |
+
+The package exposes three public classes:
+
+```python
+from sltgui import BinaryEditorWindow, EnumDefDictEditor, StructDefDictEditor
+```
+
+## Data Flow
+
+1. Load a `StructLayout` JSON file to obtain its `TypeDict` and selected `StructDef`.
+2. Pass the binary data to `decode()` to create a `StructInstance`.
+3. Render `StructInstance.field_instances` in the tree view.
+4. When a value is edited, convert its text back to the original value type and create a new field with `FieldInstance.with_value()`.
+5. Pass the updated instance to `encode()`, then call `decode()` again to keep the display and derived data synchronized.
+
+The `Update` action in the Struct and Enum definition editors updates the shared
+`TypeDict`, but it does not automatically rebuild an existing `StructInstance`.
+Use `Re-decode` in the main window after changing definitions.
+
+## Implementation Notes
+
+### Updating Instances
+
+`FieldInstance` is immutable. Replacing only its value with
+`dataclasses.replace()` can leave derived data such as `enum_item` out of date.
+Always use `FieldInstance.with_value(value, type_dict)` when changing a value.
+
+For nested structures, rebuild each object from the target `FieldInstance` up
+to the parent `StructInstance`. See
+`BinaryEditorWindow._replace_instance_value()` for the current implementation.
+
+### InfoSize
+
+Static offsets and sizes are stored as `InfoSize` objects. The GUI displays and
+accepts them in `byte,bit` format. For example, four bytes are written as `4,0`
+and three bits as `0,3`. Offsets and sizes may also contain expression strings,
+so do not unconditionally coerce every value to `InfoSize`.
+
+### TreeviewEx
+
+Use numeric column IDs such as `#1` and `#2`, rather than column names, when
+configuring editable, read-only, or combobox cells. When adding or reordering
+columns, update the corresponding column ID constants and tests.
+
+### Saving Files
+
+`Save` overwrites the currently open file or the file most recently selected
+with `Save As`. For new data without a destination, it falls back to `Save As`.
+`BinaryEditorWindow.binary_file` and `struct_layout_file` track the current
+paths.
+
+## Verifying Changes
+
+Run the tests for the affected area first, followed by the complete test suite.
+When changing GUI state transitions, verify at least these workflows:
+
+- Open a StructLayout, then open a binary file.
+- Open a binary file in raw mode, then open a StructLayout.
+- Update Struct or Enum definitions, then use `Re-decode`.
+- Edit a value, then save the binary file.
+- Use `Save` to overwrite an open file.
+
+## Build and Release
+
+The project uses Hatchling to build distributions:
+
+```powershell
+uv build
+```
+
+PowerShell scripts are available for version updates:
+
+```powershell
+./bump_patch.ps1
+./bump_minor.ps1
+./bump_major.ps1
+```
+
+The workflows in `.github/workflows/` publish manually to TestPyPI or PyPI. The
+PyPI workflow creates a tag and GitHub Release from the version in
+`pyproject.toml`, then attaches the wheel and source distribution. Before
+publishing, verify the version, run the complete test suite, and inspect the
+artifacts produced by `uv build`.

sltgui-0.2.0/README_pypi.md

@@ -0,0 +1,93 @@
+# StructLayoutToolkitGui
+
+StructLayoutToolkitGui is a desktop application for inspecting and editing
+binary files using structure layouts defined by the StructLayoutToolkit
+ecosystem. It combines a hierarchical binary viewer with editors for structure
+and enumeration definitions.
+
+## Features
+
+- Decode binary files with a selected `StructDef`.
+- Display field offsets, raw bytes, names, types, values, and sizes.
+- Inspect nested structures in a hierarchical tree view.
+- Edit decoded field values and encode them back to binary data.
+- View and edit raw hexadecimal data when no structure is selected.
+- Create and edit `StructDef` and `EnumDef` dictionaries.
+- Re-decode loaded data after changing type definitions.
+- Open, save, and save-as both binary and StructLayout files.
+- Configure the number of bytes shown per row in raw mode.
+
+## Requirements
+
+- Python 3.14 or later
+- Tkinter support in the Python installation
+
+Tkinter is included with standard Python installations on Windows and macOS.
+Some Linux distributions provide it as a separate system package.
+
+## Installation
+
+Install the package from PyPI:
+
+```console
+python -m pip install sltgui
+```
+
+## Running the Application
+
+Start the binary editor with:
+
+```console
+python -m sltgui.binary_editor_window
+```
+
+## Basic Workflow
+
+1. Open a StructLayout JSON file from **Type Definition > Open StructLayout**.
+2. Open a binary file from **File > Open Binary**.
+3. Double-click a value cell to edit a decoded field.
+4. Use **Re-decode** after updating Struct or Enum definitions.
+5. Save changes with **Save Binary** or choose a new destination with **Save Binary As**.
+
+The files may also be opened in the opposite order. A binary opened without a
+layout is shown in raw mode and is decoded when a valid StructLayout is loaded.
+
+Static offsets and sizes use `byte,bit` notation. For example, `4,0` represents
+four bytes and `0,3` represents three bits.
+
+## Using the Window from Python
+
+The GUI classes are also available as a Python API:
+
+```python
+import tkinter as tk
+
+from sltgui import BinaryEditorWindow
+
+root = tk.Tk()
+root.withdraw()
+window = BinaryEditorWindow(root)
+window.protocol("WM_DELETE_WINDOW", root.destroy)
+root.mainloop()
+```
+
+The package exports `BinaryEditorWindow`, `StructDefDictEditor`, and
+`EnumDefDictEditor`.
+
+## Related Projects
+
+StructLayoutToolkitGui uses the following StructLayoutToolkit packages:
+
+- `sltcore` for core structure and size types
+- `sltcodec` for StructLayout serialization and binary encoding/decoding
+- `sltcalc` for expression evaluation
+
+## Links
+
+- [Source code](https://github.com/fangface-hub/StructLayoutToolkitGui)
+- [Issue tracker](https://github.com/fangface-hub/StructLayoutToolkitGui/issues)
+- [Developer documentation](https://github.com/fangface-hub/StructLayoutToolkitGui/blob/main/README.md)
+
+## License
+
+StructLayoutToolkitGui is distributed under the MIT License.