textutils-nabil184 0.2.1__py3-none-any.whl

textutils/__init__.py

@@ -0,0 +1,13 @@
+"""A lightweight Python library for text processing."""
+
+from .casing import capitalize_words
+from .counting import character_count, word_count, word_frequency
+from .transform import reverse
+
+__all__ = [
+    "word_count",
+    "character_count",
+    "reverse",
+    "capitalize_words",
+    "word_frequency",
+]

textutils/casing/__init__.py

@@ -0,0 +1,5 @@
+"""Text capitalization utilities."""
+
+from ._capitalize import capitalize_words
+
+__all__ = ["capitalize_words"]

textutils/casing/_capitalize.py

@@ -0,0 +1,23 @@
+def capitalize_words(text: str) -> str:
+    """Capitalize the first letter of each word.
+
+    Parameters
+    ----------
+    text : str
+        The input text.
+
+    Returns
+    -------
+    str
+        Text with each word capitalized.
+
+    Examples
+    --------
+    >>> capitalize_words("hello world")
+    'Hello World'
+    >>> capitalize_words("hello open source")
+    'Hello Open Source'
+    >>> capitalize_words("")
+    ''
+    """
+    return text.title()

textutils/counting/__init__.py

@@ -0,0 +1,6 @@
+"""Word and character counting utilities."""
+
+from ._count import character_count, word_count
+from ._frequency import word_frequency
+
+__all__ = ["word_count", "character_count", "word_frequency"]

textutils/counting/_count.py

@@ -0,0 +1,44 @@
+def word_count(text: str) -> int:
+    """Count the number of words in a text.
+
+    Parameters
+    ----------
+    text : str
+        The input text.
+
+    Returns
+    -------
+    int
+        Number of words in the text.
+
+    Examples
+    --------
+    >>> word_count("Hello Open Source")
+    3
+    >>> word_count("")
+    0
+    """
+    return len(text.split())
+
+
+def character_count(text: str) -> int:
+    """Count the number of characters in a text.
+
+    Parameters
+    ----------
+    text : str
+        The input text.
+
+    Returns
+    -------
+    int
+        Number of characters, including spaces.
+
+    Examples
+    --------
+    >>> character_count("Hello")
+    5
+    >>> character_count("Hello World")
+    11
+    """
+    return len(text)

textutils/counting/_frequency.py

@@ -0,0 +1,59 @@
+"""Utilities for counting word frequencies.
+
+Original implementation inspired by:
+https://www.geeksforgeeks.org/python/find-frequency-of-each-word-in-a-string-in-python/
+"""
+
+import re
+from collections import Counter
+
+
+def word_frequency(s: str) -> dict[str, int]:
+    """Count the frequency of each word in a text.
+
+    The comparison is case-insensitive and punctuation is ignored.
+
+    Parameters
+    ----------
+    s : str
+        The input text.
+
+    Returns
+    -------
+    dict[str, int]
+        A dictionary containing each word and its frequency.
+
+    Raises
+    ------
+    TypeError
+        If the input is not a string.
+
+    Examples
+    --------
+    >>> word_frequency("Hello hello world!")
+    {'hello': 2, 'world': 1}
+    >>> word_frequency("")
+    {}
+    """
+    if not isinstance(s, str):
+        raise TypeError("Input must be a string")
+
+    words = s.split()
+
+    cleaned_words = []
+    for word in words:
+        cleaned_words.extend(re.findall(r"\b\w+\b", word.casefold()))
+
+    words = cleaned_words
+    freq = Counter(words)
+
+    result = {}
+    for w, c in freq.items():
+        result[w] = c
+
+    return result
+
+
+# Usage example
+if __name__ == "__main__":
+    print(word_frequency("hello hello there"))

textutils/transform/__init__.py

@@ -0,0 +1,5 @@
+"""Text transformation utilities."""
+
+from ._reverse import reverse
+
+__all__ = ["reverse"]

textutils/transform/_reverse.py

@@ -0,0 +1,21 @@
+def reverse(text: str) -> str:
+    """Reverse the characters in a text.
+
+    Parameters
+    ----------
+    text : str
+        The input text.
+
+    Returns
+    -------
+    str
+        Text with its characters in reverse order.
+
+    Examples
+    --------
+    >>> reverse("Hello")
+    'olleH'
+    >>> reverse("")
+    ''
+    """
+    return text[::-1]

textutils_nabil184-0.2.1.dist-info/METADATA

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: textutils-nabil184
+Version: 0.2.1
+Summary: A lightweight Python library for common text-processing operations.
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/nabil184/textutils
+Project-URL: Repository, https://github.com/nabil184/textutils
+Project-URL: Issues, https://github.com/nabil184/textutils/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: pytest-cov<8,>=5; extra == "dev"
+Requires-Dist: black==25.1.0; extra == "dev"
+Requires-Dist: ruff==0.9.7; extra == "dev"
+Requires-Dist: pre-commit<5,>=3; extra == "dev"
+Dynamic: license-file
+
+
+# textutils
+
+`textutils` is a lightweight Python library providing simple
+utilities for common text-processing operations.
+
+## Features
+
+The library currently provides:
+
+- `word_count(text)` - Count the number of words in a text.
+- `character_count(text)` - Count the number of characters.
+- `reverse(text)` - Reverse a text.
+- `capitalize_words(text)` - Capitalize each word.
+- `word_frequency(text)` - Count how often each word appears.
+
+## Installation
+
+Requires Python 3.10 or newer.
+
+After the first PyPI release is published, install the package with:
+
+```bash
+python -m pip install textutils-nabil184
+```
+
+The distribution name on PyPI is `textutils-nabil184`,
+while the Python import name remains `textutils`.
+
+## Usage
+
+```python
+from textutils import (
+    word_count,
+    character_count,
+    reverse,
+    capitalize_words,
+    word_frequency,
+)
+
+text = "hello open source"
+
+print(word_count(text))
+print(character_count(text))
+print(reverse(text))
+print(capitalize_words(text))
+print(word_frequency("Hello hello world!"))
+```
+
+Expected output:
+
+```text
+3
+17
+ecruos nepo olleh
+Hello Open Source
+{'hello': 2, 'world': 1}
+```
+
+## Development
+
+Clone the repository and install the package with its development dependencies:
+
+```bash
+git clone https://github.com/nabil184/textutils.git
+cd textutils
+python -m pip install -e ".[dev]"
+```
+
+### Running tests
+
+Run the complete test suite:
+
+```bash
+python -m pytest -v
+```
+
+Run tests with coverage:
+
+```bash
+python -m pytest --cov=textutils --cov-branch --cov-report=term-missing
+```
+
+Tests are organized inside each subpackage, close to the corresponding implementation.
+
+### Code quality
+
+Format the project with Black:
+
+```bash
+python -m black .
+```
+
+Check formatting without modifying files:
+
+```bash
+python -m black --check .
+```
+
+Check code quality with Ruff:
+
+```bash
+python -m ruff check .
+```
+
+## Continuous Integration
+
+This project uses GitHub Actions to automatically check
+code quality and run the test suite.
+
+The CI workflow runs on Pull Requests targeting `main`
+and on pushes to `main`.
+
+Four environments are tested:
+
+- Ubuntu 22.04 with Python 3.11
+- Ubuntu 22.04 with Python 3.12
+- macOS 15 with Python 3.11
+- macOS 15 with Python 3.12
+
+Each CI job installs the project, checks Black and Ruff,
+and executes pytest.
+
+## Pre-commit
+
+The project uses pre-commit to run Black and Ruff
+automatically before commits.
+
+Install the development dependencies:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Install the Git hook:
+
+```bash
+python -m pre_commit install
+```
+
+Run all hooks manually:
+
+```bash
+python -m pre_commit run --all-files
+```
+
+## Contributing
+
+Contributions are welcome.
+
+To contribute, create a branch, make your changes,
+run the tests and open a Pull Request.
+
+Please ensure that tests pass and that Black and Ruff
+report no issues before submitting your changes.
+
+## License
+
+This project is licensed under the MIT License.
+See the `LICENSE` file for details.

textutils_nabil184-0.2.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+textutils/__init__.py,sha256=J_D-On4eSBXxdA3hiHCkdV5KbcccMeAc76ZxGRNmFwA,308
+textutils/casing/__init__.py,sha256=HclnwhnQ51_GsIAuESMH2thPGrhGoAm9YX6xKU_oR8k,112
+textutils/casing/_capitalize.py,sha256=QkvQullObx4omYLAd9oY2nueipE6evaNg_t4byK5LRA,456
+textutils/counting/__init__.py,sha256=OfRTwjRZ3PEZ9BVd1DZ84yNrIGcQB_yZNxxPrPctw10,196
+textutils/counting/_count.py,sha256=XiqSvmDwYUnnLbZDpIJmNo6Ctzl_eGU83txskZASRYs,739
+textutils/counting/_frequency.py,sha256=TsYxBatJv5iTZ_M2ssM2GL4NsDni3LYr1tpzDsI1V_Y,1228
+textutils/transform/__init__.py,sha256=Oru74s2ag7iSW7-bdIdAf3yaF_reMgrwx9CocsJJBvo,91
+textutils/transform/_reverse.py,sha256=b_yqRLCKURL4XOepTzPbVUEgoIE6vEdMDy3XD0XOH1c,347
+textutils_nabil184-0.2.1.dist-info/licenses/LICENSE,sha256=Hi_qIjtzkT7OSK5OVGpiUkpgthb-W5pyM2Uk4TMUcoA,1069
+textutils_nabil184-0.2.1.dist-info/METADATA,sha256=rkVjt9GSAGQXZVafgJhJAh1DL0brZdEC2wIcOBe6gEg,3659
+textutils_nabil184-0.2.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+textutils_nabil184-0.2.1.dist-info/top_level.txt,sha256=amWgGsYwaWzVol7zPaWIjxj2Of6hEptj7rE9MR3bp_E,10
+textutils_nabil184-0.2.1.dist-info/RECORD,,

textutils_nabil184-0.2.1.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_nabil184-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NABIL DAHMANI
+
+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_nabil184-0.2.1.dist-info/top_level.txt

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