bin-dec-conversions 0.1.0__tar.gz

bin_dec_conversions-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: bin-dec-conversions
+Version: 0.1.0
+Summary: A Python package for binary and decimal conversions implemented from scratch.
+Author: Marco Salvatore Tornabene
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"

bin_dec_conversions-0.1.0/README.md

@@ -0,0 +1,138 @@
+# Binary/Decimal Conversions
+
+A small Python package for converting non-negative integers between binary and decimal representations. The conversion algorithms are implemented manually, without using Python's `bin()` or `int(value, 2)` for the core conversions.
+
+## Features
+
+- Convert a binary string to a decimal integer with `binary_to_decimal()`.
+- Convert a non-negative decimal integer to a binary string with `decimal_to_binary()`.
+- Reject invalid binary input and negative decimal values with `ValueError`.
+- Include tests written with `pytest`.
+
+## Requirements
+
+- Python 3.10 or newer
+- `pytest` to run the tests
+
+## Installation
+
+From the project root, create and activate a virtual environment, then install the package in editable mode:
+
+```bash
+python -m venv .venv
+```
+
+On Linux/macOS:
+
+```bash
+source .venv/bin/activate
+```
+
+On Windows PowerShell:
+
+```powershell
+.venv\Scripts\Activate.ps1
+```
+
+Install the package:
+
+```bash
+python -m pip install -e .
+```
+
+If the development dependencies are configured in `pyproject.toml`, you can install them as well:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## Usage
+
+The package exposes two functions:
+
+```python
+from bin_dec_conversions import binary_to_decimal, decimal_to_binary
+```
+
+### Binary to decimal
+
+Pass the binary number as a string:
+
+```python
+from bin_dec_conversions import binary_to_decimal
+
+result = binary_to_decimal("1010")
+print(result)  # 10
+```
+
+The function evaluates each bit according to its position and adds the corresponding power of two.
+
+More examples:
+
+```python
+binary_to_decimal("0")        # 0
+binary_to_decimal("1010")     # 10
+binary_to_decimal("10000000") # 128
+```
+
+### Decimal to binary
+
+Pass a non-negative integer:
+
+```python
+from bin_dec_conversions import decimal_to_binary
+
+result = decimal_to_binary(10)
+print(result)  # "1010"
+```
+
+The function repeatedly divides the number by two and collects the remainders. Reading the remainders in reverse order gives the binary representation.
+
+More examples:
+
+```python
+decimal_to_binary(0)   # "0"
+decimal_to_binary(10)  # "1010"
+decimal_to_binary(128) # "10000000"
+```
+
+## Error handling
+
+Invalid inputs raise `ValueError`.
+
+```python
+binary_to_decimal("20")  # raises ValueError
+decimal_to_binary(-2)    # raises ValueError
+```
+
+For binary input, use a string containing only the digits `0` and `1`. For decimal input, use a non-negative integer.
+
+## Running the tests
+
+Run the test suite from the project root:
+
+```bash
+python -m pytest
+```
+
+The tests cover common conversions and some invalid inputs, including invalid binary strings and negative decimal values.
+
+## Project structure
+
+```text
+bin-dec-conversions/
+├── pyproject.toml
+├── README.md
+├── src/
+│   └── bin_dec_conversions/
+│       ├── __init__.py
+│       └── conversions.py
+└── tests/
+    └── test_conversions.py
+```
+
+The `conversions.py` module contains the conversion functions. The package's `__init__.py` should re-export `binary_to_decimal` and `decimal_to_binary` so they can be imported directly from `bin_dec_conversions`.
+
+## Scope
+
+This initial version focuses on non-negative whole numbers. Fractions, negative binary representations, hexadecimal conversion, and a command-line interface are outside the current scope.

bin_dec_conversions-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bin-dec-conversions"
+version = "0.1.0"
+description = "A Python package for binary and decimal conversions implemented from scratch."
+requires-python = ">=3.10"
+authors = [
+    { name = "Marco Salvatore Tornabene" }
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "ruff",
+    "black",
+    "build",
+    "twine"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"

bin_dec_conversions-0.1.0/setup.cfg

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

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

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: bin-dec-conversions
+Version: 0.1.0
+Summary: A Python package for binary and decimal conversions implemented from scratch.
+Author: Marco Salvatore Tornabene
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"

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

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+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/requires.txt
+src/bin_dec_conversions.egg-info/top_level.txt
+src/conversions/__init__.py
+src/conversions/conversions.py
+tests/test_conversions.py

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,7 @@
+
+[dev]
+pytest
+ruff
+black
+build
+twine

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

@@ -0,0 +1 @@
+conversions

bin_dec_conversions-0.1.0/src/conversions/__init__.py

@@ -0,0 +1,3 @@
+from .conversions import binary_to_decimal, decimal_to_binary
+
+__all__ = ["binary_to_decimal", "decimal_to_binary"]

bin_dec_conversions-0.1.0/src/conversions/conversions.py

@@ -0,0 +1,30 @@
+import re
+
+
+def binary_to_decimal(binary: str) -> int:
+    if not re.fullmatch(r"[01]+", binary):
+        raise ValueError
+
+    decimal = 0
+    reversed_binary = binary[::-1]
+    for i, bit in enumerate(reversed_binary):
+        if bit == "1":
+            decimal += 2**i
+
+    return decimal
+
+
+def decimal_to_binary(decimal: int) -> str:
+    if decimal < 0:
+        raise ValueError
+
+    if decimal == 0:
+        return "0"
+
+    bits = []
+
+    while decimal > 0:
+        bits.append(str(decimal % 2))
+        decimal //= 2
+
+    return "".join(bits[::-1])

bin_dec_conversions-0.1.0/tests/test_conversions.py

@@ -0,0 +1,27 @@
+import pytest
+
+from conversions import binary_to_decimal, decimal_to_binary
+
+
+def test_bin2dec() -> None:
+    assert binary_to_decimal("0") == 0
+    assert binary_to_decimal("1010") == 10
+    assert binary_to_decimal("10000000") == 128
+
+
+def test_dec2bin() -> None:
+    assert decimal_to_binary(0) == "0"
+    assert decimal_to_binary(10) == "1010"
+    assert decimal_to_binary(128) == "10000000"
+
+
+def test_invalid_binary():
+    with pytest.raises(ValueError):
+        binary_to_decimal("Cat")
+    with pytest.raises(ValueError):
+        binary_to_decimal("20")
+
+
+def test_invalid_decimal():
+    with pytest.raises(ValueError):
+        decimal_to_binary(-2)