ingabotool 0.1.0__py3-none-any.whl

ingabotool/__init__.py

@@ -0,0 +1,4 @@
+from .text_utils import slugify, truncate, is_valid_email, mask_email, generate_id
+
+__version__ = "0.1.0"
+__all__ = ["slugify", "truncate", "is_valid_email", "mask_email", "generate_id"]

ingabotool/text_utils.py

@@ -0,0 +1,86 @@
+import re
+import uuid
+
+def slugify(text: str) -> str:
+    """
+    Convert text to lowercase, remove unnecessary punctuation,
+    and replace spaces and repeated separators with a single hyphen.
+    """
+    if not isinstance(text, str):
+        raise TypeError("Input must be a string")
+    
+    text = text.lower()
+    # Remove punctuation except spaces and hyphens
+    text = re.sub(r'[^\w\s-]', '', text)
+    # Replace spaces and repeated hyphens with a single hyphen
+    text = re.sub(r'[\s-]+', '-', text)
+    # Strip leading/trailing hyphens
+    return text.strip('-')
+
+
+def truncate(text: str, max_length: int, suffix: str = "...") -> str:
+    """
+    Return the original text if it fits within max_length.
+    Otherwise truncate it and append the suffix.
+    The final result will not exceed max_length.
+    """
+    if not isinstance(text, str):
+        raise TypeError("Text must be a string")
+    if not isinstance(max_length, int) or max_length < 0:
+        raise ValueError("max_length must be a non-negative integer")
+    if len(suffix) > max_length:
+        raise ValueError("suffix length cannot be greater than max_length")
+        
+    if len(text) <= max_length:
+        return text
+    
+    return text[:max_length - len(suffix)] + suffix
+
+
+def is_valid_email(email: str) -> bool:
+    """
+    Perform a simple practical email-format validation.
+    """
+    if not isinstance(email, str):
+        return False
+    # Simple regex for practical validation: something@something.something
+    pattern = r'^[^@\s]+@[^@\s]+\.[^@\s]+$'
+    return bool(re.match(pattern, email))
+
+
+def mask_email(email: str) -> str:
+    """
+    Hide part of the username while keeping the domain visible.
+    """
+    if not isinstance(email, str) or '@' not in email:
+        return email
+    
+    parts = email.split('@')
+    if len(parts) != 2:
+        return email
+        
+    username, domain = parts
+    
+    # Handle empty username
+    if not username:
+        return f"@{domain}"
+    
+    if len(username) > 1:
+        masked_username = username[0] + "*" * (len(username) - 1)
+    else:
+        masked_username = "*" * len(username)
+        
+    return f"{masked_username}@{domain}"
+
+
+def generate_id(prefix: str = "id") -> str:
+    """
+    Generate a short unique identifier using Python's standard library.
+    """
+    if not isinstance(prefix, str):
+        raise TypeError("Prefix must be a string")
+        
+    unique_part = uuid.uuid4().hex[:8]
+    if prefix:
+        return f"{prefix}_{unique_part}"
+    return unique_part

ingabotool-0.1.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: ingabotool
+Version: 0.1.0
+Summary: A small, professional Python package for developer utilities.
+Author: Developer
+License: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ingabotool
+
+A small, professional Python package that provides a set of reusable developer utilities for common text manipulation and validation tasks.
+
+## Features
+
+- **`slugify`**: Convert text into URL-friendly strings.
+- **`truncate`**: Safely truncate strings and append a suffix if they exceed a maximum length.
+- **`is_valid_email`**: Perform practical validation of email formats.
+- **`mask_email`**: Obfuscate email usernames while preserving the domain for privacy.
+- **`generate_id`**: Generate short, unique alphanumeric identifiers with an optional prefix.
+
+## Installation for Local Development
+
+You can install this package locally in editable mode. Navigate to the root directory of the package (where `pyproject.toml` is located) and run:
+
+```bash
+pip install -e .
+```
+
+To build the package distribution files:
+
+```bash
+python -m build
+```
+*(If `build` is not installed, install it via: `pip install build`)*
+
+To run the test suite:
+
+```bash
+python -m unittest discover -s tests
+```
+*Note: Make sure your `PYTHONPATH` includes the `src` directory if not installing first, or run from the root directory.*
+
+
+## Usage Examples
+
+```python
+from ingabotool import slugify, truncate, is_valid_email, mask_email, generate_id
+
+# 1. slugify
+print(slugify("Hello, World!"))
+# Output: "hello-world"
+
+# 2. truncate
+print(truncate("This is a long sentence", 10))
+# Output: "This is..."
+
+# 3. is_valid_email
+print(is_valid_email("user@example.com"))
+# Output: True
+
+# 4. mask_email
+print(mask_email("john.doe@gmail.com"))
+# Output: "j*******@gmail.com"
+
+# 5. generate_id
+print(generate_id("user"))
+# Output: "user_a8f31c4b" (random)
+```
+
+## Available Functions
+
+- `slugify(text: str) -> str`
+- `truncate(text: str, max_length: int, suffix: str = "...") -> str`
+- `is_valid_email(email: str) -> bool`
+- `mask_email(email: str) -> str`
+- `generate_id(prefix: str = "id") -> str`

ingabotool-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+ingabotool/__init__.py,sha256=BEB-0YuH5gULQvwSF_LN9aQJaFNdO9OqYvKHEioLDys,191
+ingabotool/text_utils.py,sha256=ty2fW9Hn9eVELDu6t9DnFrf5Y233niOoo1jVj7eiaGQ,2617
+ingabotool-0.1.0.dist-info/licenses/LICENSE,sha256=sUW-CyNFPxU9jXLoXhI9kJwgi4Yy4oAmTuANa6J7Vfw,1087
+ingabotool-0.1.0.dist-info/METADATA,sha256=-iPU8jDg2vMS7TqbzVEM8eIJ_Hsw-_2qyMWSVAXXAak,2382
+ingabotool-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ingabotool-0.1.0.dist-info/top_level.txt,sha256=BxQGSRqNmNBPl8pAYP5pPEGmdjKUfuLjf1bSRzHjz-E,11
+ingabotool-0.1.0.dist-info/RECORD,,

ingabotool-0.1.0.dist-info/WHEEL

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

ingabotool-0.1.0.dist-info/licenses/LICENSE

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

ingabotool-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ingabotool