typeglide 0.3.0__tar.gz → 0.3.2__tar.gz

{typeglide-0.3.0 → typeglide-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: typeglide
-Version: 0.3.0
+Version: 0.3.2
 Summary: A smooth typewriter printing library that is made by dakshu.
 Author-email: Dakshu <dakshumail98@gmail.com>
 License-File: LICENSE

{typeglide-0.3.0 → typeglide-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "typeglide"
-version = "0.3.0"
+version = "0.3.2"
 description = "A smooth typewriter printing library that is made by dakshu."
 readme = "README.md"
 requires-python = ">=3.11.14"

typeglide-0.3.2/typeglide/__init__.py

@@ -0,0 +1,3 @@
+from .engine import write, save, Glide
+
+__version__ = "0.3.2"

typeglide-0.3.2/typeglide/engine.py

@@ -0,0 +1,83 @@
+import sys
+import time
+
+
+def write(text, delay=0.05, end="\n"):
+    """
+    Prints text to the console character by character.
+
+    :param text: The string to print.
+    :param delay: Time in seconds between each character.
+    :param end: The character to print at the very end (defaults to newline).
+    """
+    for char in text:
+        sys.stdout.write(char)
+        sys.stdout.flush()
+        time.sleep(delay)
+    sys.stdout.write(end)
+    sys.stdout.flush()
+
+
+class Glide:
+    """
+    A saveable typewriter-effect object.
+
+    Usage:
+        glide = typeglide.save("Hello", delay=0.05)
+
+        # Terminal — animates character by character:
+        print(glide)
+
+        # Tkinter static text:
+        button.config(text=glide.text)
+
+        # Tkinter animated text:
+        glide.animate_widget(button)
+    """
+
+    def __init__(self, text, delay=0.05, end="\n"):
+        self.text = text
+        self.delay = delay
+        self.end = end
+
+    def __str__(self):
+        for char in self.text:
+            sys.stdout.write(char)
+            sys.stdout.flush()
+            time.sleep(self.delay)
+        return ""
+
+    def __repr__(self):
+        return f"Glide({self.text!r}, delay={self.delay})"
+
+    def animate_widget(self, widget, attr="text"):
+        """
+        Animate the text into a tkinter widget one character at a time.
+
+        :param widget: Any tkinter widget that supports .config().
+        :param attr:   The config attribute to update (default 'text').
+
+        Example:
+            glide.animate_widget(button)
+            glide.animate_widget(label)
+        """
+        delay_ms = int(self.delay * 1000)
+
+        def _step(index):
+            widget.config(**{attr: self.text[:index]})
+            if index < len(self.text):
+                widget.after(delay_ms, _step, index + 1)
+
+        _step(0)
+
+
+def save(text, delay=0.05, end="\n"):
+    """
+    Save a typewriter-effect string for later use.
+
+    :param text:  The string to animate.
+    :param delay: Time in seconds between each character.
+    :param end:   End character used when printing (defaults to newline).
+    :returns:     A Glide object.
+    """
+    return Glide(text, delay=delay, end=end)

typeglide-0.3.0/pytypewriter/__init__.py

@@ -1,3 +0,0 @@
-from .engine import write
-
-__version__ = "0.1.0"

typeglide-0.3.0/pytypewriter/engine.py

@@ -1,18 +0,0 @@
-import sys
-import time
-
-def write(text, delay=0.05, end="\n"):
-    """
-    Prints text to the console character by character.
-    
-    :param text: The string to print.
-    :param delay: Time in seconds between each character.
-    :param end: The character to print at the very end (defaults to newline).
-    """
-    for char in text:
-        sys.stdout.write(char)
-        sys.stdout.flush()
-        time.sleep(delay)
-    sys.stdout.write(end)
-    sys.stdout.flush()
-