ingabotool 0.1.0__tar.gz

ingabotool-0.1.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,68 @@
+# 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/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ingabotool"
+version = "0.1.0"
+description = "A small, professional Python package for developer utilities."
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT License"}
+authors = [
+  {name = "Developer"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]

ingabotool-0.1.0/setup.cfg

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

ingabotool-0.1.0/src/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-0.1.0/src/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/src/ingabotool.egg-info/PKG-INFO

@@ -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/src/ingabotool.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/ingabotool/__init__.py
+src/ingabotool/text_utils.py
+src/ingabotool.egg-info/PKG-INFO
+src/ingabotool.egg-info/SOURCES.txt
+src/ingabotool.egg-info/dependency_links.txt
+src/ingabotool.egg-info/top_level.txt
+tests/test_text_utils.py

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

@@ -0,0 +1 @@
+

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

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

ingabotool-0.1.0/tests/test_text_utils.py

@@ -0,0 +1,54 @@
+import unittest
+from ingabotool import slugify, truncate, is_valid_email, mask_email, generate_id
+
+class TestTextUtils(unittest.TestCase):
+
+    def test_slugify(self):
+        self.assertEqual(slugify("Hello, World!"), "hello-world")
+        self.assertEqual(slugify("  Spaces   and-hyphens  "), "spaces-and-hyphens")
+        self.assertEqual(slugify("multiple---hyphens"), "multiple-hyphens")
+        self.assertEqual(slugify(""), "")
+        with self.assertRaises(TypeError):
+            slugify(123)
+
+    def test_truncate(self):
+        self.assertEqual(truncate("hello world", 8), "hello...")
+        self.assertEqual(truncate("hello world", 15), "hello world")
+        self.assertEqual(truncate("hello", 10), "hello")
+        self.assertEqual(truncate("hello world", 7, ".."), "hello..")
+        with self.assertRaises(ValueError):
+            truncate("hello", 2, "...")
+        with self.assertRaises(ValueError):
+            truncate("hello", -1)
+            
+    def test_is_valid_email(self):
+        self.assertTrue(is_valid_email("john.doe@gmail.com"))
+        self.assertTrue(is_valid_email("user.name+tag@example.co.uk"))
+        self.assertFalse(is_valid_email("invalid-email"))
+        self.assertFalse(is_valid_email("missing@domain"))
+        self.assertFalse(is_valid_email("@domain.com"))
+        self.assertFalse(is_valid_email(""))
+        self.assertFalse(is_valid_email(None))
+
+    def test_mask_email(self):
+        self.assertEqual(mask_email("john.doe@gmail.com"), "j*******@gmail.com")
+        self.assertEqual(mask_email("a@b.com"), "*@b.com")
+        self.assertEqual(mask_email("invalid"), "invalid")
+        self.assertEqual(mask_email(""), "")
+        self.assertEqual(mask_email("@b.com"), "@b.com")
+        
+    def test_generate_id(self):
+        id1 = generate_id("user")
+        id2 = generate_id("user")
+        self.assertTrue(id1.startswith("user_"))
+        self.assertNotEqual(id1, id2)
+        
+        id3 = generate_id()
+        self.assertTrue(id3.startswith("id_"))
+        
+        id4 = generate_id("")
+        self.assertTrue(len(id4) == 8)
+        self.assertNotIn("_", id4)
+
+if __name__ == "__main__":
+    unittest.main()