bin-dec-conversions 1.0.0__tar.gz

bin_dec_conversions-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Marco S. Tornabene
+
+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.

bin_dec_conversions-1.0.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: bin-dec-conversions
+Version: 1.0.0
+Summary: Python package that performs conversions with binary and decimal numbers
+Author: Marco S. Tornabene
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/JustM4rk123/bin-dec-conversions
+Project-URL: Issues, https://github.com/JustM4rk123/bin-dec-conversions/issues
+Keywords: binary,decimal,conversions
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: questionary
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# bin-dec-conversions
+
+Python package that performs conversions between decimal and binary numbers. It can be used as a library, from the command line, or through an interactive prompt.
+
+## Features
+
+- Convert binary strings to decimal integers and the other way around
+- Optional zero-padding to a minimum width when producing binary output
+- Clear, descriptive error messages for invalid input
+- Command-line interface with flags, plus an interactive menu when run without arguments
+- Fully tested with `pytest`, including a round-trip check for every value from 0 to 255
+
+## Requirements
+
+- Python 3.10 or newer
+- [`questionary`](https://github.com/tmbo/questionary) (installed automatically, used for the interactive menu)
+
+## Installation
+
+```bash
+pip install bin-dec-conversions
+```
+
+## Usage
+
+### As a library
+
+```python
+from bin_dec_conversions import binary_to_decimal, decimal_to_binary
+
+binary_to_decimal("1010")  # 10
+decimal_to_binary(10)  # "1010"
+decimal_to_binary(10, 8)  # "00001010"  (zero-padded to 8 digits)
+decimal_to_binary(5, 2)  # "101"       (width is a minimum, never truncates)
+```
+
+| Function | Description |
+| --- | --- |
+| `binary_to_decimal(binary: str) -> int` | Converts a string of `0`s and `1`s to an integer. |
+| `decimal_to_binary(decimal: int, width: int = 0) -> str` | Converts a non-negative integer to a binary string, left-padded with zeros to at least `width` digits. |
+
+Both functions raise `ValueError` on invalid input:
+
+- `binary_to_decimal` rejects empty strings and any character other than `0` and `1` (including spaces, signs, prefixes like `0b`, underscores and decimal points). The message lists every offending character.
+- `decimal_to_binary` rejects negative numbers and negative widths.
+
+```python
+>>> binary_to_decimal("1a2")
+ValueError: '1a2' is not a valid binary number: invalid character(s) '2', 'a'. Only 0 and 1 are allowed
+```
+
+### From the command line
+
+```bash
+# Binary to decimal
+bin-dec-conversions -d 1010
+# The decimal equivalent of 1010 is: 10
+
+# Decimal to binary
+bin-dec-conversions -b 10
+# The binary equivalent of 10 is 1010
+
+# Decimal to binary, zero-padded to 8 digits
+bin-dec-conversions -b 10 -w 8
+# The binary equivalent of 10 is 00001010
+```
+
+| Option | Description |
+| --- | --- |
+| `-d BINARY`, `--to-decimal BINARY` | Convert a binary number to decimal. |
+| `-b DECIMAL`, `--to-binary DECIMAL` | Convert a decimal number to binary. |
+| `-w WIDTH`, `--width WIDTH` | Minimum number of binary digits, zero-padded. Only valid together with `--to-binary`. |
+
+`--to-decimal` and `--to-binary` are mutually exclusive.
+
+### Interactive mode
+
+Run the command with no arguments to open an interactive menu:
+
+```bash
+bin-dec-conversions
+```
+
+You can choose *Binary to decimal*, *Decimal to binary* (with an optional width), or *Exit*. Invalid input is reported and you are prompted again.
+
+## Development
+
+Clone the repository and install the package in editable mode with the development dependencies:
+
+```bash
+git clone https://github.com/JustM4rk123/bin-dec-conversions.git
+cd bin-dec-conversions
+pip install -e ".[dev]"
+```
+
+Run the tests and the linter:
+
+```bash
+pytest
+ruff check .
+```
+
+## Project structure
+
+```
+src/bin_dec_conversions/
+├── __init__.py   # public API and __version__
+├── core.py       # conversion functions
+└── cli.py        # command-line and interactive interface
+tests/
+├── test_conversions.py
+└── test_invalid.py
+```
+
+## License
+
+Released under the [MIT License](LICENSE).
+
+Author: Marco S. Tornabene

bin_dec_conversions-1.0.0/README.md

@@ -0,0 +1,119 @@
+# bin-dec-conversions
+
+Python package that performs conversions between decimal and binary numbers. It can be used as a library, from the command line, or through an interactive prompt.
+
+## Features
+
+- Convert binary strings to decimal integers and the other way around
+- Optional zero-padding to a minimum width when producing binary output
+- Clear, descriptive error messages for invalid input
+- Command-line interface with flags, plus an interactive menu when run without arguments
+- Fully tested with `pytest`, including a round-trip check for every value from 0 to 255
+
+## Requirements
+
+- Python 3.10 or newer
+- [`questionary`](https://github.com/tmbo/questionary) (installed automatically, used for the interactive menu)
+
+## Installation
+
+```bash
+pip install bin-dec-conversions
+```
+
+## Usage
+
+### As a library
+
+```python
+from bin_dec_conversions import binary_to_decimal, decimal_to_binary
+
+binary_to_decimal("1010")  # 10
+decimal_to_binary(10)  # "1010"
+decimal_to_binary(10, 8)  # "00001010"  (zero-padded to 8 digits)
+decimal_to_binary(5, 2)  # "101"       (width is a minimum, never truncates)
+```
+
+| Function | Description |
+| --- | --- |
+| `binary_to_decimal(binary: str) -> int` | Converts a string of `0`s and `1`s to an integer. |
+| `decimal_to_binary(decimal: int, width: int = 0) -> str` | Converts a non-negative integer to a binary string, left-padded with zeros to at least `width` digits. |
+
+Both functions raise `ValueError` on invalid input:
+
+- `binary_to_decimal` rejects empty strings and any character other than `0` and `1` (including spaces, signs, prefixes like `0b`, underscores and decimal points). The message lists every offending character.
+- `decimal_to_binary` rejects negative numbers and negative widths.
+
+```python
+>>> binary_to_decimal("1a2")
+ValueError: '1a2' is not a valid binary number: invalid character(s) '2', 'a'. Only 0 and 1 are allowed
+```
+
+### From the command line
+
+```bash
+# Binary to decimal
+bin-dec-conversions -d 1010
+# The decimal equivalent of 1010 is: 10
+
+# Decimal to binary
+bin-dec-conversions -b 10
+# The binary equivalent of 10 is 1010
+
+# Decimal to binary, zero-padded to 8 digits
+bin-dec-conversions -b 10 -w 8
+# The binary equivalent of 10 is 00001010
+```
+
+| Option | Description |
+| --- | --- |
+| `-d BINARY`, `--to-decimal BINARY` | Convert a binary number to decimal. |
+| `-b DECIMAL`, `--to-binary DECIMAL` | Convert a decimal number to binary. |
+| `-w WIDTH`, `--width WIDTH` | Minimum number of binary digits, zero-padded. Only valid together with `--to-binary`. |
+
+`--to-decimal` and `--to-binary` are mutually exclusive.
+
+### Interactive mode
+
+Run the command with no arguments to open an interactive menu:
+
+```bash
+bin-dec-conversions
+```
+
+You can choose *Binary to decimal*, *Decimal to binary* (with an optional width), or *Exit*. Invalid input is reported and you are prompted again.
+
+## Development
+
+Clone the repository and install the package in editable mode with the development dependencies:
+
+```bash
+git clone https://github.com/JustM4rk123/bin-dec-conversions.git
+cd bin-dec-conversions
+pip install -e ".[dev]"
+```
+
+Run the tests and the linter:
+
+```bash
+pytest
+ruff check .
+```
+
+## Project structure
+
+```
+src/bin_dec_conversions/
+├── __init__.py   # public API and __version__
+├── core.py       # conversion functions
+└── cli.py        # command-line and interactive interface
+tests/
+├── test_conversions.py
+└── test_invalid.py
+```
+
+## License
+
+Released under the [MIT License](LICENSE).
+
+Author: Marco S. Tornabene

bin_dec_conversions-1.0.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "bin-dec-conversions"
+description = "Python package that performs conversions with binary and decimal numbers"
+version = "1.0.0"
+requires-python = ">=3.10"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["binary", "decimal", "conversions"]
+authors = [
+    {name = "Marco S. Tornabene"}
+]
+dependencies = ["questionary"]
+
+
+[project.optional-dependencies]
+dev = [
+    "ruff",
+    "pytest",
+]
+
+[project.urls]
+Homepage = "https://github.com/JustM4rk123/bin-dec-conversions"
+Issues = "https://github.com/JustM4rk123/bin-dec-conversions/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[project.scripts]
+bin-dec-conversions = "bin_dec_conversions.cli:main"

bin_dec_conversions-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bin_dec_conversions-1.0.0/src/bin_dec_conversions/__init__.py

@@ -0,0 +1,10 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from .core import binary_to_decimal, decimal_to_binary
+
+try:
+    __version__ = version("bin-dec-conversions")
+except PackageNotFoundError:  # running from source without installing
+    __version__ = "unknown"
+
+__all__ = ["__version__", "binary_to_decimal", "decimal_to_binary"]

bin_dec_conversions-1.0.0/src/bin_dec_conversions/cli.py

@@ -0,0 +1,92 @@
+import argparse
+import sys
+
+import questionary
+
+from .core import binary_to_decimal, decimal_to_binary
+
+
+def main():
+    parser = argparse.ArgumentParser(prog="bin-dec-conversions")
+    group = parser.add_mutually_exclusive_group()
+    group.add_argument(
+        "-d",
+        "--to-decimal",
+        metavar="BINARY",
+        type=str,
+        help="Convert a binary number to decimal",
+    )
+    group.add_argument(
+        "-b",
+        "--to-binary",
+        metavar="DECIMAL",
+        type=int,
+        help="Convert a decimal number to binary",
+    )
+    parser.add_argument(
+        "-w",
+        "--width",
+        metavar="WIDTH",
+        type=int,
+        help="Minimum number of binary digits, zero-padded (only with --to-binary)",
+    )
+
+    args = parser.parse_args()
+
+    if args.width is not None and args.to_binary is None:
+        parser.error("Width goes only with --to-binary")
+    elif args.to_decimal is not None:
+        try:
+            result = binary_to_decimal(args.to_decimal)
+        except ValueError as e:
+            parser.error(str(e))
+        print(f"The decimal equivalent of {args.to_decimal} is: {result}")
+    elif args.to_binary is not None:
+        try:
+            if args.width is not None:
+                result = decimal_to_binary(args.to_binary, args.width)
+            else:
+                result = decimal_to_binary(args.to_binary)
+        except ValueError as e:
+            parser.error(str(e))
+        print(f"The binary equivalent of {args.to_binary} is {result}")
+    else:
+        conversion = questionary.select(
+            "Which conversion do you want to perform?",
+            choices=["Binary to decimal", "Decimal to binary", "Exit"],
+        ).ask()
+
+        match conversion:
+            case "Binary to decimal":
+                while True:
+                    try:
+                        binary = input("Insert a binary number: ").strip()
+                        print(
+                            f"The decimal equivalent of {binary} is {binary_to_decimal(binary)}"
+                        )
+                    except ValueError as e:
+                        print(f"Invalid input: {e}")
+                    else:
+                        break
+            case "Decimal to binary":
+                while True:
+                    try:
+                        decimal = int(input("Insert a decimal number: ").strip())
+                        width_input = input(
+                            "Width in bits (leave empty for none): "
+                        ).strip()
+                        if width_input:
+                            result = decimal_to_binary(decimal, int(width_input))
+                        else:
+                            result = decimal_to_binary(decimal)
+                        print(f"The binary equivalent of {decimal} is {result}")
+                    except ValueError as e:
+                        print(f"Invalid input: {e}")
+                    else:
+                        break
+            case "Exit":
+                sys.exit("Program terminated")
+
+
+if __name__ == "__main__":
+    main()

bin_dec_conversions-1.0.0/src/bin_dec_conversions/core.py

@@ -0,0 +1,34 @@
+def binary_to_decimal(binary: str) -> int:
+    if not binary:
+        raise ValueError("The input is empty. Enter a binary number made of 0s and 1s")
+
+    invalid = sorted(set(binary) - {"0", "1"})
+    if invalid:
+        chars = ", ".join(repr(c) for c in invalid)
+        raise ValueError(
+            f"'{binary}' is not a valid binary number: "
+            f"invalid character(s) {chars}. Only 0 and 1 are allowed"
+        )
+
+    decimal = 0
+    for i, bit in enumerate(reversed(binary)):
+        if bit == "1":
+            decimal += 2**i
+    return decimal
+
+
+def decimal_to_binary(decimal: int, width: int = 0) -> str:
+    if decimal < 0:
+        raise ValueError(
+            f"{decimal} is negative. Only non-negative integers are supported"
+        )
+    if width < 0:
+        raise ValueError(f"Width cannot be negative (got {width})")
+    if decimal == 0:
+        return "0".zfill(width)
+
+    bits = []
+    while decimal > 0:
+        bits.append(str(decimal % 2))
+        decimal //= 2
+    return "".join(reversed(bits)).zfill(width)

bin_dec_conversions-1.0.0/src/bin_dec_conversions.egg-info/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: bin-dec-conversions
+Version: 1.0.0
+Summary: Python package that performs conversions with binary and decimal numbers
+Author: Marco S. Tornabene
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/JustM4rk123/bin-dec-conversions
+Project-URL: Issues, https://github.com/JustM4rk123/bin-dec-conversions/issues
+Keywords: binary,decimal,conversions
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: questionary
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# bin-dec-conversions
+
+Python package that performs conversions between decimal and binary numbers. It can be used as a library, from the command line, or through an interactive prompt.
+
+## Features
+
+- Convert binary strings to decimal integers and the other way around
+- Optional zero-padding to a minimum width when producing binary output
+- Clear, descriptive error messages for invalid input
+- Command-line interface with flags, plus an interactive menu when run without arguments
+- Fully tested with `pytest`, including a round-trip check for every value from 0 to 255
+
+## Requirements
+
+- Python 3.10 or newer
+- [`questionary`](https://github.com/tmbo/questionary) (installed automatically, used for the interactive menu)
+
+## Installation
+
+```bash
+pip install bin-dec-conversions
+```
+
+## Usage
+
+### As a library
+
+```python
+from bin_dec_conversions import binary_to_decimal, decimal_to_binary
+
+binary_to_decimal("1010")  # 10
+decimal_to_binary(10)  # "1010"
+decimal_to_binary(10, 8)  # "00001010"  (zero-padded to 8 digits)
+decimal_to_binary(5, 2)  # "101"       (width is a minimum, never truncates)
+```
+
+| Function | Description |
+| --- | --- |
+| `binary_to_decimal(binary: str) -> int` | Converts a string of `0`s and `1`s to an integer. |
+| `decimal_to_binary(decimal: int, width: int = 0) -> str` | Converts a non-negative integer to a binary string, left-padded with zeros to at least `width` digits. |
+
+Both functions raise `ValueError` on invalid input:
+
+- `binary_to_decimal` rejects empty strings and any character other than `0` and `1` (including spaces, signs, prefixes like `0b`, underscores and decimal points). The message lists every offending character.
+- `decimal_to_binary` rejects negative numbers and negative widths.
+
+```python
+>>> binary_to_decimal("1a2")
+ValueError: '1a2' is not a valid binary number: invalid character(s) '2', 'a'. Only 0 and 1 are allowed
+```
+
+### From the command line
+
+```bash
+# Binary to decimal
+bin-dec-conversions -d 1010
+# The decimal equivalent of 1010 is: 10
+
+# Decimal to binary
+bin-dec-conversions -b 10
+# The binary equivalent of 10 is 1010
+
+# Decimal to binary, zero-padded to 8 digits
+bin-dec-conversions -b 10 -w 8
+# The binary equivalent of 10 is 00001010
+```
+
+| Option | Description |
+| --- | --- |
+| `-d BINARY`, `--to-decimal BINARY` | Convert a binary number to decimal. |
+| `-b DECIMAL`, `--to-binary DECIMAL` | Convert a decimal number to binary. |
+| `-w WIDTH`, `--width WIDTH` | Minimum number of binary digits, zero-padded. Only valid together with `--to-binary`. |
+
+`--to-decimal` and `--to-binary` are mutually exclusive.
+
+### Interactive mode
+
+Run the command with no arguments to open an interactive menu:
+
+```bash
+bin-dec-conversions
+```
+
+You can choose *Binary to decimal*, *Decimal to binary* (with an optional width), or *Exit*. Invalid input is reported and you are prompted again.
+
+## Development
+
+Clone the repository and install the package in editable mode with the development dependencies:
+
+```bash
+git clone https://github.com/JustM4rk123/bin-dec-conversions.git
+cd bin-dec-conversions
+pip install -e ".[dev]"
+```
+
+Run the tests and the linter:
+
+```bash
+pytest
+ruff check .
+```
+
+## Project structure
+
+```
+src/bin_dec_conversions/
+├── __init__.py   # public API and __version__
+├── core.py       # conversion functions
+└── cli.py        # command-line and interactive interface
+tests/
+├── test_conversions.py
+└── test_invalid.py
+```
+
+## License
+
+Released under the [MIT License](LICENSE).
+
+Author: Marco S. Tornabene

bin_dec_conversions-1.0.0/src/bin_dec_conversions.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/bin_dec_conversions/__init__.py
+src/bin_dec_conversions/cli.py
+src/bin_dec_conversions/core.py
+src/bin_dec_conversions.egg-info/PKG-INFO
+src/bin_dec_conversions.egg-info/SOURCES.txt
+src/bin_dec_conversions.egg-info/dependency_links.txt
+src/bin_dec_conversions.egg-info/entry_points.txt
+src/bin_dec_conversions.egg-info/requires.txt
+src/bin_dec_conversions.egg-info/top_level.txt
+tests/test_conversions.py
+tests/test_invalid.py

bin_dec_conversions-1.0.0/src/bin_dec_conversions.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bin_dec_conversions-1.0.0/src/bin_dec_conversions.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bin-dec-conversions = bin_dec_conversions.cli:main

bin_dec_conversions-1.0.0/src/bin_dec_conversions.egg-info/requires.txt

@@ -0,0 +1,5 @@
+questionary
+
+[dev]
+ruff
+pytest

bin_dec_conversions-1.0.0/src/bin_dec_conversions.egg-info/top_level.txt

@@ -0,0 +1 @@
+bin_dec_conversions

bin_dec_conversions-1.0.0/tests/test_conversions.py

@@ -0,0 +1,40 @@
+import pytest
+
+from bin_dec_conversions import binary_to_decimal, decimal_to_binary
+
+
+@pytest.mark.parametrize(
+    "binary, expected",
+    [
+        ("0", 0),
+        ("1010", 10),
+        ("101", 5),
+        ("10000000", 128),
+    ],
+)
+def test_bin2dec(binary, expected):
+    assert binary_to_decimal(binary) == expected
+
+
+@pytest.mark.parametrize(
+    "decimal, expected",
+    [
+        (0, "0"),
+        (10, "1010"),
+        (5, "101"),
+        (128, "10000000"),
+    ],
+)
+def test_dec2bin(decimal, expected):
+    assert decimal_to_binary(decimal) == expected
+
+
+def test_dec2bin_padding():
+    assert decimal_to_binary(10, 8) == "00001010"
+    assert decimal_to_binary(0, 8) == "00000000"
+    assert decimal_to_binary(5, 2) == "101"
+
+
+@pytest.mark.parametrize("n", range(256))
+def test_round_trip(n):
+    assert binary_to_decimal(decimal_to_binary(n)) == n

bin_dec_conversions-1.0.0/tests/test_invalid.py

@@ -0,0 +1,45 @@
+import re
+
+import pytest
+
+from bin_dec_conversions import binary_to_decimal, decimal_to_binary
+
+
+@pytest.mark.parametrize(
+    "invalid, expected_in_message",
+    [
+        ("", "empty"),
+        ("2", "character(s) '2'"),
+        ("10_1", "'_'"),
+        ("-101", "'-'"),
+        ("0b101", "'b'"),
+        (" 101", "' '"),
+        ("1.0", "'.'"),
+    ],
+)
+def test_bin2dec_error_messages(invalid, expected_in_message):
+    with pytest.raises(ValueError, match=re.escape(expected_in_message)):
+        binary_to_decimal(invalid)
+
+
+def test_bin2dec_message_echoes_input():
+    with pytest.raises(ValueError, match=re.escape("'10_1'")):
+        binary_to_decimal("10_1")
+
+
+def test_bin2dec_message_lists_every_invalid_char():
+    with pytest.raises(ValueError) as exc:
+        binary_to_decimal("1a2b")
+    assert "'a'" in str(exc.value)
+    assert "'2'" in str(exc.value)
+    assert "'b'" in str(exc.value)
+
+
+def test_dec2bin_negative_number_message():
+    with pytest.raises(ValueError, match="negative"):
+        decimal_to_binary(-5)
+
+
+def test_dec2bin_negative_width_message():
+    with pytest.raises(ValueError, match="Width cannot be negative"):
+        decimal_to_binary(5, -1)