Metadata-Version: 2.4
Name: animate-sh
Version: 0.1.0
Summary: A Python library for printing animated ASCII art
Project-URL: Homepage, https://github.com/anistark/animate
Project-URL: Repository, https://github.com/anistark/animate.git
Project-URL: Issues, https://github.com/anistark/animate/issues
Project-URL: Documentation, https://github.com/anistark/animate#readme
Author-email: Kumar Anirudha <oss@anirudha.dev>
License: MIT
License-File: LICENSE
Keywords: animation,ascii,terminal
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia
Classifier: Topic :: Terminals
Requires-Python: >=3.12
Provides-Extra: color
Requires-Dist: colorama>=0.4.6; extra == 'color'
Provides-Extra: dev
Requires-Dist: black>=24.10.0; extra == 'dev'
Requires-Dist: mypy>=1.11.0; extra == 'dev'
Requires-Dist: pre-commit>=4.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.7.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx>=8.0.0; extra == 'docs'
Description-Content-Type: text/markdown

# Animate

A Python library for printing animated ASCII art in the terminal.

## Features

- Simple and intuitive API
- Support for custom animations
- Configurable playback options (loop, timeout, FPS)
- Terminal-friendly and cross-platform

## Installation

Using pip:

```sh
pip install animate-sh
```

Using uv:

```sh
uv add animate-sh
```

With color support:

```sh
# pip
pip install animate-sh[color]

# uv
uv add animate-sh[color]
```

## Quick Start

```python
from animate import play
from animate.animations import Spinner

# Play a spinner animation
play(Spinner(), loop=True, timeout=10)
```

## Development

This project uses [just](https://github.com/casey/just) for task automation.

```sh
# Install dependencies
just install

# Run all checks (format, lint, type-check, test)
just check

# Individual commands
just test              # Run tests
just format            # Format code
just lint              # Lint code
just lint-fix          # Fix linting issues
just type-check        # Type check
just examples          # Run example scripts
just build             # Build distribution
just clean             # Clean build artifacts
```

## License

[MIT License](./LICENSE)
