text-chaos 1.0.2

A fun library for playful string manipulations like leetify, uwuify, zalgo, and more!

text-chaos 🎭

A fun Python library for playful string manipulations! Transform your text with various chaotic and amusing effects like leet speak, uwu-ification, zalgo corruption, and more.

✨ Features

• 🔥 Simple API: One function call to rule them all
• 🎯 Multiple transformations: leet, uwu, drunk, mock, pirate, and more
• 📦 Extensible: Easy to add custom transformations
• 🔍 Type hints: Full typing support for better IDE experience
• 🧪 Well tested: Comprehensive test suite with pytest
• 🚀 Fast: Lightweight with no external dependencies

🚀 Installation

pip install text-chaos

📖 Quick Start

import text_chaos

# Basic usage - defaults to leet speak
text_chaos.transform("Hello World!")
# Output: "H3110 W0r1d!"

# Try different transformation modes
text_chaos.transform("Hello World!", mode="uwu")
# Output: "Hewwo Wowwd! uwu"

text_chaos.transform("Hello World!", mode="drunk") 
# Output: "Helo Worrd!"

text_chaos.transform("Hello World!", mode="pirate")
# Output: "ahoy World! Arr!"

# Transform multiple strings at once
text_chaos.batch_transform(["Hello", "World"], mode="leet")
# Output: ["H3110", "W0r1d"]

# See all available transformation modes
text_chaos.get_modes()
# Output: ['leet', 'uwu', 'drunk', 'mock', 'pirate']

🎨 Available Transformations

Mode	Description	Example
leet	Convert to leet speak (1337)	Hello → H3110
uwu	UwU-ify text with cute speak	Hello World → Hewwo Wowwd uwu
drunk	Add typos and drunk typing errors	Hello World → Helo Worrld
mock	Add conversational fillers and pauses	This is fine → This... uhh is, like, fine
pirate	Transform to pirate speak	Hello friend → Ahoy matey! Arr!

🔧 API Reference

transform(text: str, mode: str = "leet") -> str

Transform a single string using the specified mode.

Parameters:

• text (str): The input text to transform
• mode (str, optional): The transformation mode. Defaults to "leet"

Returns:

• str: The transformed text

Raises:

• ValueError: If the specified mode is not available
• TypeError: If text is not a string

batch_transform(texts: List[str], mode: str = "leet") -> List[str]

Transform multiple strings using the specified mode.

Parameters:

• texts (List[str]): List of input texts to transform
• mode (str, optional): The transformation mode. Defaults to "leet"

Returns:

• List[str]: List of transformed texts

get_modes() -> List[str]

Get a list of all available transformation modes.

Returns:

• List[str]: Available transformation mode names

🛠️ Development

Setup

# Clone the repository
git clone https://github.com/guroosh/text-chaos.git
cd text-chaos

# Install in development mode with dev dependencies
pip install -e ".[dev]"

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=text_chaos --cov-report=html

# Run specific test file
pytest tests/test_text_chaos.py -v

Code Quality

# Format code
black src/ tests/

# Sort imports  
isort src/ tests/

# Type checking
mypy src/

# Run all quality checks
black src/ tests/ && isort src/ tests/ && mypy src/ && pytest

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Add new transformations: Create new functions in src/text_chaos/transformers.py
2. Improve existing transformations: Make them funnier, more accurate, or more efficient
3. Fix bugs: Check the issues tab for known problems
4. Add tests: Help us maintain high code coverage
5. Improve documentation: Better examples, clearer explanations

Adding a New Transformation

1. Add your transformation function to src/text_chaos/transformers.py:

def my_transform(text: str) -> str:
    \"\"\"
    Description of your transformation.
    
    Args:
        text: The input text to transform
        
    Returns:
        The transformed text
    \"\"\"
    # Your transformation logic here
    return transformed_text

2. Register it in the TRANSFORMERS dictionary:

TRANSFORMERS = {
    # ... existing transformers
    "my_mode": my_transform,
}

3. Add tests in tests/test_text_chaos.py

4. Update this README with the new transformation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🎉 Fun Examples

import text_chaos

# Create some chaos!
text = "Python is awesome"

print("Original:", text)
print("Leet:", text_chaos.transform(text, "leet"))
print("UwU:", text_chaos.transform(text, "uwu"))  
print("Drunk:", text_chaos.transform(text, "drunk"))
print("Mock:", text_chaos.transform(text, "mock"))
print("Pirate:", text_chaos.transform(text, "pirate"))

# Chain transformations manually
chaotic_text = text_chaos.transform(text, "leet")
chaotic_text = text_chaos.transform(chaotic_text, "uwu")
print("Leet + UwU:", chaotic_text)

🌟 Star History

If you found this library useful, please consider giving it a star on GitHub! ⭐

---

Made with ❤️ and a bit of chaos 🎭