format-utils 1.0.0__tar.gz

format_utils-1.0.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: format-utils
+Version: 1.0.0
+Summary: A Python library for formatting numbers, strings, time, and bytes.
+Author: lelewithheart
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Dynamic: author
+Dynamic: classifier
+Dynamic: license
+Dynamic: requires-python
+Dynamic: summary

format_utils-1.0.0/README.md

@@ -0,0 +1,57 @@
+# Formatting Library
+
+A Python library for formatting numbers, strings, time, and bytes. Includes utility functions for common formatting tasks.
+
+## Installation
+
+Simply copy the `formatter` folder into your project. No external dependencies required.
+
+## Usage
+
+Import the desired functions from the `formatter` package:
+
+```python
+from formatter import format_number, truncate, slugify, format_seconds, format_timestamp, format_bytes
+```
+
+### Functions
+
+#### Numbers
+- `format_number(n: float, sep: str = ",") -> str`
+  - Formats a number with thousands separators.
+  - Example: `format_number(1234567)` → `'1,234,567'`
+  - Example: `format_number(1234567.89)` → `'1,234,567.89'`
+
+#### Strings
+- `truncate(text: str, length: int, suffix: str = "...") -> str`
+  - Truncates a string to a maximum length, appending a suffix if needed.
+  - Example: `truncate("Hello World", 5)` → `'He...'`
+- `slugify(text: str) -> str`
+  - Converts text into a URL-friendly slug.
+  - Example: `slugify("Hello World!")` → `'hello-world'`
+
+#### Time
+- `format_seconds(seconds: float) -> str`
+  - Converts seconds into a human-readable duration, always showing hours, minutes, and seconds.
+  - Example: `format_seconds(3661)` → `'1h 1m 1s'`
+  - Example: `format_seconds(60)` → `'0h 1m 0s'`
+- `format_timestamp(dt) -> str`
+  - Formats a datetime object into a standard string.
+  - Example: `format_timestamp(datetime(2026, 2, 7, 0, 13))` → `'2026-02-07 00:13'`
+
+#### Bytes
+- `format_bytes(n: int, decimals: int = 2) -> str`
+  - Converts a byte count into a human-readable string.
+  - Example: `format_bytes(1536000)` → `'1.46 MB'`
+
+## Testing
+
+Run the test suite with:
+
+```
+python -m tests.test_formatting_lib
+```
+
+## License
+
+MIT License

format_utils-1.0.0/format_utils.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: format-utils
+Version: 1.0.0
+Summary: A Python library for formatting numbers, strings, time, and bytes.
+Author: lelewithheart
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Dynamic: author
+Dynamic: classifier
+Dynamic: license
+Dynamic: requires-python
+Dynamic: summary

format_utils-1.0.0/format_utils.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+setup.py
+format_utils.egg-info/PKG-INFO
+format_utils.egg-info/SOURCES.txt
+format_utils.egg-info/dependency_links.txt
+format_utils.egg-info/top_level.txt
+formatter/__init__.py
+formatter/bytes.py
+formatter/numbers.py
+formatter/strings.py
+formatter/time.py
+tests/test_formatting_lib.py

format_utils-1.0.0/format_utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

format_utils-1.0.0/format_utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+formatter

format_utils-1.0.0/formatter/__init__.py

@@ -0,0 +1,13 @@
+from .bytes import format_bytes
+from .time import format_seconds, format_timestamp
+from .numbers import format_number
+from .strings import slugify, truncate
+
+__all__ = [
+    "format_bytes",
+    "format_seconds",
+    "format_timestamp",
+    "format_number",
+    "slugify",
+    "truncate",
+]

format_utils-1.0.0/formatter/bytes.py

@@ -0,0 +1,14 @@
+def format_bytes(n: int, decimals: int = 2) -> str:
+    """
+    Convert a byte count into a human-readable string.
+    Example: 1536000 -> "1.54 MB"
+    """
+    if n < 0:
+        raise ValueError("Byte count cannot be negative")
+    units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB']
+    i = 0
+    value = float(n)
+    while value >= 1024 and i < len(units) - 1:
+        value /= 1024
+        i += 1
+    return f"{value:.{decimals}f} {units[i]}"

format_utils-1.0.0/formatter/numbers.py

@@ -0,0 +1,18 @@
+def format_number(n: float, sep: str = ",") -> str:
+    """
+    Format a number with thousands separators.
+    Example: 1234567 -> "1,234,567"
+    """
+    num_str = str(n)
+    if '.' in num_str:
+        integer, decimal = num_str.split('.')
+    else:
+        integer, decimal = num_str, None
+    parts = []
+    while integer:
+        parts.append(integer[-3:])
+        integer = integer[:-3]
+    result = sep.join(reversed(parts))
+    if decimal:
+        result += '.' + decimal
+    return result

format_utils-1.0.0/formatter/strings.py

@@ -0,0 +1,22 @@
+def slugify(text: str) -> str:
+    """
+    Convert text into a URL-friendly slug.
+    Example: "Hello World!" -> "hello-world"
+    """
+    import re
+    text = text.lower()
+    text = re.sub(r'[^a-z0-9]+', '-', text)
+    text = text.strip('-')
+    return text
+
+def truncate(text: str, length: int, suffix: str = "...") -> str:
+    """
+    Truncate a string to a maximum length.
+    Example: truncate("Hello World", 5) -> "He..."
+    """
+    if len(text) <= length:
+        return text
+    if length <= len(suffix):
+        return suffix[:length]
+    truncated = text[:length - len(suffix)] + suffix
+    return truncated[:length]

format_utils-1.0.0/formatter/time.py

@@ -0,0 +1,19 @@
+import math;
+
+def format_seconds(seconds: float) -> str:
+    """
+    Convert seconds into a human-readable duration.
+    Example: 3661 -> "1h 1m 1s"
+    """
+    hours = math.floor(seconds // 3600)
+    minutes = math.floor((seconds % 3600) // 60)
+    secs = math.floor(seconds % 60)
+    return f"{hours}h {minutes}m {secs}s"
+
+
+def format_timestamp(dt) -> str:
+    """
+    Format a datetime object into a standard string.
+    Example: datetime(2026, 2, 7, 0, 13) -> "2026-02-07 00:13"
+    """
+    return dt.strftime('%Y-%m-%d %H:%M')

format_utils-1.0.0/setup.cfg

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

format_utils-1.0.0/setup.py

@@ -0,0 +1,17 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="format-utils",
+    version="1.0.0",
+    description="A Python library for formatting numbers, strings, time, and bytes.",
+    author="lelewithheart",
+    packages=find_packages(),
+    include_package_data=True,
+    python_requires='>=3.6',
+    license="MIT",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)

format_utils-1.0.0/tests/test_formatting_lib.py

@@ -0,0 +1,48 @@
+import unittest
+import sys
+import os
+from datetime import datetime
+
+# Ensure parent directory is in sys.path for package imports
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+from formatter import numbers, strings, time, bytes
+
+class TestFormattingLib(unittest.TestCase):
+    def test_format_number(self):
+        self.assertEqual(numbers.format_number(1234567), "1,234,567")
+        self.assertEqual(numbers.format_number(1234567.89), "1,234,567.89")
+        self.assertEqual(numbers.format_number(1000), "1,000")
+        self.assertEqual(numbers.format_number(0), "0")
+        self.assertEqual(numbers.format_number(1234567, sep="."), "1.234.567")
+
+    def test_truncate(self):
+        self.assertEqual(strings.truncate("Hello World", 5), "He...")
+        self.assertEqual(strings.truncate("Hello", 10), "Hello")
+        self.assertEqual(strings.truncate("Hello World", 8, "--"), "Hello --")
+        self.assertEqual(strings.truncate("Hello World", 2), "..")
+
+    def test_slugify(self):
+        self.assertEqual(strings.slugify("Hello World!"), "hello-world")
+        self.assertEqual(strings.slugify("Python_is Great"), "python-is-great")
+        self.assertEqual(strings.slugify("123 456"), "123-456")
+        self.assertEqual(strings.slugify("--Hello--"), "hello")
+
+    def test_format_seconds(self):
+        self.assertEqual(time.format_seconds(3661), "1h 1m 1s")
+        self.assertEqual(time.format_seconds(60), "0h 1m 0s")
+        self.assertEqual(time.format_seconds(59), "0h 0m 59s")
+        self.assertEqual(time.format_seconds(0), "0h 0m 0s")
+
+    def test_format_timestamp(self):
+        dt = datetime(2026, 2, 7, 0, 13)
+        self.assertEqual(time.format_timestamp(dt), "2026-02-07 00:13")
+
+    def test_format_bytes(self):
+        self.assertEqual(bytes.format_bytes(1536000), "1.46 MB")
+        self.assertEqual(bytes.format_bytes(1024), "1.00 KB")
+        self.assertEqual(bytes.format_bytes(0), "0.00 B")
+        self.assertEqual(bytes.format_bytes(1048576, 1), "1.0 MB")
+
+if __name__ == "__main__":
+    unittest.main()