Metadata-Version: 2.4
Name: typeglide
Version: 0.4.4
Summary: A typewriter text effect library for Python with tkinter and Android/Pydroid support. Made by Daksh Sharma who is easily known as Dakshu. Features: write, erase, save, animate_widget, erase_widget, type_and_erase, easter_play. Youtube :- https://youtube.com/@typeglide?si=hPYynPIiXVdLKKKT
Author-email: Dakshu <dakshumail98@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11.14
Description-Content-Type: text/markdown

# typeglide

A typewriter text effect library for Python. Works with tkinter and Android/Pydroid too!

This library is made by Daksh Sharma who is easily known as Dakshu.

## Installation
```bash
pip install typeglide
```

---

## Functions

### `typeglide.write(text, delay, end)`
Prints text to the terminal character by character.
```python
import typeglide
typeglide.write("Hello World", delay=0.05)
```

---

### `typeglide.erase(text, delay)`
Erases text character by character using backspaces.
```python
import typeglide
typeglide.write("Hello!", delay=0.05, end="")
typeglide.erase("Hello!", delay=0.05)
```

---

## Easter Egg Guide

`typeglide.easter_play(code)` plays a Typeglide Independence Day 80 easter
egg. The exact code must be provided. When it is valid, Typeglide types the
viewing reminder at `0.01` seconds per character and opens the included video
in your computer's default video player. On Android/Pydroid, it opens the
video with Android's default video-player chooser. The video is copied to
Android's shared `Download` folder so the selected player can read it.

```python
import typeglide

typeglide.easter_play(code="INDIPENDENCE80")
```

Please look at output gui with hearable volume, don't look in the output look
at gui output. The video requires a desktop or Android environment with an
installed video player.

### Easter egg codes

| Code | Result |
| --- | --- |
| `INDIPENDENCE80` | Types the viewing reminder and opens the Independence Day 80 video |

If the code is invalid, Typeglide only types `Invalid easter egg code.` in the
terminal and finishes. It does not open a video player or any other GUI.

---

### `typeglide.save(text, delay, end)`
Saves text and settings into a reusable `Glide` object.
```python
import typeglide
glide = typeglide.save("Hello World", delay=0.05)
```

---

## Glide Object Methods

### `print(glide)` — animate in terminal
```python
import typeglide
glide = typeglide.save("Hello World", delay=0.05)
print(glide)
```

### `glide.erase()` — erase from terminal
```python
glide.erase()
```

### `glide.type_and_erase(pause)` — type then erase
```python
glide.type_and_erase(pause=1)  # types it out, waits 1s, then erases it
```

### `glide.animate_widget(widget)` — animate into a tkinter widget
```python
glide.animate_widget(label)
glide.animate_widget(button)
```

### `glide.erase_widget(widget)` — erase from a tkinter widget
```python
glide.erase_widget(label)
```

### `glide.text` — get the raw text (for static use)
```python
button.config(text=glide.text)
```

---

## How to use it?

### Simple terminal example:
```python
import typeglide

glide = typeglide.save("Hello World", delay=0.05)  # Save The Text
print(glide)  # Print The Animated text
```

### Tkinter example 🐱
```python
import typeglide
import tkinter as tk

glide = typeglide.save("Hello World", delay=0.05)

def do():
    glide.animate_widget(label)

root = tk.Tk()
label = tk.Label(text="hi")
label.pack()
button = tk.Button(text="press", command=do)
button.pack()
root.mainloop()
```
# For support

Youtube :- https://youtube.com/@typeglide?si=hPYynPIiXVdLKKKT

# Github Username

Github username is: DakshuOnHair
github link: https://github.com/DakshuOnHair/Typeglide