basebender 0.1.5__tar.gz

basebender-0.1.5/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 @mexc
+
+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.

basebender-0.1.5/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.3
+Name: basebender
+Version: 0.1.5
+Summary: A Python module for rebaseing strings between different digit sets (positional number systems).
+License: MIT License
+         
+         Copyright 2025 @mexc
+         
+         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.
+Author: by.a.mexc@gmail.com
+Requires-Python: >=3.13,<3.14
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: fastapi (>=0.115.12,<0.116.0)
+Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
+Requires-Dist: pyside6 (>=6.9.0,<7.0.0)
+Requires-Dist: pytest (>=8.3.5,<9.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: uvicorn (>=0.34.3,<0.35.0)
+Project-URL: Homepage, https://github.com/meXc/BaseBender
+Project-URL: Issues, https://github.com/meXc/BaseBender/issues
+Project-URL: Repository, https://github.com/meXc/BaseBender.git
+Description-Content-Type: text/markdown
+
+# BaseBender
+
+This project provides a Python module for rebaseing strings between different digit sets (positional number systems). It also includes a command-line interface (CLI) for easy usage.
+
+![Screenshot of the GUI. Shows example conversion](./docs/gui-main.png)
+
+## Project Goal
+n
+The primary goal is to provide a flexible and efficient tool for rebaseing numbers between different digit sets.
+
+## Features
+
+*   **Flexible Digit Set Definition**: Define source and target digit sets using simple strings, supporting rebaseing between standard and non-standard positional number systems (e.g., different Unicode symbol sets of varying lengths).
+*   **Tiered Configuration for Digit Sets**: Load pre-defined digit sets from package, system, and user-specific TOML configuration files, allowing for easy extension and customization.
+*   **Intelligent Digit Set Discovery**: Suggests relevant pre-defined digit sets based on the input string's content, enhancing usability for the GUI.
+*   **Dynamic Input Digit Set**: Automatically derives the input digit set from the input string if not explicitly provided. In the GUI, selecting "Derived from Input" from the preset dropdown will populate the input digit set field with the currently derived digit set. When the input digit set field is empty and the input string is not empty, its placeholder text will dynamically display the derived digit set from the input string, along with a visual cue. If both the input string and input digit set field are empty, the default placeholder text will be shown.
+*   **Efficient Rebaseing**: Utilizes bit-packing to minimize space during intermediate rebase.
+*   **Enhanced Error Handling**: Provides clear and informative error messages across CLI, API, and GUI, with structured error responses for the API.
+*   **Command-Line Interface (CLI)**: Rebase strings directly from the terminal with improved help text and error reporting.
+*   **Graphical User Interface (GUI)**: An intuitive interface for rebaseing, featuring digit set manipulation, tooltips, and a clear status bar for error messages.
+*   **Flexible Rebase Behavior**: Handles empty input strings, empty output digit sets, and single-character output digit sets gracefully.
+
+## Installation
+
+1.  **Clone the repository**:
+    ```bash
+    git clone https://github.com/mexc/base-bender.git
+    cd base-bender
+    ```
+
+2.  **Install Poetry**:
+    If you don't have Poetry installed, follow the instructions on its official website: [https://python-poetry.org/docs/#installation](https://python-poetry.org/docs/#installation)
+
+3.  **Install dependencies using Poetry**:
+    ```bash
+    poetry install
+    ```
+    This will create a virtual environment and install all project dependencies, including `pytest` and `toml`.
+
+    After installing dependencies, run the update script to generate the GUI asset source files:
+
+    ```bash
+    ./bin/update
+    ```
+## Running the Application
+
+This project provides several entry points for different interfaces: a command-line interface (CLI), a graphical user interface (GUI), and a web API. You can run them using Poetry scripts:
+
+*   **Command-Line Interface (CLI)**:
+    ```bash
+    poetry run basebender --help
+    ```
+    This will display the help message for the CLI. For detailed usage examples, refer to [CLI Examples](docs/cli_examples.md).
+
+*   **Graphical User Interface (GUI)**:
+    ```bash
+    poetry run basebender-gui
+    ```
+    This will launch the desktop application.
+
+*   **Web API**:
+    ```bash
+    poetry run basebender-api
+    ```
+    This will start the FastAPI server, typically accessible at `http://127.0.0.1:8000`. For detailed API usage examples, refer to [API Examples](docs/api_examples.md).
+
+## Configuration
+
+The BaseBender supports loading pre-defined digit sets from tiered TOML configuration files. This allows for a flexible and extensible way to manage common digit sets.
+
+### Configuration File Locations (in order of precedence: User > System > Package)
+
+*   **Package Configuration**:
+    *   Location: `rebaser/resources/data/default_digit_sets.toml` within the installed package.
+    *   Purpose: Contains a comprehensive set of standard, built-in digit sets (e.g., Binary, Decimal, Hexadecimal, Base64, ASCII Printable).
+    *   Example content:
+        ```toml
+        [[digit_sets]]
+        name = "Binary"
+        digits = "01"
+
+        [[digit_sets]]
+        name = "Decimal"
+        digits = "0123456789"
+        ```
+
+*   **System Configuration**:
+    *   Location (Linux/macOS): `/etc/digit_set_rebaser/digit_sets.toml`
+    *   Location (Windows): `%PROGRAMDATA%\digit_set_rebaser\digit_sets.toml`
+    *   Purpose: Allows system administrators to define digit sets available to all users on the system.
+
+*   **User Configuration**:
+    *   Location (Linux/macOS): `~/.config/digit_set_rebaser/digit_sets.toml`
+    *   Location (Windows): `%APPDATA%\digit_set_rebaser\digit_sets.toml`
+    *   Purpose: Allows individual users to define their own custom digit sets or override system/package defaults.
+
+### Adding Custom Digit Sets
+
+To add your own custom digit sets, create or edit the `digit_sets.toml` file in your user configuration directory (or system directory for system-wide availability). Follow the TOML format shown in the example above. Digit sets defined in higher precedence tiers will override those with the same `name` in lower tiers.
+
+## Usage
+
+For detailed CLI usage examples, refer to [CLI Examples](docs/cli_examples.md).
+For detailed API usage examples, refer to [API Examples](docs/api_examples.md).
+
+## Running Tests
+
+To run the unit tests, use Poetry:
+
+```bash
+poetry run pytest
+```
+
+## Project Structure
+
+This project is organized into several key directories and files at the root level. For detailed descriptions of files within subdirectories, please refer to their respective `STRUCTURE.md` files:
+
+*   [bin/](bin/STRUCTURE.md) - Contains utility scripts for project setup and updates.
+*   [docs/](docs/STRUCTURE.md) - Houses documentation files, including API and CLI usage examples.
+*   [src/](src/STRUCTURE.md) - Contains the core source code for the application, including API, CLI, GUI, and rebaser logic.
+*   [tests/](tests/STRUCTURE.md) - Holds unit tests for the project's modules.
+
+### Root Level Files:
+
+*   `.gitattributes`: Configures Git attributes for various paths.
+*   `.gitignore`: Specifies intentionally untracked files to ignore.
+*   `.pre-commit-config.yaml`: Configuration for pre-commit hooks to enforce code quality.
+*   `.pylintrc`: Configuration file for Pylint, a Python static code analysis tool.
+*   `CONTRIBUTING.md`: Guidelines for contributing to the project.
+*   `LICENSE`: The project's license file (MIT License).
+*   `README.md`: The main project README, providing an overview and entry point.
+*   `poetry.lock`: Locks the exact versions of project dependencies.
+*   `pyproject.toml`: Project metadata and dependencies managed by Poetry.
+
+## Contributing
+
+Contributions are welcome! Please refer to the [Contribution Guidelines](CONTRIBUTING.md) for more details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+

basebender-0.1.5/README.md

@@ -0,0 +1,141 @@
+# BaseBender
+
+This project provides a Python module for rebaseing strings between different digit sets (positional number systems). It also includes a command-line interface (CLI) for easy usage.
+
+![Screenshot of the GUI. Shows example conversion](./docs/gui-main.png)
+
+## Project Goal
+n
+The primary goal is to provide a flexible and efficient tool for rebaseing numbers between different digit sets.
+
+## Features
+
+*   **Flexible Digit Set Definition**: Define source and target digit sets using simple strings, supporting rebaseing between standard and non-standard positional number systems (e.g., different Unicode symbol sets of varying lengths).
+*   **Tiered Configuration for Digit Sets**: Load pre-defined digit sets from package, system, and user-specific TOML configuration files, allowing for easy extension and customization.
+*   **Intelligent Digit Set Discovery**: Suggests relevant pre-defined digit sets based on the input string's content, enhancing usability for the GUI.
+*   **Dynamic Input Digit Set**: Automatically derives the input digit set from the input string if not explicitly provided. In the GUI, selecting "Derived from Input" from the preset dropdown will populate the input digit set field with the currently derived digit set. When the input digit set field is empty and the input string is not empty, its placeholder text will dynamically display the derived digit set from the input string, along with a visual cue. If both the input string and input digit set field are empty, the default placeholder text will be shown.
+*   **Efficient Rebaseing**: Utilizes bit-packing to minimize space during intermediate rebase.
+*   **Enhanced Error Handling**: Provides clear and informative error messages across CLI, API, and GUI, with structured error responses for the API.
+*   **Command-Line Interface (CLI)**: Rebase strings directly from the terminal with improved help text and error reporting.
+*   **Graphical User Interface (GUI)**: An intuitive interface for rebaseing, featuring digit set manipulation, tooltips, and a clear status bar for error messages.
+*   **Flexible Rebase Behavior**: Handles empty input strings, empty output digit sets, and single-character output digit sets gracefully.
+
+## Installation
+
+1.  **Clone the repository**:
+    ```bash
+    git clone https://github.com/mexc/base-bender.git
+    cd base-bender
+    ```
+
+2.  **Install Poetry**:
+    If you don't have Poetry installed, follow the instructions on its official website: [https://python-poetry.org/docs/#installation](https://python-poetry.org/docs/#installation)
+
+3.  **Install dependencies using Poetry**:
+    ```bash
+    poetry install
+    ```
+    This will create a virtual environment and install all project dependencies, including `pytest` and `toml`.
+
+    After installing dependencies, run the update script to generate the GUI asset source files:
+
+    ```bash
+    ./bin/update
+    ```
+## Running the Application
+
+This project provides several entry points for different interfaces: a command-line interface (CLI), a graphical user interface (GUI), and a web API. You can run them using Poetry scripts:
+
+*   **Command-Line Interface (CLI)**:
+    ```bash
+    poetry run basebender --help
+    ```
+    This will display the help message for the CLI. For detailed usage examples, refer to [CLI Examples](docs/cli_examples.md).
+
+*   **Graphical User Interface (GUI)**:
+    ```bash
+    poetry run basebender-gui
+    ```
+    This will launch the desktop application.
+
+*   **Web API**:
+    ```bash
+    poetry run basebender-api
+    ```
+    This will start the FastAPI server, typically accessible at `http://127.0.0.1:8000`. For detailed API usage examples, refer to [API Examples](docs/api_examples.md).
+
+## Configuration
+
+The BaseBender supports loading pre-defined digit sets from tiered TOML configuration files. This allows for a flexible and extensible way to manage common digit sets.
+
+### Configuration File Locations (in order of precedence: User > System > Package)
+
+*   **Package Configuration**:
+    *   Location: `rebaser/resources/data/default_digit_sets.toml` within the installed package.
+    *   Purpose: Contains a comprehensive set of standard, built-in digit sets (e.g., Binary, Decimal, Hexadecimal, Base64, ASCII Printable).
+    *   Example content:
+        ```toml
+        [[digit_sets]]
+        name = "Binary"
+        digits = "01"
+
+        [[digit_sets]]
+        name = "Decimal"
+        digits = "0123456789"
+        ```
+
+*   **System Configuration**:
+    *   Location (Linux/macOS): `/etc/digit_set_rebaser/digit_sets.toml`
+    *   Location (Windows): `%PROGRAMDATA%\digit_set_rebaser\digit_sets.toml`
+    *   Purpose: Allows system administrators to define digit sets available to all users on the system.
+
+*   **User Configuration**:
+    *   Location (Linux/macOS): `~/.config/digit_set_rebaser/digit_sets.toml`
+    *   Location (Windows): `%APPDATA%\digit_set_rebaser\digit_sets.toml`
+    *   Purpose: Allows individual users to define their own custom digit sets or override system/package defaults.
+
+### Adding Custom Digit Sets
+
+To add your own custom digit sets, create or edit the `digit_sets.toml` file in your user configuration directory (or system directory for system-wide availability). Follow the TOML format shown in the example above. Digit sets defined in higher precedence tiers will override those with the same `name` in lower tiers.
+
+## Usage
+
+For detailed CLI usage examples, refer to [CLI Examples](docs/cli_examples.md).
+For detailed API usage examples, refer to [API Examples](docs/api_examples.md).
+
+## Running Tests
+
+To run the unit tests, use Poetry:
+
+```bash
+poetry run pytest
+```
+
+## Project Structure
+
+This project is organized into several key directories and files at the root level. For detailed descriptions of files within subdirectories, please refer to their respective `STRUCTURE.md` files:
+
+*   [bin/](bin/STRUCTURE.md) - Contains utility scripts for project setup and updates.
+*   [docs/](docs/STRUCTURE.md) - Houses documentation files, including API and CLI usage examples.
+*   [src/](src/STRUCTURE.md) - Contains the core source code for the application, including API, CLI, GUI, and rebaser logic.
+*   [tests/](tests/STRUCTURE.md) - Holds unit tests for the project's modules.
+
+### Root Level Files:
+
+*   `.gitattributes`: Configures Git attributes for various paths.
+*   `.gitignore`: Specifies intentionally untracked files to ignore.
+*   `.pre-commit-config.yaml`: Configuration for pre-commit hooks to enforce code quality.
+*   `.pylintrc`: Configuration file for Pylint, a Python static code analysis tool.
+*   `CONTRIBUTING.md`: Guidelines for contributing to the project.
+*   `LICENSE`: The project's license file (MIT License).
+*   `README.md`: The main project README, providing an overview and entry point.
+*   `poetry.lock`: Locks the exact versions of project dependencies.
+*   `pyproject.toml`: Project metadata and dependencies managed by Poetry.
+
+## Contributing
+
+Contributions are welcome! Please refer to the [Contribution Guidelines](CONTRIBUTING.md) for more details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

basebender-0.1.5/bin/generate_resources.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+"""
+This script generates Python resource files from Qt .qrc files using pyside6-rcc.
+It is intended to be run as part of the project's build process, e.g., by Poetry.
+"""
+
+import os
+import subprocess
+import sys
+
+
+def main():
+    """
+    Main function to generate application resources.
+
+    It defines paths, ensures the output directory exists, and then
+    executes the pyside6-rcc command to compile the .qrc file into a Python module.
+    Handles FileNotFoundError for missing pyside6-rcc and CalledProcessError
+    for command execution failures, providing informative error messages.
+    """
+    # Define paths relative to the project root.
+    # When 'poetry build' executes this script, it runs from the project root.
+    qrc_file = "src/basebender/rebaser/resources/app_resources.qrc"
+    output_dir = "src/basebender/rebaser/generated"
+    output_file = os.path.join(output_dir, "app_resources_rc.py")
+
+    print(f"Starting resource generation from: {qrc_file}")
+    print(f"Output will be saved to: {output_file}")
+
+    # 1. Ensure the output directory exists
+    os.makedirs(output_dir, exist_ok=True)
+
+    try:
+        # 2. Construct the command to run pyside6-rcc
+        # We need 'poetry run' here because pyside6-rcc might not be directly in the PATH
+        # when this script is executed in certain environments (e.g., GitHub Actions).
+        command = ["poetry", "run", "pyside6-rcc", qrc_file, "-o", output_file]
+
+        print(f"Executing command: {' '.join(command)}")
+
+        # 3. Run the command using subprocess
+        # 'check=True' will raise a CalledProcessError if the command returns a non-zero exit code.
+        # 'capture_output=True' captures stdout and stderr.
+        # 'text=True' decodes stdout/stderr as text.
+        result = subprocess.run(
+            command, check=True, capture_output=True, text=True
+        )
+
+        if result.stdout:
+            print("pyside6-rcc stdout:")
+            print(result.stdout)
+        if result.stderr:
+            print("pyside6-rcc stderr:")
+            print(result.stderr)
+
+        print(f"Successfully generated {output_file}")
+
+    except FileNotFoundError:
+        print(
+            "Error: 'pyside6-rcc' command not found. "
+            "Ensure PySide6 is installed in your Poetry environment.",
+            file=sys.stderr,
+        )
+        print("You can install it with: poetry add pyside6", file=sys.stderr)
+        sys.exit(1)  # Exit with an error code
+    except subprocess.CalledProcessError as process_error:
+        print(
+            f"Error generating resources: Command failed with exit code {process_error.returncode}",
+            file=sys.stderr,
+        )
+        print(f"Command: {' '.join(process_error.cmd)}", file=sys.stderr)
+        print(f"Stdout: {process_error.stdout}", file=sys.stderr)
+        print(f"Stderr: {process_error.stderr}", file=sys.stderr)
+        sys.exit(1)  # Exit with an error code
+    except Exception as general_error:  # pylint: disable=W0718
+        # Catching a broad exception here as a final fallback for unexpected issues.
+        print(f"An unexpected error occurred: {general_error}", file=sys.stderr)
+        sys.exit(1)  # Exit with an error code
+
+
+if __name__ == "__main__":
+    main()

basebender-0.1.5/pyproject.toml

@@ -0,0 +1,64 @@
+[tool.pytest.ini_options]
+pythonpath = ["src/basebender"]
+[project]
+name = "basebender"
+version = "0.1.5"
+description = "A Python module for rebaseing strings between different digit sets (positional number systems)."
+authors = [
+    {name = "by.a.mexc@gmail.com"}
+]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.13,<3.14"
+dependencies = [
+    "pytest (>=8.3.5,<9.0.0)",
+    "toml (>=0.10.2,<0.11.0)",
+    "platformdirs (>=4.2.0,<5.0.0)",
+    "pyside6 (>=6.9.0,<7.0.0)",
+    "fastapi (>=0.115.12,<0.116.0)",
+    "uvicorn (>=0.34.3,<0.35.0)"
+]
+[project.urls]
+Homepage = "https://github.com/meXc/BaseBender"
+Repository = "https://github.com/meXc/BaseBender.git"
+Issues = "https://github.com/meXc/BaseBender/issues"
+
+[tool.poetry]
+
+packages = [{ include = "basebender", from = "src" }]
+
+include = [
+    "src/basebender/rebaser/generated/app_resources_rc.py"
+]
+
+
+[tool.poetry.build]
+script = "bin/generate_resources.py"
+
+
+[tool.poetry.scripts]
+basebender = "basebender.cli:main"
+basebender-gui = "basebender.gui.main_window:run_gui"
+basebender-api = "basebender.api.main:start_api"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.5"
+pylint = "^3.2.5"
+black = "^24.4.2"
+isort = "^5.13.2"
+pre-commit = "^3.7.1"
+twine = "^5.1.1"
+
+
+[tool.isort]
+profile = "black"
+
+[tool.black]
+line-length = 80
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.setuptools.packages.find]
+where = ["src"]

basebender-0.1.5/src/basebender/STRUCTURE.md

@@ -0,0 +1,13 @@
+# `src/` Directory Structure
+
+This directory contains the core source code for the application.
+
+## Folders:
+
+*   [`api/`](src/api/STRUCTURE.md): Contains the FastAPI application for the project's API.
+*   [`gui/`](src/gui/STRUCTURE.md): Contains the graphical user interface components.
+*   [`rebaser/`](src/rebaser/STRUCTURE.md): Contains the core rebase logic and related modules.
+
+## Files:
+
+*   [`cli.py`](src/cli.py): Implements the command-line interface for the application.

basebender-0.1.5/src/basebender/__init__.py

@@ -0,0 +1,11 @@
+"""Basebender: A Python package. Refer to the documentation for more details."""
+
+try:
+    from importlib.metadata import PackageNotFoundError, version
+
+    VERSION = version(
+        "basebender"
+    )  # <--- Replace "basebender" with your actual package name
+except (PackageNotFoundError, ImportError):
+
+    VERSION = "0.0.0+unknown"

basebender-0.1.5/src/basebender/api/STRUCTURE.md

@@ -0,0 +1,7 @@
+# `src/api/` Directory Structure
+
+This directory contains the FastAPI application for the project's API.
+
+## Files:
+
+*   [`main.py`](src/api/main.py): The main entry point for the FastAPI application.