animpy 1.0.0__tar.gz

animpy-1.0.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: animpy
+Version: 1.0.0
+Summary: A simple terminal animation library
+Author: yourname
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+Animpy is a simple animation library for creating cool terminal animations. It gives you everything you need to make text-based animations with colors, movement, and frame-by-frame control. Perfect for CLI projects, games, or just having fun in the terminal!
+
+![particlesim.py](particlesim.gif)
+
+The particle simulator shown above was made entirely with Animpy.
+
+## What Can You Do?
+
+- **Add colors and styling** to your terminal text (16 colors, bright versions, backgrounds, bold, underline, etc.)
+- **Move text around** the screen wherever you want
+- **Create frame-by-frame animations** with multiple text frames that you can cycle through
+- **Build complex scenes** with multiple text elements rendered together
+- **Control animations** smoothly and precisely
+
+## Installation
+
+Copy the `animpy` folder to your project directory and import it:
+
+```python
+import animpy
+```
+
+## Quick Start
+
+Here's a simple example to get you started:
+
+```python
+import animpy
+
+# Create a new scene
+scene = animpy.Scene()
+
+# Create some text at position (10, 5)
+hello = animpy.Text("Hello, World!", 10, 5)
+
+# Add it to the scene
+scene.add(hello)
+
+# Render it to the screen
+scene.render()
+```
+
+## Complete Guide
+
+### `addFrame()`
+
+This is the simplest way to clear the terminal screen. It returns an ANSI code that clears everything and moves the cursor back to the top-left corner. Great if you're building your own animation loop.
+
+```python
+print(animpy.addFrame())  # Clears the screen
+```
+
+### Colors and Styling with `ANSI`
+
+The `ANSI` dictionary has everything you need for styling text. Just add the code before your text and use `'reset'` to go back to normal.
+
+**Available colors:**
+- **Regular**: black, red, green, yellow, blue, magenta, cyan, white
+- **Bright**: bright_black, bright_red, bright_green, bright_yellow, bright_blue, bright_magenta, bright_cyan, bright_white
+- **Backgrounds**: bg_black, bg_red, bg_green, bg_yellow, bg_blue, bg_magenta, bg_cyan, bg_white
+- **Bright backgrounds**: bg_bright_black, bg_bright_red, bg_bright_green, bg_bright_yellow, bg_bright_blue, bg_bright_magenta, bg_bright_cyan, bg_bright_white
+- **Text styles**: bold, dim, italic, underline, blink, reverse, hidden, strikethrough
+
+**Example:**
+```python
+import animpy
+
+# Simple color example
+text = animpy.ANSI['red'] + 'Error!' + animpy.ANSI['reset']
+print(text)
+
+# Combining styles
+fancy = animpy.ANSI['bold'] + animpy.ANSI['bright_blue'] + 'AWESOME' + animpy.ANSI['reset']
+print(fancy)
+```
+
+### The `Text` Class
+
+This is where the animation magic happens. `Text` objects represent text that you can position and animate.
+
+**Creating text:**
+```python
+# Simple static text at position (x=10, y=5)
+text = animpy.Text("Hello", 10, 5)
+
+# Or create animation frames with a list of strings
+animation = animpy.Text(["Frame 1", "Frame 2", "Frame 3"], 10, 5)
+```
+
+**Methods:**
+
+- **`moveX(newX)`** – Move the text to a new X position
+  ```python
+  text.moveX(20)  # Move to x=20
+  ```
+
+- **`moveY(newY)`** – Move the text to a new Y position
+  ```python
+  text.moveY(10)  # Move to y=10
+  ```
+
+- **`change_frame()`** – Go to the next frame in a frame-by-frame animation (only works if you created it with a list)
+  ```python
+  animation.change_frame()  # Switch to the next frame
+  ```
+
+### The `Scene` Class
+
+A scene holds all your text elements and renders them to the screen at once.
+
+**Creating and using:**
+```python
+scene = animpy.Scene()
+
+# Add multiple text objects
+text1 = animpy.Text("First", 5, 2)
+text2 = animpy.Text("Second", 10, 5)
+
+scene.add(text1, text2)
+
+# Render everything to the screen
+scene.render()
+```
+
+**Methods:**
+
+- **`add(*items)`** – Add one or more Text objects to the scene
+  ```python
+  scene.add(text1, text2, text3)  # Add multiple at once
+  ```
+
+- **`render()`** – Draw all text objects to the screen in their current positions
+  ```python
+  scene.render()  # Shows everything on screen
+  ```
+
+## Full Animation Example
+
+Here's a complete example showing how to create a simple animation:
+
+```python
+import animpy
+import time
+
+# Create a scene
+scene = animpy.Scene()
+
+# Create animated text (multiple frames)
+frames = ["Moving...", "  Moving...", "    Moving...", "      Moving..."]
+moving_text = animpy.Text(frames, 1, 5)
+
+# Create a title that stays still
+title = animpy.Text(animpy.ANSI['bold'] + animpy.ANSI['cyan'] + "Animation Demo" + animpy.ANSI['reset'], 5, 1)
+
+# Add both to the scene
+scene.add(title, moving_text)
+
+# Animation loop
+for i in range(20):
+    scene.render()
+    moving_text.change_frame()  # Next frame
+    time.sleep(0.2)  # Wait 200ms
+```
+
+## License
+
+See LICENSE for details.

animpy-1.0.0/README.md

@@ -0,0 +1,167 @@
+Animpy is a simple animation library for creating cool terminal animations. It gives you everything you need to make text-based animations with colors, movement, and frame-by-frame control. Perfect for CLI projects, games, or just having fun in the terminal!
+
+![particlesim.py](particlesim.gif)
+
+The particle simulator shown above was made entirely with Animpy.
+
+## What Can You Do?
+
+- **Add colors and styling** to your terminal text (16 colors, bright versions, backgrounds, bold, underline, etc.)
+- **Move text around** the screen wherever you want
+- **Create frame-by-frame animations** with multiple text frames that you can cycle through
+- **Build complex scenes** with multiple text elements rendered together
+- **Control animations** smoothly and precisely
+
+## Installation
+
+Copy the `animpy` folder to your project directory and import it:
+
+```python
+import animpy
+```
+
+## Quick Start
+
+Here's a simple example to get you started:
+
+```python
+import animpy
+
+# Create a new scene
+scene = animpy.Scene()
+
+# Create some text at position (10, 5)
+hello = animpy.Text("Hello, World!", 10, 5)
+
+# Add it to the scene
+scene.add(hello)
+
+# Render it to the screen
+scene.render()
+```
+
+## Complete Guide
+
+### `addFrame()`
+
+This is the simplest way to clear the terminal screen. It returns an ANSI code that clears everything and moves the cursor back to the top-left corner. Great if you're building your own animation loop.
+
+```python
+print(animpy.addFrame())  # Clears the screen
+```
+
+### Colors and Styling with `ANSI`
+
+The `ANSI` dictionary has everything you need for styling text. Just add the code before your text and use `'reset'` to go back to normal.
+
+**Available colors:**
+- **Regular**: black, red, green, yellow, blue, magenta, cyan, white
+- **Bright**: bright_black, bright_red, bright_green, bright_yellow, bright_blue, bright_magenta, bright_cyan, bright_white
+- **Backgrounds**: bg_black, bg_red, bg_green, bg_yellow, bg_blue, bg_magenta, bg_cyan, bg_white
+- **Bright backgrounds**: bg_bright_black, bg_bright_red, bg_bright_green, bg_bright_yellow, bg_bright_blue, bg_bright_magenta, bg_bright_cyan, bg_bright_white
+- **Text styles**: bold, dim, italic, underline, blink, reverse, hidden, strikethrough
+
+**Example:**
+```python
+import animpy
+
+# Simple color example
+text = animpy.ANSI['red'] + 'Error!' + animpy.ANSI['reset']
+print(text)
+
+# Combining styles
+fancy = animpy.ANSI['bold'] + animpy.ANSI['bright_blue'] + 'AWESOME' + animpy.ANSI['reset']
+print(fancy)
+```
+
+### The `Text` Class
+
+This is where the animation magic happens. `Text` objects represent text that you can position and animate.
+
+**Creating text:**
+```python
+# Simple static text at position (x=10, y=5)
+text = animpy.Text("Hello", 10, 5)
+
+# Or create animation frames with a list of strings
+animation = animpy.Text(["Frame 1", "Frame 2", "Frame 3"], 10, 5)
+```
+
+**Methods:**
+
+- **`moveX(newX)`** – Move the text to a new X position
+  ```python
+  text.moveX(20)  # Move to x=20
+  ```
+
+- **`moveY(newY)`** – Move the text to a new Y position
+  ```python
+  text.moveY(10)  # Move to y=10
+  ```
+
+- **`change_frame()`** – Go to the next frame in a frame-by-frame animation (only works if you created it with a list)
+  ```python
+  animation.change_frame()  # Switch to the next frame
+  ```
+
+### The `Scene` Class
+
+A scene holds all your text elements and renders them to the screen at once.
+
+**Creating and using:**
+```python
+scene = animpy.Scene()
+
+# Add multiple text objects
+text1 = animpy.Text("First", 5, 2)
+text2 = animpy.Text("Second", 10, 5)
+
+scene.add(text1, text2)
+
+# Render everything to the screen
+scene.render()
+```
+
+**Methods:**
+
+- **`add(*items)`** – Add one or more Text objects to the scene
+  ```python
+  scene.add(text1, text2, text3)  # Add multiple at once
+  ```
+
+- **`render()`** – Draw all text objects to the screen in their current positions
+  ```python
+  scene.render()  # Shows everything on screen
+  ```
+
+## Full Animation Example
+
+Here's a complete example showing how to create a simple animation:
+
+```python
+import animpy
+import time
+
+# Create a scene
+scene = animpy.Scene()
+
+# Create animated text (multiple frames)
+frames = ["Moving...", "  Moving...", "    Moving...", "      Moving..."]
+moving_text = animpy.Text(frames, 1, 5)
+
+# Create a title that stays still
+title = animpy.Text(animpy.ANSI['bold'] + animpy.ANSI['cyan'] + "Animation Demo" + animpy.ANSI['reset'], 5, 1)
+
+# Add both to the scene
+scene.add(title, moving_text)
+
+# Animation loop
+for i in range(20):
+    scene.render()
+    moving_text.change_frame()  # Next frame
+    time.sleep(0.2)  # Wait 200ms
+```
+
+## License
+
+See LICENSE for details.

animpy-1.0.0/animpy.egg-info/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: animpy
+Version: 1.0.0
+Summary: A simple terminal animation library
+Author: yourname
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+Animpy is a simple animation library for creating cool terminal animations. It gives you everything you need to make text-based animations with colors, movement, and frame-by-frame control. Perfect for CLI projects, games, or just having fun in the terminal!
+
+![particlesim.py](particlesim.gif)
+
+The particle simulator shown above was made entirely with Animpy.
+
+## What Can You Do?
+
+- **Add colors and styling** to your terminal text (16 colors, bright versions, backgrounds, bold, underline, etc.)
+- **Move text around** the screen wherever you want
+- **Create frame-by-frame animations** with multiple text frames that you can cycle through
+- **Build complex scenes** with multiple text elements rendered together
+- **Control animations** smoothly and precisely
+
+## Installation
+
+Copy the `animpy` folder to your project directory and import it:
+
+```python
+import animpy
+```
+
+## Quick Start
+
+Here's a simple example to get you started:
+
+```python
+import animpy
+
+# Create a new scene
+scene = animpy.Scene()
+
+# Create some text at position (10, 5)
+hello = animpy.Text("Hello, World!", 10, 5)
+
+# Add it to the scene
+scene.add(hello)
+
+# Render it to the screen
+scene.render()
+```
+
+## Complete Guide
+
+### `addFrame()`
+
+This is the simplest way to clear the terminal screen. It returns an ANSI code that clears everything and moves the cursor back to the top-left corner. Great if you're building your own animation loop.
+
+```python
+print(animpy.addFrame())  # Clears the screen
+```
+
+### Colors and Styling with `ANSI`
+
+The `ANSI` dictionary has everything you need for styling text. Just add the code before your text and use `'reset'` to go back to normal.
+
+**Available colors:**
+- **Regular**: black, red, green, yellow, blue, magenta, cyan, white
+- **Bright**: bright_black, bright_red, bright_green, bright_yellow, bright_blue, bright_magenta, bright_cyan, bright_white
+- **Backgrounds**: bg_black, bg_red, bg_green, bg_yellow, bg_blue, bg_magenta, bg_cyan, bg_white
+- **Bright backgrounds**: bg_bright_black, bg_bright_red, bg_bright_green, bg_bright_yellow, bg_bright_blue, bg_bright_magenta, bg_bright_cyan, bg_bright_white
+- **Text styles**: bold, dim, italic, underline, blink, reverse, hidden, strikethrough
+
+**Example:**
+```python
+import animpy
+
+# Simple color example
+text = animpy.ANSI['red'] + 'Error!' + animpy.ANSI['reset']
+print(text)
+
+# Combining styles
+fancy = animpy.ANSI['bold'] + animpy.ANSI['bright_blue'] + 'AWESOME' + animpy.ANSI['reset']
+print(fancy)
+```
+
+### The `Text` Class
+
+This is where the animation magic happens. `Text` objects represent text that you can position and animate.
+
+**Creating text:**
+```python
+# Simple static text at position (x=10, y=5)
+text = animpy.Text("Hello", 10, 5)
+
+# Or create animation frames with a list of strings
+animation = animpy.Text(["Frame 1", "Frame 2", "Frame 3"], 10, 5)
+```
+
+**Methods:**
+
+- **`moveX(newX)`** – Move the text to a new X position
+  ```python
+  text.moveX(20)  # Move to x=20
+  ```
+
+- **`moveY(newY)`** – Move the text to a new Y position
+  ```python
+  text.moveY(10)  # Move to y=10
+  ```
+
+- **`change_frame()`** – Go to the next frame in a frame-by-frame animation (only works if you created it with a list)
+  ```python
+  animation.change_frame()  # Switch to the next frame
+  ```
+
+### The `Scene` Class
+
+A scene holds all your text elements and renders them to the screen at once.
+
+**Creating and using:**
+```python
+scene = animpy.Scene()
+
+# Add multiple text objects
+text1 = animpy.Text("First", 5, 2)
+text2 = animpy.Text("Second", 10, 5)
+
+scene.add(text1, text2)
+
+# Render everything to the screen
+scene.render()
+```
+
+**Methods:**
+
+- **`add(*items)`** – Add one or more Text objects to the scene
+  ```python
+  scene.add(text1, text2, text3)  # Add multiple at once
+  ```
+
+- **`render()`** – Draw all text objects to the screen in their current positions
+  ```python
+  scene.render()  # Shows everything on screen
+  ```
+
+## Full Animation Example
+
+Here's a complete example showing how to create a simple animation:
+
+```python
+import animpy
+import time
+
+# Create a scene
+scene = animpy.Scene()
+
+# Create animated text (multiple frames)
+frames = ["Moving...", "  Moving...", "    Moving...", "      Moving..."]
+moving_text = animpy.Text(frames, 1, 5)
+
+# Create a title that stays still
+title = animpy.Text(animpy.ANSI['bold'] + animpy.ANSI['cyan'] + "Animation Demo" + animpy.ANSI['reset'], 5, 1)
+
+# Add both to the scene
+scene.add(title, moving_text)
+
+# Animation loop
+for i in range(20):
+    scene.render()
+    moving_text.change_frame()  # Next frame
+    time.sleep(0.2)  # Wait 200ms
+```
+
+## License
+
+See LICENSE for details.

animpy-1.0.0/animpy.egg-info/SOURCES.txt

@@ -0,0 +1,7 @@
+README.md
+animpy.py
+pyproject.toml
+animpy.egg-info/PKG-INFO
+animpy.egg-info/SOURCES.txt
+animpy.egg-info/dependency_links.txt
+animpy.egg-info/top_level.txt

animpy-1.0.0/animpy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

animpy-1.0.0/animpy.egg-info/top_level.txt

@@ -0,0 +1 @@
+animpy

animpy-1.0.0/animpy.py

@@ -0,0 +1,105 @@
+import os, sys, time, atexit
+
+sys.stdout.write("\033[?25l")
+atexit.register(lambda: (sys.stdout.write("\033[?25h"), sys.stdout.flush()))
+
+def addFrame():
+    return "\033[2J\033[H"
+
+ANSI = {
+    # Reset
+    "reset": "\033[0m",
+
+    # Regular colors
+    "black": "\033[30m",
+    "red": "\033[31m",
+    "green": "\033[32m",
+    "yellow": "\033[33m",
+    "blue": "\033[34m",
+    "magenta": "\033[35m",
+    "cyan": "\033[36m",
+    "white": "\033[37m",
+
+    # Bright colors
+    "bright_black": "\033[90m",
+    "bright_red": "\033[91m",
+    "bright_green": "\033[92m",
+    "bright_yellow": "\033[93m",
+    "bright_blue": "\033[94m",
+    "bright_magenta": "\033[95m",
+    "bright_cyan": "\033[96m",
+    "bright_white": "\033[97m",
+
+    # Backgrounds
+    "bg_black": "\033[40m",
+    "bg_red": "\033[41m",
+    "bg_green": "\033[42m",
+    "bg_yellow": "\033[43m",
+    "bg_blue": "\033[44m",
+    "bg_magenta": "\033[45m",
+    "bg_cyan": "\033[46m",
+    "bg_white": "\033[47m",
+
+    # Bright backgrounds
+    "bg_bright_black": "\033[100m",
+    "bg_bright_red": "\033[101m",
+    "bg_bright_green": "\033[102m",
+    "bg_bright_yellow": "\033[103m",
+    "bg_bright_blue": "\033[104m",
+    "bg_bright_magenta": "\033[105m",
+    "bg_bright_cyan": "\033[106m",
+    "bg_bright_white": "\033[107m",
+
+    # Styles
+    "bold": "\033[1m",
+    "dim": "\033[2m",
+    "italic": "\033[3m",
+    "underline": "\033[4m",
+    "blink": "\033[5m",
+    "reverse": "\033[7m",
+    "hidden": "\033[8m",
+    "strikethrough": "\033[9m",
+}
+
+sys.stdout.write("\033[?25l")
+atexit.register(lambda: (sys.stdout.write("\033[?25h"), sys.stdout.flush()))
+
+class Text:
+    def __init__(self, text: str | list[str], x: int, y: int) -> None:
+        self.x = x
+        self.y = y
+
+        if isinstance(text, list):
+            self.text_list = text      # store the list
+            self.current_frame = 0
+            self.text = text[0]        # current visible text
+        else:
+            self.text_list = None
+            self.text = text
+
+    def moveX(self, newX: int) -> None:
+        self.x = newX
+
+    def moveY(self, newY: int) -> None:
+        self.y = newY
+
+    def change_frame(self) -> None:
+        if self.text_list:
+            self.current_frame = (self.current_frame + 1) % len(self.text_list)
+            self.text = self.text_list[self.current_frame]
+
+class Scene:
+    def __init__(self) -> None:
+        self.items = []
+
+    def add(self, *items: Text) -> None:
+        for item in items:
+            self.items.append(item)
+
+    def render(self):
+        buf = []
+        buf.append("\033[2J\033[H")
+        for item in self.items:
+            buf.append(f"\033[{item.y + 1};{item.x + 1}H{item.text}")
+        sys.stdout.write("".join(buf))
+        sys.stdout.flush()

animpy-1.0.0/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "animpy"
+version = "1.0.0"
+description = "A simple terminal animation library"
+authors = [
+  {name = "yourname"}
+]
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE"}
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

animpy-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+