textutils-hs 0.1.0__py3-none-any.whl

textutils/__init__.py

@@ -0,0 +1,24 @@
+"""textutils: small, dependency-free helpers for common text tasks.
+
+Public API:
+    ``word_count``, ``character_count``, ``reverse``, ``capitalize_words``,
+    ``slugify``.
+
+Everything else (modules or names starting with ``_``) is internal and may
+change without notice.
+"""
+
+from importlib.metadata import version
+
+from .counting import character_count, word_count
+from .transform import capitalize_words, reverse, slugify
+
+__all__ = [
+    "capitalize_words",
+    "character_count",
+    "reverse",
+    "slugify",
+    "word_count",
+]
+
+__version__ = version("textutils-hs")

textutils/_validation.py

@@ -0,0 +1,7 @@
+"""Private input-validation helpers for textutils."""
+
+
+def _ensure_str(text: object) -> None:
+    """Raise a ``TypeError`` if *text* is not a :class:`str`."""
+    if not isinstance(text, str):
+        raise TypeError(f"text must be str, not {type(text).__name__}")

textutils/counting.py

@@ -0,0 +1,70 @@
+"""Word-counting helpers for textutils."""
+
+from ._validation import _ensure_str
+
+__all__ = ["word_count", "character_count"]
+
+
+def word_count(text: str) -> int:
+    """Count the words in *text*.
+
+    Words are separated by any amount of whitespace, so runs of spaces,
+    tabs, and newlines all act as a single separator.
+
+    Parameters
+    ----------
+    text : str
+        The string to count words in.
+
+    Returns
+    -------
+    int
+        The number of words in *text*. An empty string returns ``0``.
+
+    Raises
+    ------
+    TypeError
+        If *text* is not a :class:`str`.
+
+    Examples
+    --------
+    >>> word_count("hello world")
+    2
+    >>> word_count("  spaced   out  ")
+    2
+    >>> word_count("")
+    0
+    """
+    _ensure_str(text)
+    return len(text.split())
+
+
+def character_count(text: str) -> int:
+    """Count the characters in *text*, spaces included.
+
+    Parameters
+    ----------
+    text : str
+        The string to count characters in.
+
+    Returns
+    -------
+    int
+        The number of characters in *text*. An empty string returns ``0``.
+
+    Raises
+    ------
+    TypeError
+        If *text* is not a :class:`str`.
+
+    Examples
+    --------
+    >>> character_count("hello")
+    5
+    >>> character_count("hi there")
+    8
+    >>> character_count("")
+    0
+    """
+    _ensure_str(text)
+    return len(text)

textutils/transform.py

@@ -0,0 +1,122 @@
+"""String-transforming helpers for textutils."""
+
+import re
+
+from ._validation import _ensure_str
+
+__all__ = ["reverse", "capitalize_words", "slugify"]
+
+_WORD_START = re.compile(r"(?<!\S)\w")
+
+
+def reverse(text: str) -> str:
+    """Return *text* with its characters in reverse order.
+
+    Parameters
+    ----------
+    text : str
+        The string to reverse.
+
+    Returns
+    -------
+    str
+        A new string holding the characters of *text* in reverse order. An
+        empty string returns an empty string.
+
+    Raises
+    ------
+    TypeError
+        If *text* is not a :class:`str`.
+
+    Examples
+    --------
+    >>> reverse("stressed")
+    'desserts'
+    >>> reverse("abc")
+    'cba'
+    >>> reverse("")
+    ''
+    """
+    _ensure_str(text)
+    return text[::-1]
+
+
+def capitalize_words(text: str) -> str:
+    """Uppercase the first character of every word in *text*.
+
+    Only the first character of each word is changed; the rest of each word
+    is left exactly as it was. Whitespace, including newlines, is preserved.
+
+    Parameters
+    ----------
+    text : str
+        The string to transform.
+
+    Returns
+    -------
+    str
+        A new string with the first character of each word uppercased. An
+        empty string returns an empty string.
+
+    Raises
+    ------
+    TypeError
+        If *text* is not a :class:`str`.
+
+    Examples
+    --------
+    >>> capitalize_words("hello world")
+    'Hello World'
+    >>> capitalize_words("hello WORLD")
+    'Hello WORLD'
+    >>> capitalize_words("it's fine")
+    "It's Fine"
+    >>> capitalize_words("")
+    ''
+    """
+    _ensure_str(text)
+    return _WORD_START.sub(lambda match: match.group(0).upper(), text)
+
+
+def slugify(text: str) -> str:
+    """Turn *text* into a URL-friendly slug.
+
+    The input is lowercased, every run of characters outside ``a-z0-9``
+    (spaces, punctuation, underscores, accents, ...) is replaced by a single
+    hyphen, and leading/trailing hyphens are removed. Existing hyphens are
+    kept as separators, so ``"well-known"`` stays ``"well-known"`` while
+    ``"foo_bar"`` becomes ``"foo-bar"``.
+
+    Parameters
+    ----------
+    text : str
+        The string to slugify.
+
+    Returns
+    -------
+    str
+        A slug containing only lowercase ASCII letters, digits, and internal
+        hyphens. An empty string, or a string with no letters/digits,
+        returns ``""``.
+
+    Raises
+    ------
+    TypeError
+        If *text* is not a :class:`str`.
+
+    Examples
+    --------
+    >>> slugify("Hello, World!")
+    'hello-world'
+    >>> slugify("  Hello, World! Open Source  ")
+    'hello-world-open-source'
+    >>> slugify("Python --- is fun")
+    'python-is-fun'
+    >>> slugify("Version 2.0 released")
+    'version-2-0-released'
+    >>> slugify("!!!")
+    ''
+    """
+    _ensure_str(text)
+    slug = re.sub(r"[^a-z0-9]+", "-", text.lower())
+    return slug.strip("-")

textutils_hs-0.1.0.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: textutils-hs
+Version: 0.1.0
+Summary: Small, dependency-free helpers for common text tasks.
+Author: Hamza Fikri
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hamzasinko/textutils
+Project-URL: Repository, https://github.com/hamzasinko/textutils
+Project-URL: Issues, https://github.com/hamzasinko/textutils/issues
+Project-URL: Changelog, https://github.com/hamzasinko/textutils/blob/main/CHANGELOG.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: pre-commit>=3.7; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# textutils
+
+Small, dependency-free Python helpers for common text tasks: counting words,
+counting characters, reversing a string, and capitalizing each word. Every
+function has type hints, a full docstring, and tests.
+
+## Features
+
+- `word_count(text)` — number of words in a string.
+- `character_count(text)` — number of characters in a string.
+- `reverse(text)` — the string reversed.
+- `capitalize_words(text)` — first letter of each word capitalized.
+- `slugify(text)` — a URL-friendly slug (lowercase, hyphen-separated).
+
+Edge cases are handled: empty strings return empty results, and non-string
+input raises `TypeError`.
+
+## Installation
+
+Requires Python 3.9 or newer. No third-party runtime dependencies.
+
+Clone and install in editable mode with the development tools:
+
+```bash
+git clone https://github.com/hamzasinko/textutils.git
+cd textutils
+python -m pip install -e ".[dev]"
+```
+
+Run the tests:
+
+```bash
+python -m pytest
+```
+
+## Usage
+
+```python
+from textutils import word_count, character_count, reverse, capitalize_words, slugify
+
+word_count("hello world") # 2
+character_count("hello")          # 5
+reverse("stressed")              # "desserts"
+capitalize_words("hello world")   # "Hello World"
+slugify("Hello, World!")          # "hello-world"
+```
+
+## Contributing
+
+Contributions are welcome.
+
+1. Fork the repository on GitHub.
+2. Create a branch: `git checkout -b feature/my-change`.
+3. Make your change, keeping commits small and focused.
+4. Run the tests: `python -m pytest`.
+5. Push your branch and open a pull request.
+
+## License
+
+Released under the MIT License. See [LICENSE](LICENSE) for details.

textutils_hs-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+textutils/__init__.py,sha256=LXivX6RwU0wIAjiZTUZQnkEnlra4HdawYSxL81BIDXg,575
+textutils/_validation.py,sha256=CGK773yl57Kr2WMwK2eUuTmvMAZvAHF22HtCKaC0bwo,266
+textutils/counting.py,sha256=hxY56bllMU-ySe2g4QtlbCg4YJCUgRehQCH3lLi4W4M,1353
+textutils/transform.py,sha256=aRnaKBwLD3RK38bbVTOCh_eiudqHdl9H_hFYAHaw7qE,2873
+textutils_hs-0.1.0.dist-info/licenses/LICENSE,sha256=YoV42jzb_U2WLhGFmPAGJeEZlqCQU160UxqBffMmSdQ,306
+textutils_hs-0.1.0.dist-info/METADATA,sha256=U5CGl_JTkeclCWl56sL36p-UaZeRsHsYkV7iSvbD0Ps,2989
+textutils_hs-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+textutils_hs-0.1.0.dist-info/top_level.txt,sha256=amWgGsYwaWzVol7zPaWIjxj2Of6hEptj7rE9MR3bp_E,10
+textutils_hs-0.1.0.dist-info/RECORD,,

textutils_hs-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

textutils_hs-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,8 @@
+MIT License
+
+Copyright (c) 2026 Hamza Fikri
+
+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. See the full MIT License text at
+https://opensource.org/license/mit.

textutils_hs-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+textutils