fated 0.2.1__tar.gz

fated-0.2.1/LICENSE

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

fated-0.2.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+recursive-include fate *

fated-0.2.1/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: fated
+Version: 0.2.1
+Summary: A Python library for adding visual effects to terminal text output
+Author-email: Fred <fredised@users.noreply.github.com>
+Project-URL: Homepage, https://github.com/fredised/fated
+Project-URL: Bug Tracker, https://github.com/fredised/fated/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: General
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: build>=1.1.1
+Requires-Dist: setuptools>=68.0.0
+Requires-Dist: twine>=4.0.2
+Dynamic: license-file
+
+# Fated - Text Effects Library for Python
+
+Fated is a Python library that adds visual effects to text output including typewriter animation and other text styling options. It provides a simple API for creating rich, animated terminal text with no external dependencies.
+
+## Features
+
+- **Text Animation Effects**: Typewriter, blink, fade-in, wave, glitch, shake, matrix, and more
+- **Text Styling**: Colors, background colors, bold, italic, underline, and other text styles
+- **Chainable Effects**: Combine multiple effects together seamlessly
+- **Simple API**: Intuitive interface that works with standard print function
+- **Alternative Syntax**: Use the + operator with shortcut objects for even cleaner code
+- **No Dependencies**: Uses only Python standard library modules
+
+## Installation
+
+Install directly from PyPI using pip:
+
+```bash
+pip install fated
+```
+
+Alternative installation methods:
+
+1. Clone the repository and include the `fate` folder in your project:
+
+```bash
+git clone https://github.com/fredised/fated.git
+```
+
+2. Or simply copy the `fate` directory to your project.
+
+## Usage
+
+### Traditional Syntax
+
+```python
+from fate import typewriter, color, style
+
+# Simple typewriter effect
+print(typewriter("Hello, World!"))
+
+# Colored text
+print(color.red("This text is red"))
+print(color.blue("This text is blue"))
+
+# Text styling
+print(style.bold("Bold text"))
+print(style.italic("Italic text"))
+
+# Chain multiple effects
+print(style.bold(color.green(typewriter("Bold green typewriter text"))))
+
+# Predefined combinations
+from fate import error, warning, success, info
+print(error("Error message"))
+print(success("Success message"))
+```
+
+### Shortcut Syntax (New!)
+
+```python
+from fate.shortcuts import fateTypeWriter, fateRed, fateBold
+
+# Use the + operator
+print(fateTypeWriter + "Hello, World!")
+
+# Colored text
+print(fateRed + "This text is red")
+
+# Text styling
+print(fateBold + "Bold text")
+
+# Custom parameters
+print(fateTypeWriter(speed=20) + "Fast typing!")
+
+# Predefined combinations
+from fate.shortcuts import fateError, fateSuccess
+print(fateError + "Error message")
+print(fateSuccess + "Success message")
+```
+
+## Examples
+
+The repository includes example files:
+
+- `examples.py` - Demonstrates the traditional syntax
+- `shortcut_example.py` - Demonstrates the new shortcut syntax
+
+Run the examples to see the library in action:
+
+```bash
+python examples.py
+python shortcut_example.py
+```
+
+## Available Effects
+
+- `typewriter` - Types text character by character
+- `blink` - Makes text blink
+- `fade_in` - Gradually reveals text
+- `wave` - Creates a wave-like animation
+- `glitch` - Creates a glitchy, distorted effect
+- `shake` - Shakes the text
+- `rainbow` - Cycles through rainbow colors
+- `typing_with_errors` - Realistic typing with random errors
+- `matrix_effect` - Matrix-like falling character effect
+- `slide_in` - Slides text in from left or right
+- `reveal_masked` - Reveals masked text character by character

fated-0.2.1/README.md

@@ -0,0 +1,108 @@
+# Fated - Text Effects Library for Python
+
+Fated is a Python library that adds visual effects to text output including typewriter animation and other text styling options. It provides a simple API for creating rich, animated terminal text with no external dependencies.
+
+## Features
+
+- **Text Animation Effects**: Typewriter, blink, fade-in, wave, glitch, shake, matrix, and more
+- **Text Styling**: Colors, background colors, bold, italic, underline, and other text styles
+- **Chainable Effects**: Combine multiple effects together seamlessly
+- **Simple API**: Intuitive interface that works with standard print function
+- **Alternative Syntax**: Use the + operator with shortcut objects for even cleaner code
+- **No Dependencies**: Uses only Python standard library modules
+
+## Installation
+
+Install directly from PyPI using pip:
+
+```bash
+pip install fated
+```
+
+Alternative installation methods:
+
+1. Clone the repository and include the `fate` folder in your project:
+
+```bash
+git clone https://github.com/fredised/fated.git
+```
+
+2. Or simply copy the `fate` directory to your project.
+
+## Usage
+
+### Traditional Syntax
+
+```python
+from fate import typewriter, color, style
+
+# Simple typewriter effect
+print(typewriter("Hello, World!"))
+
+# Colored text
+print(color.red("This text is red"))
+print(color.blue("This text is blue"))
+
+# Text styling
+print(style.bold("Bold text"))
+print(style.italic("Italic text"))
+
+# Chain multiple effects
+print(style.bold(color.green(typewriter("Bold green typewriter text"))))
+
+# Predefined combinations
+from fate import error, warning, success, info
+print(error("Error message"))
+print(success("Success message"))
+```
+
+### Shortcut Syntax (New!)
+
+```python
+from fate.shortcuts import fateTypeWriter, fateRed, fateBold
+
+# Use the + operator
+print(fateTypeWriter + "Hello, World!")
+
+# Colored text
+print(fateRed + "This text is red")
+
+# Text styling
+print(fateBold + "Bold text")
+
+# Custom parameters
+print(fateTypeWriter(speed=20) + "Fast typing!")
+
+# Predefined combinations
+from fate.shortcuts import fateError, fateSuccess
+print(fateError + "Error message")
+print(fateSuccess + "Success message")
+```
+
+## Examples
+
+The repository includes example files:
+
+- `examples.py` - Demonstrates the traditional syntax
+- `shortcut_example.py` - Demonstrates the new shortcut syntax
+
+Run the examples to see the library in action:
+
+```bash
+python examples.py
+python shortcut_example.py
+```
+
+## Available Effects
+
+- `typewriter` - Types text character by character
+- `blink` - Makes text blink
+- `fade_in` - Gradually reveals text
+- `wave` - Creates a wave-like animation
+- `glitch` - Creates a glitchy, distorted effect
+- `shake` - Shakes the text
+- `rainbow` - Cycles through rainbow colors
+- `typing_with_errors` - Realistic typing with random errors
+- `matrix_effect` - Matrix-like falling character effect
+- `slide_in` - Slides text in from left or right
+- `reveal_masked` - Reveals masked text character by character

fated-0.2.1/fate/__init__.py

@@ -0,0 +1,77 @@
+"""
+fate - A Python library for adding visual effects to text output
+
+This library provides various text effects including typewriter animation,
+colorization, styling, and more for enhancing terminal output.
+
+Basic usage:
+    from fate import typewriter, color, style
+    
+    # Simple typewriter effect
+    print(typewriter("Hello, World!"))
+    
+    # Chained effects
+    print(color.red(typewriter("Error message", speed=5)))
+    
+    # Mix and match
+    print(style.bold(color.blue(typewriter("Important notification"))))
+    
+Alternative shortcut syntax:
+    from fate.shortcuts import fateTypeWriter, fateRed, fateBold
+    
+    # Using the + operator
+    print(fateTypeWriter + "Hello, World!")
+    
+    # Combining shortcuts
+    print(fateBold + fateRed + "Important error message")
+    
+    # With custom parameters
+    print(fateTypeWriter(speed=20) + "Fast typing!")
+"""
+
+__version__ = "0.2.1"
+
+from fate.effects import (
+    typewriter, 
+    blink, 
+    fade_in,
+    wave,
+    glitch,
+    shake,
+    rainbow
+)
+
+from fate.styles import (
+    color,
+    style,
+    bg_color
+)
+
+# Predefined effect combinations
+error = lambda text: style.bold(color.red(text))
+warning = lambda text: style.bold(color.yellow(text))
+success = lambda text: style.bold(color.green(text))
+info = lambda text: style.bold(color.blue(text))
+
+# Advanced animations
+from fate.animation import (
+    typing_with_errors,
+    matrix_effect,
+    slide_in,
+    reveal_masked
+)
+
+# Make FateString available for type hints and advanced usage
+from fate.utils import FateString
+
+# Import shortcuts
+# The shortcuts are not imported by default to avoid namespace pollution,
+# but they can be imported explicitly from fate.shortcuts
+
+__all__ = [
+    'typewriter', 'blink', 'fade_in', 'wave', 'glitch', 'shake', 'rainbow',
+    'color', 'style', 'bg_color',
+    'error', 'warning', 'success', 'info',
+    'typing_with_errors', 'matrix_effect', 'slide_in', 'reveal_masked',
+    'FateString'
+]

fated-0.2.1/fate/__init__.py.bak

@@ -0,0 +1,77 @@
+"""
+fate - A Python library for adding visual effects to text output
+
+This library provides various text effects including typewriter animation,
+colorization, styling, and more for enhancing terminal output.
+
+Basic usage:
+    from fate import typewriter, color, style
+    
+    # Simple typewriter effect
+    print(typewriter("Hello, World!"))
+    
+    # Chained effects
+    print(color.red(typewriter("Error message", speed=5)))
+    
+    # Mix and match
+    print(style.bold(color.blue(typewriter("Important notification"))))
+    
+Alternative shortcut syntax:
+    from fate.shortcuts import fateTypeWriter, fateRed, fateBold
+    
+    # Using the + operator
+    print(fateTypeWriter + "Hello, World!")
+    
+    # Combining shortcuts
+    print(fateBold + fateRed + "Important error message")
+    
+    # With custom parameters
+    print(fateTypeWriter(speed=20) + "Fast typing!")
+"""
+
+__version__ = "0.2.0"
+
+from fate.effects import (
+    typewriter, 
+    blink, 
+    fade_in,
+    wave,
+    glitch,
+    shake,
+    rainbow
+)
+
+from fate.styles import (
+    color,
+    style,
+    bg_color
+)
+
+# Predefined effect combinations
+error = lambda text: style.bold(color.red(text))
+warning = lambda text: style.bold(color.yellow(text))
+success = lambda text: style.bold(color.green(text))
+info = lambda text: style.bold(color.blue(text))
+
+# Advanced animations
+from fate.animation import (
+    typing_with_errors,
+    matrix_effect,
+    slide_in,
+    reveal_masked
+)
+
+# Make FateString available for type hints and advanced usage
+from fate.utils import FateString
+
+# Import shortcuts
+# The shortcuts are not imported by default to avoid namespace pollution,
+# but they can be imported explicitly from fate.shortcuts
+
+__all__ = [
+    'typewriter', 'blink', 'fade_in', 'wave', 'glitch', 'shake', 'rainbow',
+    'color', 'style', 'bg_color',
+    'error', 'warning', 'success', 'info',
+    'typing_with_errors', 'matrix_effect', 'slide_in', 'reveal_masked',
+    'FateString'
+]

fated-0.2.1/fate/animation.py

@@ -0,0 +1,209 @@
+"""
+Advanced animation utilities for the fate library.
+"""
+
+import sys
+import time
+import random
+from typing import List, Callable, Optional, Union
+
+from fate.utils import create_effect
+
+@create_effect
+def typing_with_errors(text: str, error_rate: float = 0.1, backspace_delay: float = 0.1, 
+                       typing_speed: int = 10) -> str:
+    """
+    Realistic typing animation that includes random errors and backspacing.
+    
+    Args:
+        text: Text to be displayed
+        error_rate: Probability of making a typo (0-1)
+        backspace_delay: Delay between backspace operations
+        typing_speed: Characters per second
+    
+    Returns:
+        The text after animation
+    """
+    delay = 1.0 / typing_speed
+    
+    # Possible typo characters (neighbors on QWERTY keyboard)
+    keyboard_map = {
+        'a': 'qwsz', 'b': 'vghn', 'c': 'xdfv', 'd': 'serfcx', 'e': 'wsdr',
+        'f': 'drtgvc', 'g': 'ftyhbv', 'h': 'gyujnb', 'i': 'ujko', 'j': 'huikmn',
+        'k': 'jiolm', 'l': 'kop;', 'm': 'njk,', 'n': 'bhjm', 'o': 'iklp',
+        'p': 'ol;[', 'q': 'wa', 'r': 'edft', 's': 'awedxz', 't': 'rfgy',
+        'u': 'yhji', 'v': 'cfgb', 'w': 'qase', 'x': 'zsdc', 'y': 'tghu',
+        'z': 'asx'
+    }
+    
+    current = ""
+    errors = 0
+    
+    try:
+        for i, char in enumerate(text):
+            # Randomly decide whether to make a typo
+            if random.random() < error_rate and char.lower() in keyboard_map:
+                # Choose a typo character from nearby keys
+                typo_char = random.choice(keyboard_map.get(char.lower(), char))
+                if char.isupper():
+                    typo_char = typo_char.upper()
+                
+                current += typo_char
+                sys.stdout.write('\r' + current)
+                sys.stdout.flush()
+                time.sleep(delay)
+                
+                # Backspace the typo
+                current = current[:-1]
+                sys.stdout.write('\r' + current + ' ')
+                sys.stdout.flush()
+                time.sleep(backspace_delay)
+                
+                # Continue with the correct character
+                current += char
+            else:
+                current += char
+            
+            sys.stdout.write('\r' + current)
+            sys.stdout.flush()
+            time.sleep(delay)
+        
+        sys.stdout.write('\n')
+        return text
+    except KeyboardInterrupt:
+        sys.stdout.write('\r' + text + '\n')
+        return text
+
+
+@create_effect
+def matrix_effect(text: str, speed: int = 5, char_set: Optional[str] = None) -> str:
+    """
+    Creates a matrix-like effect where characters fall into place.
+    
+    Args:
+        text: Text to display
+        speed: Animation speed
+        char_set: Optional set of characters to use for the effect
+    
+    Returns:
+        The text after animation
+    """
+    if char_set is None:
+        char_set = "01"
+    
+    delay = 1.0 / speed
+    width = len(text)
+    
+    # Create random initial positions for each character
+    positions = [random.randint(0, 5) for _ in range(width)]
+    max_height = max(positions) + 1
+    
+    try:
+        # Animate characters falling into place
+        for step in range(max_height + len(text)):
+            result = ""
+            
+            for i in range(width):
+                char_pos = step - positions[i]
+                
+                if char_pos < 0:
+                    # Character hasn't started falling yet
+                    result += " "
+                elif char_pos < 5:
+                    # Character is falling, show a random matrix character
+                    result += random.choice(char_set)
+                else:
+                    # Character has reached its position, show the actual character
+                    result += text[i]
+            
+            sys.stdout.write('\r' + result)
+            sys.stdout.flush()
+            time.sleep(delay)
+        
+        sys.stdout.write('\n')
+        return text
+    except KeyboardInterrupt:
+        sys.stdout.write('\r' + text + '\n')
+        return text
+
+
+@create_effect
+def slide_in(text: str, direction: str = "left", speed: int = 10) -> str:
+    """
+    Slides text into view from a specified direction.
+    
+    Args:
+        text: Text to display
+        direction: Direction to slide from ("left", "right")
+        speed: Animation speed
+    
+    Returns:
+        The text after animation
+    """
+    delay = 1.0 / speed
+    width = len(text)
+    
+    try:
+        if direction.lower() == "left":
+            # Slide in from left
+            for i in range(width + 1):
+                result = text[:i]
+                sys.stdout.write('\r' + result)
+                sys.stdout.flush()
+                time.sleep(delay)
+        else:
+            # Slide in from right
+            for i in range(width + 1):
+                result = " " * (width - i) + text[:i]
+                sys.stdout.write('\r' + result)
+                sys.stdout.flush()
+                time.sleep(delay)
+        
+        sys.stdout.write('\n')
+        return text
+    except KeyboardInterrupt:
+        sys.stdout.write('\r' + text + '\n')
+        return text
+
+
+@create_effect
+def reveal_masked(text: str, mask_char: str = "*", speed: int = 5) -> str:
+    """
+    Reveals text by replacing mask characters one by one.
+    
+    Args:
+        text: Text to reveal
+        mask_char: Character used for masking
+        speed: Characters per second to reveal
+    
+    Returns:
+        The text after animation
+    """
+    delay = 1.0 / speed
+    width = len(text)
+    
+    try:
+        # Start with all characters masked
+        current = mask_char * width
+        revealed = [False] * width
+        
+        # Reveal characters one by one in random order
+        indices = list(range(width))
+        random.shuffle(indices)
+        
+        for idx in indices:
+            # Update the current text
+            current_list = list(current)
+            current_list[idx] = text[idx]
+            current = ''.join(current_list)
+            
+            # Display
+            sys.stdout.write('\r' + current)
+            sys.stdout.flush()
+            time.sleep(delay)
+        
+        sys.stdout.write('\n')
+        return text
+    except KeyboardInterrupt:
+        sys.stdout.write('\r' + text + '\n')
+        return text