textutils-strickerman 0.2.0__py3-none-any.whl

casing/__init__.py

@@ -0,0 +1,4 @@
+from ._capitalize_words import capitalize_words
+from ._kebab_case import kebab_case
+
+__all__ = ["capitalize_words", "kebab_case"]

casing/_capitalize_words.py

@@ -0,0 +1,28 @@
+def capitalize_words(text: str) -> str:
+    """Capitalize the first letter of each word in a string.
+
+    Parameters
+    ----------
+    text : str
+        The input string to transform.
+
+    Returns
+    -------
+    str
+        The string with each word capitalized.
+
+    Raises
+    ------
+    TypeError
+        If text is not a string.
+    """
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+
+    words = text.split(" ")
+    words_capitalised = []
+
+    for word in words:
+        words_capitalised.append(word.capitalize())
+
+    return " ".join(words_capitalised)

casing/_kebab_case.py

@@ -0,0 +1,24 @@
+def kebab_case(text: str) -> str:
+    """Convert a string to kebab-case format.
+
+    Parameters
+    ----------
+    text : str
+        The input string to transform.
+
+    Returns
+    -------
+    str
+        The input string converted to kebab-case.
+
+    Raises
+    ------
+    TypeError
+        If text is not a string.
+    """
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+
+    clean_text = text.replace("_", " ").strip()
+    words = clean_text.split()
+    return "-".join(words).lower()

textutils_strickerman-0.2.0.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: textutils-strickerman
+Version: 0.2.0
+Summary: A utility package for text manipulation and analysis.
+Author: Esteban Stricker
+Requires-Python: >=3.10
+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.3.0; extra == "dev"
+Dynamic: license-file
+
+# textutils
+
+A lightweight Python library providing common text-processing and manipulation utilities.
+Developed as part of the *Open Source Development* course at ENSISA, Université de Haute-Alsace.
+
+## Features
+
+This initial version provides essential string manipulation tools:
+* `word_count(text)`: Counts the number of words in a given text string.
+* `character_count(text)`: Returns the total number of characters in the string.
+* `reverse(text)`: Returns the string reversed character by character.
+* `capitalize_words(text)`: Capitalizes the first letter of each word in the string.
+
+*(Planned features for upcoming versions: `snake_case()`, `camel_case()`, and `slugify()`)*
+
+## Installation
+
+### For Users
+Install the package directly via `pip`:
+```bash
+pip install textutils
+```
+
+### For Development / Contributors
+Clone the repository and install it in editable mode with development dependencies:
+```bash
+git clone https://github.com/<your-username>/textutils.git
+cd textutils
+pip install -e .[dev]
+```
+
+## Usage
+
+Here is a quick example demonstrating how to import and use the functions:
+
+```python
+from textutils import (
+    capitalize_words,
+    character_count,
+    reverse,
+    word_count,
+)
+
+sample_text = "hello open source world"
+
+# 1. Count words
+print(word_count(sample_text))         # Output: 4
+
+# 2. Count characters
+print(character_count(sample_text))    # Output: 23
+
+# 3. Capitalize words
+print(capitalize_words(sample_text))   # Output: "Hello Open Source World"
+
+# 4. Reverse text
+print(reverse(sample_text))            # Output: "dlrow ecruos nepo olleh"
+```
+
+## Contributing
+
+Contributions are welcome! To contribute to this project, please follow these steps:
+
+1. Fork the repository.
+2. Create a dedicated branch for your feature or fix:
+   ```bash
+   git switch -c feature/my-new-feature
+   ```
+3. Commit your changes with clear, descriptive commit messages:
+   ```bash
+   git commit -m "Add unit tests for capitalize_words"
+   ```
+4. Push your branch to your fork:
+   ```bash
+   git push origin feature/my-new-feature
+   ```
+5. Open a Pull Request on GitHub describing your modifications.
+
+## Author
+
+**Esteban Stricker**
+
+## License
+
+This project is licensed under the MIT License.

textutils_strickerman-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+casing/__init__.py,sha256=cYCnCYIbtbsLbs5_60e-owLJVUNaeI3mOuS-3h7whyU,129
+casing/_capitalize_words.py,sha256=gYBrxOLDNQDQZzLjtpHvq_J6QDWoQOlv_BOZLxl81gw,598
+casing/_kebab_case.py,sha256=yq9Pjj_NX0eqBwRfIr2tcsORZj9kyLl3kWi9-HDsFeY,523
+textutils_strickerman-0.2.0.dist-info/licenses/LICENSE,sha256=GQyykhDrWjVzg8DPEAYRefggkUgk7-dNwEEF6GDUJco,1073
+transform/__init__.py,sha256=ln29mb82KJDkaeqd40g4VKr2jiNvp2pBcZQX0YWl03E,168
+transform/_character_count.py,sha256=5Y9-8wrQ1rSGzGTuehJ88d4pzY_Nnxx9zDx5W8p8z3I,478
+transform/_reverse.py,sha256=TA2OE7xdZqQXeXNS43KgubKPWmS4wfwsr3Q9uMbpWW4,385
+transform/_word_count.py,sha256=8wVCDyttLq1jJKm6VnWqE9gHPseddPE4AJfYKVZpuM0,471
+textutils_strickerman-0.2.0.dist-info/METADATA,sha256=jeyAs0CrB2SbL3dEhQ5gw9Qbv0DAZA4RpqKKxRXvo_8,2680
+textutils_strickerman-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+textutils_strickerman-0.2.0.dist-info/top_level.txt,sha256=uz71-K1n4QmBG7-KLtqa0D5OLjrITLttjVLidw10kH8,17
+textutils_strickerman-0.2.0.dist-info/RECORD,,

textutils_strickerman-0.2.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_strickerman-0.2.0.dist-info/licenses/LICENSE

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

textutils_strickerman-0.2.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+casing
+transform

transform/__init__.py

@@ -0,0 +1,5 @@
+from ._character_count import character_count
+from ._reverse import reverse
+from ._word_count import word_count
+
+__all__ = ["character_count", "reverse", "word_count"]

transform/_character_count.py

@@ -0,0 +1,25 @@
+def character_count(text: str) -> int:
+    """Count the total number of characters in a string.
+
+    Parameters
+    ----------
+    text : str
+        The input string to analyze.
+
+    Returns
+    -------
+    int
+        The number of characters in the string.
+
+    Raises
+    ------
+    TypeError
+        If text is not a string.
+    """
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+
+    if not text:
+        return 0
+
+    return len(text)

transform/_reverse.py

@@ -0,0 +1,22 @@
+def reverse(text: str) -> str:
+    """Reverse a string.
+
+    Parameters
+    ----------
+    text : str
+        The input string to reverse.
+
+    Returns
+    -------
+    str
+        The string reversed.
+
+    Raises
+    ------
+    TypeError
+        If text is not a string.
+    """
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+
+    return text[::-1]

transform/_word_count.py

@@ -0,0 +1,25 @@
+def word_count(text: str) -> int:
+    """Count the total number of words in a string.
+
+    Parameters
+    ----------
+    text : str
+        The input string to analyze.
+
+    Returns
+    -------
+    int
+        The number of words in the string.
+
+    Raises
+    ------
+    TypeError
+        If text is not a string.
+    """
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+
+    if not text:
+        return 0
+
+    return len(text.split())