baseconvert 2.0.4__tar.gz → 2.1.1__tar.gz

baseconvert-2.1.1/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: baseconvert
+Version: 2.1.1
+Summary: Convert numbers between bases.
+Author: squdle, BreadMakesYouFull
+License-Expression: MIT
+Keywords: base,bases,radix,numeral system,number,hex,dec,bin,hexidecimal,binary,decimal,fraction,fractions,integer,convert,gui
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Intended Audience :: Education
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Provides-Extra: gui
+Requires-Dist: pyside6; extra == "gui"
+Dynamic: license-file
+
+baseconvert
+===========
+
+Convert rational numbers between positive integer bases, with exact
+arithmetic and recurring fractional digits.
+
+Requires Python 3.10 or newer.
+
+Install
+-------
+
+Install the library from PyPI::
+
+    python -m pip install baseconvert
+
+For the GUI, install the optional dependencies and launch the application::
+
+    python -m pip install 'baseconvert[gui]'
+    baseconvert
+
+Run from a source checkout
+--------------------------
+
+Install `just <https://just.systems/>`_, clone the repository, and run
+``just launch``. The recipe creates ``.venv`` and installs the GUI extra if
+the launcher or PySide6 QML module is missing, then starts the GUI::
+
+    git clone https://github.com/BreadMakesYouFull/baseconvert.git
+    cd baseconvert
+    just launch
+
+Development recipes
+-------------------
+
+Run these recipes from the repository root::
+
+    just install       # editable install in .venv
+    just install-gui   # editable install with GUI dependencies
+    just install-dev   # install build, Black, and Twine
+    just format        # format Python source
+    just lint          # check formatting
+    just test          # run doctests
+    just check         # lint, doctests, then check files already in dist/
+    just build         # clean, install development tools, build sdist and wheel
+    just clean         # remove build artifacts AND .venv
+
+``just build`` first runs ``just clean``, which also deletes ``.venv``, and
+then installs the build tools again. ``just check`` does not build
+distributions; it runs ``twine check dist/*`` against files already in
+``dist/``. ``just publish-test`` and ``just publish`` run ``just check`` and
+upload the existing ``dist/*`` files to TestPyPI or PyPI, respectively. To
+build and validate distributions before publishing, run ``just build``
+followed by ``just check`` and review the files in ``dist/``.
+
+Python library
+--------------
+
+The API accepts strings, digit tuples, integers, floats, and
+``fractions.Fraction`` values. Use strings or ``Fraction`` to express exact
+decimal values without float representation concerns::
+
+    from baseconvert import base
+
+    base("FF0.8", 16, 10, string=True)  # '4080.5'
+    base("4080.5", 10, 16, string=True)  # 'FF0.8'
+    base("-0.1", 3, 10, string=True, exact=True)  # '-0.[3]'
+
+The command-line interface reads a number argument or standard input. Bases
+are integers; ``-s`` prints a string, and ``--no-recurring`` disables
+recurring notation::
+
+    python -m baseconvert -n 4080.5 -i 10 -o 16 -s
+    echo 0.1 | python -m baseconvert -i 3 -o 10 --no-recurring -s
+
+Digits, recurring fractions, and precision
+------------------------------------------
+
+String digits are
+``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz``. Values
+above 61 use ascending Unicode characters; tuple representation is
+recommended for bases above 61. In a digit tuple, each digit is a base-10
+integer and the radix point is ``'.'``. A leading ``'-'`` represents a
+negative value.
+
+Recurring digits are enclosed in square brackets, for example ``0.[3]``.
+``max_depth`` limits fractional digits (default 10). Set ``exact=True`` or
+``max_depth=0`` to calculate the complete terminating or repeating expansion
+when recurring output is enabled. Exact recurring detection uses rational
+remainders. With recurring output disabled, an unlimited expansion is bounded
+by ``MAX_DEPTH``.

baseconvert-2.1.1/README.md

@@ -0,0 +1,75 @@
+# baseconvert
+
+Convert rational numbers between positive integer bases, with exact arithmetic and recurring fractional digits.
+
+![baseconvert preview](./preview.gif)
+
+[PyPI](https://pypi.org/project/baseconvert/) · [Flathub](https://flathub.org/apps/io.github.breadmakesyoufull.baseconvert) · [Windows release](https://github.com/BreadMakesYouFull/baseconvert/releases/tag/windows)
+
+## Install
+
+Requires Python 3.10 or newer. Install the library from PyPI:
+
+```sh
+python -m pip install baseconvert
+```
+
+For the GUI, install the optional dependencies:
+
+```sh
+python -m pip install 'baseconvert[gui]'
+baseconvert
+```
+
+## Run from a source checkout
+
+Install [`just`](https://just.systems/), clone the repository, and run `just launch`. The recipe creates `.venv` and installs the GUI extra if the launcher or PySide6 QML module is missing, then starts the GUI:
+
+```sh
+git clone https://github.com/BreadMakesYouFull/baseconvert.git
+cd baseconvert
+just launch
+```
+
+## Development recipes
+
+Run these from the repository root:
+
+```sh
+just install       # editable install in .venv
+just install-gui   # editable install with GUI dependencies
+just install-dev   # install build, Black, and Twine
+just format        # format Python source
+just lint          # check formatting
+just test          # run doctests
+just check         # lint, doctests, then check files already in dist/
+just build         # clean, install development tools, build sdist and wheel
+just clean         # remove build artifacts AND .venv
+```
+
+`just build` first runs `just clean`, which also deletes `.venv`, and then installs the build tools again. `just check` does not build distributions; it runs `twine check dist/*` against whatever is currently in `dist/`. `just publish-test` and `just publish` run `just check` and upload the existing `dist/*` files to TestPyPI or PyPI, respectively. To build and validate distributions before publishing, run `just build` followed by `just check` and review the files in `dist/`.
+
+## Python library
+
+The API accepts strings, digit tuples, integers, floats, and `fractions.Fraction` values. Use strings or `Fraction` to express exact decimal values without float representation concerns.
+
+```python
+from baseconvert import base
+
+base("FF0.8", 16, 10, string=True)  # '4080.5'
+base("4080.5", 10, 16, string=True)  # 'FF0.8'
+base("-0.1", 3, 10, string=True, exact=True)  # '-0.[3]'
+```
+
+The command-line interface reads a number argument or standard input. Bases are integers; `-s` prints a string, and `--no-recurring` disables recurring notation:
+
+```sh
+python -m baseconvert -n 4080.5 -i 10 -o 16 -s
+echo 0.1 | python -m baseconvert -i 3 -o 10 --no-recurring -s
+```
+
+## Digits, recurring fractions, and precision
+
+String digits are `0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz`. Values above 61 use ascending Unicode characters; tuple representation is recommended for bases above 61. In a digit tuple, each digit is a base-10 integer and the radix point is `'.'`. A leading `'-'` represents a negative value.
+
+Recurring digits are enclosed in square brackets, for example `0.[3]`. `max_depth` limits fractional digits (default 10). Set `exact=True` or `max_depth=0` to calculate the complete terminating or repeating expansion when recurring output is enabled. Exact recurring detection uses rational remainders. With recurring output disabled, an unlimited expansion is bounded by `MAX_DEPTH`.

baseconvert-2.1.1/README.rst

@@ -0,0 +1,90 @@
+baseconvert
+===========
+
+Convert rational numbers between positive integer bases, with exact
+arithmetic and recurring fractional digits.
+
+Requires Python 3.10 or newer.
+
+Install
+-------
+
+Install the library from PyPI::
+
+    python -m pip install baseconvert
+
+For the GUI, install the optional dependencies and launch the application::
+
+    python -m pip install 'baseconvert[gui]'
+    baseconvert
+
+Run from a source checkout
+--------------------------
+
+Install `just <https://just.systems/>`_, clone the repository, and run
+``just launch``. The recipe creates ``.venv`` and installs the GUI extra if
+the launcher or PySide6 QML module is missing, then starts the GUI::
+
+    git clone https://github.com/BreadMakesYouFull/baseconvert.git
+    cd baseconvert
+    just launch
+
+Development recipes
+-------------------
+
+Run these recipes from the repository root::
+
+    just install       # editable install in .venv
+    just install-gui   # editable install with GUI dependencies
+    just install-dev   # install build, Black, and Twine
+    just format        # format Python source
+    just lint          # check formatting
+    just test          # run doctests
+    just check         # lint, doctests, then check files already in dist/
+    just build         # clean, install development tools, build sdist and wheel
+    just clean         # remove build artifacts AND .venv
+
+``just build`` first runs ``just clean``, which also deletes ``.venv``, and
+then installs the build tools again. ``just check`` does not build
+distributions; it runs ``twine check dist/*`` against files already in
+``dist/``. ``just publish-test`` and ``just publish`` run ``just check`` and
+upload the existing ``dist/*`` files to TestPyPI or PyPI, respectively. To
+build and validate distributions before publishing, run ``just build``
+followed by ``just check`` and review the files in ``dist/``.
+
+Python library
+--------------
+
+The API accepts strings, digit tuples, integers, floats, and
+``fractions.Fraction`` values. Use strings or ``Fraction`` to express exact
+decimal values without float representation concerns::
+
+    from baseconvert import base
+
+    base("FF0.8", 16, 10, string=True)  # '4080.5'
+    base("4080.5", 10, 16, string=True)  # 'FF0.8'
+    base("-0.1", 3, 10, string=True, exact=True)  # '-0.[3]'
+
+The command-line interface reads a number argument or standard input. Bases
+are integers; ``-s`` prints a string, and ``--no-recurring`` disables
+recurring notation::
+
+    python -m baseconvert -n 4080.5 -i 10 -o 16 -s
+    echo 0.1 | python -m baseconvert -i 3 -o 10 --no-recurring -s
+
+Digits, recurring fractions, and precision
+------------------------------------------
+
+String digits are
+``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz``. Values
+above 61 use ascending Unicode characters; tuple representation is
+recommended for bases above 61. In a digit tuple, each digit is a base-10
+integer and the radix point is ``'.'``. A leading ``'-'`` represents a
+negative value.
+
+Recurring digits are enclosed in square brackets, for example ``0.[3]``.
+``max_depth`` limits fractional digits (default 10). Set ``exact=True`` or
+``max_depth=0`` to calculate the complete terminating or repeating expansion
+when recurring output is enabled. Exact recurring detection uses rational
+remainders. With recurring output disabled, an unlimited expansion is bounded
+by ``MAX_DEPTH``.

baseconvert-2.1.1/VERSION.txt

@@ -0,0 +1 @@
+2.1.1

baseconvert-2.1.1/baseconvert/ButtonRow.qml

@@ -0,0 +1,80 @@
+import QtQuick
+import QtQuick.Controls
+import QtQuick.Layouts
+
+Item {
+    id: buttonRow
+    property string text1: "1"
+    property string text2: "2"
+    property string text3: "3"
+    property string text4: "4"
+    property string text5: "5"
+    property string text6: "6"
+    property bool enable1: true
+    property bool enable2: true
+    property bool enable3: true
+    property bool enable4: true
+    property bool enable5: true
+    property bool enable6: true
+    signal buttonPressed(text: string)
+    property bool darkMode: false
+    property color color1: darkMode ? "#d8dfd2" : "#f0f0df"
+    property color colorText1: "#18211e"
+    property color color2: color1
+    property color colorText2: colorText1
+    property color color3: color1
+    property color colorText3: colorText1
+    property color color4: color1
+    property color colorText4: colorText1
+    property color color5: color1
+    property color colorText5: colorText1
+    property color color6: color1
+    property color colorText6: colorText1
+
+    RowLayout {
+        anchors.fill: parent
+        spacing: 4
+
+        Repeater {
+            model: 6
+            delegate: Button {
+                required property int index
+                property bool enabledKey: index === 0 ? buttonRow.enable1
+                    : index === 1 ? buttonRow.enable2
+                    : index === 2 ? buttonRow.enable3
+                    : index === 3 ? buttonRow.enable4
+                    : index === 4 ? buttonRow.enable5 : buttonRow.enable6
+                property string keyText: index === 0 ? buttonRow.text1
+                    : index === 1 ? buttonRow.text2
+                    : index === 2 ? buttonRow.text3
+                    : index === 3 ? buttonRow.text4
+                    : index === 4 ? buttonRow.text5 : buttonRow.text6
+                property color keyColor: index === 0 ? buttonRow.color1
+                    : index === 1 ? buttonRow.color2
+                    : index === 2 ? buttonRow.color3
+                    : index === 3 ? buttonRow.color4
+                    : index === 4 ? buttonRow.color5 : buttonRow.color6
+                property color keyTextColor: index === 0 ? buttonRow.colorText1
+                    : index === 1 ? buttonRow.colorText2
+                    : index === 2 ? buttonRow.colorText3
+                    : index === 3 ? buttonRow.colorText4
+                    : index === 4 ? buttonRow.colorText5 : buttonRow.colorText6
+                visible: enabledKey
+                Layout.fillWidth: true
+                Layout.fillHeight: true
+                text: keyText
+                font.family: "Monospace"
+                font.weight: Font.Bold
+                onClicked: buttonRow.buttonPressed(text)
+                palette.button: keyColor
+                palette.buttonText: keyTextColor
+                background: Rectangle {
+                    radius: Math.min(8, height * 0.22)
+                    color: parent.down ? Qt.darker(parent.keyColor, 1.12) : parent.keyColor
+                    border.width: 1
+                    border.color: buttonRow.darkMode ? "#f5f4e5" : "#ffffff"
+                }
+            }
+        }
+    }
+}

baseconvert-2.1.1/baseconvert/__init__.py

@@ -0,0 +1,13 @@
+from baseconvert.baseconvert import BaseConverter
+from baseconvert.baseconvert import DigitTuple
+from baseconvert.baseconvert import base
+
+from importlib.metadata import PackageNotFoundError, version
+
+__all__ = ["BaseConverter", "DigitTuple", "base", "__version__"]
+
+try:
+    __version__ = version("baseconvert")
+except PackageNotFoundError:
+    # Allow imports directly from a source checkout before installation.
+    __version__ = "0+unknown"

baseconvert-2.1.1/baseconvert/__main__.py

@@ -0,0 +1,90 @@
+"""Convert a number from the command line, or launch the GUI with no input.
+
+Examples::
+
+    python -m baseconvert -n 0.5 -i 10 -o 20 -s
+    echo 3.1415926 | python -m baseconvert -i 10 -o 16 -d 3 -s
+    python -m baseconvert -n 0.1 -i 3 -o 10 --no-recurring -s
+    baseconvert --theme light
+"""
+
+import argparse
+import sys
+from typing import Sequence
+
+from baseconvert import DigitTuple, base
+
+
+def main(argv: Sequence[str] | None = None) -> str | DigitTuple | None:
+    parser = argparse.ArgumentParser(
+        description="Convert rational numbers between bases."
+    )
+    parser.add_argument(
+        "-n",
+        "--number",
+        default=None,
+        help="The number to convert as a string; otherwise read stdin.",
+    )
+    parser.add_argument(
+        "-i", "--input-base", type=int, default=10, help="Input base (default: 10)."
+    )
+    parser.add_argument(
+        "-o", "--output-base", type=int, default=10, help="Output base (default: 10)."
+    )
+    parser.add_argument(
+        "-d",
+        "--max-depth",
+        type=int,
+        default=10,
+        help="Maximum fractional digits (default: 10).",
+    )
+    parser.add_argument(
+        "--theme",
+        choices=("system", "light", "dark"),
+        default="dark",
+        help="GUI color theme (default: dark).",
+    )
+    recurring = parser.add_mutually_exclusive_group()
+    recurring.add_argument(
+        "-r",
+        "--recurring",
+        dest="recurring",
+        action="store_true",
+        help="Mark repeating fractional digits (the default).",
+    )
+    recurring.add_argument(
+        "--no-recurring",
+        dest="recurring",
+        action="store_false",
+        help="Do not mark repeating fractional digits.",
+    )
+    parser.set_defaults(recurring=True)
+    parser.add_argument(
+        "-s",
+        "--string",
+        action="store_true",
+        help="Output the number as a string rather than a tuple.",
+    )
+    args = parser.parse_args(argv)
+
+    options = {
+        "string": args.string,
+        "max_depth": args.max_depth,
+        "recurring": args.recurring,
+    }
+    if args.number is not None:
+        return base(args.number, args.input_base, args.output_base, **options)
+    if not sys.stdin.isatty():
+        number = sys.stdin.read().strip()
+        return base(number, args.input_base, args.output_base, **options)
+
+    from .gui import main as gui_main
+
+    gui_main(theme=args.theme)
+    return None
+
+
+if __name__ == "__main__":
+    result = main()
+    if result is not None:
+        print(result)