crashbytes-strutils 1.0.0__py3-none-any.whl

crashbytes_strutils/__init__.py

@@ -0,0 +1,45 @@
+"""crashbytes-strutils — Zero-dependency string utilities."""
+
+from crashbytes_strutils._core import (
+    between,
+    count_words,
+    initials,
+    is_blank,
+    is_valid_email,
+    mask,
+    pad_left,
+    pad_right,
+    remove_whitespace,
+    reverse,
+    slugify,
+    strip_html,
+    to_camel_case,
+    to_constant_case,
+    to_kebab_case,
+    to_pascal_case,
+    to_snake_case,
+    to_title_case,
+    truncate,
+)
+
+__all__ = [
+    "between",
+    "count_words",
+    "initials",
+    "is_blank",
+    "is_valid_email",
+    "mask",
+    "pad_left",
+    "pad_right",
+    "remove_whitespace",
+    "reverse",
+    "slugify",
+    "strip_html",
+    "to_camel_case",
+    "to_constant_case",
+    "to_kebab_case",
+    "to_pascal_case",
+    "to_snake_case",
+    "to_title_case",
+    "truncate",
+]

crashbytes_strutils/_core.py

@@ -0,0 +1,128 @@
+"""String utilities — case conversion, slugify, masking, and more."""
+
+from __future__ import annotations
+
+import re
+import unicodedata
+
+_EMAIL_RE = re.compile(r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$")
+_WORD_BOUNDARY_RE = re.compile(r"[A-Z]+(?=[A-Z][a-z])|[A-Z]?[a-z]+|[A-Z]+|[0-9]+")
+_NON_ALPHANUM_RE = re.compile(r"[^a-z0-9]+")
+_HTML_TAG_RE = re.compile(r"<[^>]+>")
+
+
+def _split_words(text: str) -> list[str]:
+    """Split text into words at case boundaries, spaces, hyphens, underscores."""
+    return _WORD_BOUNDARY_RE.findall(text)
+
+
+def to_snake_case(text: str) -> str:
+    """Convert text to ``snake_case``."""
+    return "_".join(w.lower() for w in _split_words(text))
+
+
+def to_camel_case(text: str) -> str:
+    """Convert text to ``camelCase``."""
+    words = _split_words(text)
+    if not words:
+        return ""
+    return words[0].lower() + "".join(w.capitalize() for w in words[1:])
+
+
+def to_pascal_case(text: str) -> str:
+    """Convert text to ``PascalCase``."""
+    return "".join(w.capitalize() for w in _split_words(text))
+
+
+def to_kebab_case(text: str) -> str:
+    """Convert text to ``kebab-case``."""
+    return "-".join(w.lower() for w in _split_words(text))
+
+
+def to_title_case(text: str) -> str:
+    """Convert text to ``Title Case``."""
+    return " ".join(w.capitalize() for w in _split_words(text))
+
+
+def to_constant_case(text: str) -> str:
+    """Convert text to ``CONSTANT_CASE``."""
+    return "_".join(w.upper() for w in _split_words(text))
+
+
+def slugify(text: str) -> str:
+    """Convert text to a URL-friendly slug."""
+    normalized = unicodedata.normalize("NFKD", text)
+    ascii_text = normalized.encode("ascii", "ignore").decode("ascii").lower()
+    slug = _NON_ALPHANUM_RE.sub("-", ascii_text).strip("-")
+    return re.sub(r"-{2,}", "-", slug)
+
+
+def truncate(text: str, max_length: int, suffix: str = "...") -> str:
+    """Truncate *text* to *max_length* characters, appending *suffix* if cut."""
+    if len(text) <= max_length:
+        return text
+    return text[: max_length - len(suffix)] + suffix
+
+
+def mask(text: str, visible: int = 4, char: str = "*") -> str:
+    """Mask all but the last *visible* characters."""
+    if len(text) <= visible:
+        return text
+    return char * (len(text) - visible) + text[-visible:]
+
+
+def between(text: str, start: str, end: str) -> str | None:
+    """Extract the substring between *start* and *end*, or ``None``."""
+    s = text.find(start)
+    if s == -1:
+        return None
+    s += len(start)
+    e = text.find(end, s)
+    if e == -1:
+        return None
+    return text[s:e]
+
+
+def strip_html(text: str) -> str:
+    """Remove HTML tags from *text*."""
+    return _HTML_TAG_RE.sub("", text)
+
+
+def is_valid_email(value: str) -> bool:
+    """Check if *value* is a valid email address."""
+    return bool(_EMAIL_RE.match(value))
+
+
+def is_blank(value: str | None) -> bool:
+    """Check if *value* is ``None``, empty, or whitespace-only."""
+    return value is None or value.strip() == ""
+
+
+def reverse(text: str) -> str:
+    """Reverse a string."""
+    return text[::-1]
+
+
+def count_words(text: str) -> int:
+    """Count the number of words in *text*."""
+    return len(text.split())
+
+
+def initials(text: str, separator: str = "") -> str:
+    """Extract initials from *text*."""
+    return separator.join(w[0].upper() for w in text.split() if w)
+
+
+def pad_left(text: str, length: int, char: str = " ") -> str:
+    """Pad *text* on the left to *length* with *char*."""
+    return text.rjust(length, char)
+
+
+def pad_right(text: str, length: int, char: str = " ") -> str:
+    """Pad *text* on the right to *length* with *char*."""
+    return text.ljust(length, char)
+
+
+def remove_whitespace(text: str) -> str:
+    """Remove all whitespace from *text*."""
+    return re.sub(r"\s+", "", text)

crashbytes_strutils-1.0.0.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: crashbytes-strutils
+Version: 1.0.0
+Summary: Zero-dependency string utilities — case conversion, slugify, masking, and more.
+Project-URL: Homepage, https://github.com/CrashBytes/crashbytes-strutils
+Project-URL: Repository, https://github.com/CrashBytes/crashbytes-strutils
+Project-URL: Issues, https://github.com/CrashBytes/crashbytes-strutils/issues
+Author-email: CrashBytes <crashbytes@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: case-conversion,slugify,string,text,utilities
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# crashbytes-strutils
+
+Zero-dependency string utilities — case conversion, slugify, masking, and more.
+
+## Install
+
+```bash
+pip install crashbytes-strutils
+```
+
+## Usage
+
+```python
+from crashbytes_strutils import to_snake_case, slugify, mask, truncate
+
+to_snake_case("helloWorld")      # "hello_world"
+slugify("Hello World!")          # "hello-world"
+mask("4111111111111111")         # "************1111"
+truncate("Long text here", 10)  # "Long te..."
+```
+
+## API
+
+### Case Conversion
+`to_snake_case`, `to_camel_case`, `to_pascal_case`, `to_kebab_case`, `to_title_case`, `to_constant_case`
+
+### Text Manipulation
+`slugify`, `truncate`, `mask`, `between`, `strip_html`, `reverse`, `pad_left`, `pad_right`, `remove_whitespace`
+
+### Validation
+`is_valid_email`, `is_blank`
+
+### Analysis
+`count_words`, `initials`
+
+## License
+
+MIT

crashbytes_strutils-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+crashbytes_strutils/__init__.py,sha256=hyyeSsxyoQgOm1tsoZTUPQFO8zZr_MvnYClXy-yYKmM,788
+crashbytes_strutils/_core.py,sha256=OPUp_g_ZxQKDbu_R0JUysh722WOQ9AAwnGOx1Tf8H3Q,3785
+crashbytes_strutils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+crashbytes_strutils-1.0.0.dist-info/METADATA,sha256=jnROKs2zhJ04Mtn0ezTtK7aplC4nT6PDAR-RpH956Ig,2042
+crashbytes_strutils-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+crashbytes_strutils-1.0.0.dist-info/licenses/LICENSE,sha256=Ic61HOO4EsyXXAGNY-D-1nG62feh_IBbipY1v_QcYcY,1067
+crashbytes_strutils-1.0.0.dist-info/RECORD,,

crashbytes_strutils-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

crashbytes_strutils-1.0.0.dist-info/licenses/LICENSE

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