asciiquarium

Name	asciiquarium JSON
Version	2.0.1 JSON
	download
home_page	None
Summary	An aquarium/sea animation in ASCII art for your terminal
upload_time	2025-10-06 20:47:21
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	None
keywords	terminal ascii animation aquarium cli
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <div align="center">

# 🐠 Asciiquarium - Python Edition

<div align="center">
  <a href="https://github.com/MKAbuMattar/asciiquarium-python" target="_blank" rel="noreferrer">
    <img src="https://img.shields.io/badge/github-%23181717.svg?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Repository"/>
  </a>

  <a href="https://github.com/MKAbuMattar/asciiquarium-python/releases" target="_blank" rel="noreferrer">
    <img alt="GitHub Release" src="https://img.shields.io/github/v/release/MKAbuMattar/asciiquarium-python?color=%232563eb&label=Latest%20Release&style=for-the-badge&logo=github" />
  </a>

  <a href="https://pypi.org/project/asciiquarium/" target="_blank" rel="noreferrer">
    <img src="https://img.shields.io/pypi/v/asciiquarium?style=for-the-badge&logo=pypi&logoColor=white&color=2563eb&label=PyPI" alt="PyPI Version"/>
  </a>

  <a href="https://pypi.org/project/asciiquarium/" target="_blank" rel="noreferrer">
    <img src="https://img.shields.io/pypi/pyversions/asciiquarium?style=for-the-badge&logo=python&logoColor=white&color=2563eb&label=Python" alt="Python Versions"/>
  </a>

  <a href="/LICENSE" target="_blank" rel="noreferrer">
    <img alt="GPL-3.0 License" src="https://img.shields.io/github/license/MKAbuMattar/asciiquarium-python?color=%232563eb&style=for-the-badge&label=License">
  </a>

  <a href="https://github.com/MKAbuMattar/asciiquarium-python/stargazers" target="_blank" rel="noreferrer">
    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/MKAbuMattar/asciiquarium-python?color=%232563eb&label=Stars&style=for-the-badge&logo=github">
  </a>

  <a href="https://pypi.org/project/asciiquarium/" target="_blank" rel="noreferrer">
    <img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/asciiquarium?color=%232563eb&style=for-the-badge&logo=pypi&label=Downloads">
  </a>

  <a href="https://github.com/MKAbuMattar/asciiquarium-python/issues" target="_blank" rel="noreferrer">
    <img alt="GitHub Issues" src="https://img.shields.io/github/issues/MKAbuMattar/asciiquarium-python?color=%232563eb&style=for-the-badge&logo=github&label=Issues">
  </a>
</div>

<br/>

[🌐 Website](https://mkabumattar.com/) • [📦 PyPI](https://pypi.org/project/asciiquarium/) • [🚀 Quick Start](#-installation) • [💬 Support](https://github.com/MKAbuMattar/asciiquarium-python/issues)

<br/>

---

An aquarium/sea animation in ASCII art for your terminal! This is a Python reimplementation of the classic Perl asciiquarium, designed to work cross-platform on Windows, Linux, and macOS.

<!-- ![Asciiquarium Demo](https://raw.githubusercontent.com/MKAbuMattar/asciiquarium-python/master/demo.gif) -->

</div>

## ✨ Features

- 🐟 Multiple fish species with different sizes and colors
- 🦈 Sharks that hunt small fish
- 🐋 Whales with animated water spouts
- 🚢 Ships sailing on the surface
- 🐙 Sea monsters lurking in the depths
- 🌊 Animated blue water lines and seaweed
- 🏰 Castle decoration
- � Blue bubbles rising from fish
- 🎨 Full color support
- ⌨️ Interactive controls
- 🌍 Cross-platform (Windows, Linux, macOS)

## 🚀 Installation

### Using pip (Standard)

```bash
pip install asciiquarium
```

### Using pipx (Isolated)

[pipx](https://pipx.pypa.io/) installs the package in an isolated environment:

```bash
pipx install asciiquarium
```

### Using uv (Modern & Fast)

[uv](https://github.com/astral-sh/uv) is a fast Python package installer:

```bash
# Install with uv
uv pip install asciiquarium

# Or run directly without installing
uvx asciiquarium
```

### Using Poetry (Project Management)

Add to your `pyproject.toml`:

```toml
[tool.poetry.dependencies]
asciiquarium = "^2.0.0"
```

Then install:

```bash
poetry add asciiquarium
```

## 🎯 Usage

After installation, simply run:

```bash
asciiquarium
```

That's it! Enjoy your ASCII aquarium! 🐠

## 🎮 Controls

- **`Q`** or **`q`** - Quit the aquarium
- **`P`** or **`p`** - Pause/unpause the animation
- **`R`** or **`r`** - Redraw and respawn all entities

## � Requirements

- **Python 3.7+** - Works with Python 3.7 through 3.13
- **Terminal** - Any terminal with color support
- **Dependencies** - Automatically handled:
  - `windows-curses` - Auto-installed on Windows only
  - `curses` - Built-in on Linux/macOS

## 🌍 Platform Support

| Platform   | Status             | Notes                          |
| ---------- | ------------------ | ------------------------------ |
| 🪟 Windows | ✅ Fully Supported | Auto-installs `windows-curses` |
| 🐧 Linux   | ✅ Fully Supported | Uses built-in `curses`         |
| 🍎 macOS   | ✅ Fully Supported | Uses built-in `curses`         |

## 📦 What Gets Installed

The package includes:

- Main application and animation engine
- All entity types (fish, sharks, whales, ships, etc.)
- ASCII art designs and color schemes
- Cross-platform terminal handling

**Size:** ~50KB (minimal footprint!)

## 🛠️ Development Installation

If you want to contribute or modify the code:

```bash
# Clone the repository
git clone https://github.com/MKAbuMattar/asciiquarium-python.git
cd asciiquarium-python

# Install in editable mode with development dependencies
uv pip install -e ".[dev]"

# Run from source
python -m asciiquarium.main
```

### Development Requirements

Before submitting any changes, ensure your code passes all checks:

```bash
# Run the formatter
uv run hatch run fmt

# Run linters (must pass without errors)
uv run hatch run lint
```

All contributions must pass both formatting and linting checks before being merged.

## 🌟 Features Details

### Cross-Platform Support

This implementation uses Python's `curses` library and automatically installs `windows-curses` on Windows systems, making it truly cross-platform.

### Entity Types

- **Fish**: 7 different species with unique ASCII art designs and swimming patterns
- **Sharks**: Predators that hunt and eat smaller fish with collision detection
- **Whales**: Large creatures with animated water spout effects
- **Ships**: Sail across the surface of the water
- **Sea Monsters**: Mysterious creatures lurking in the depths
- **Big Fish**: Large colorful fish with randomized color schemes
- **Environment**: Seaweed, castle decorations, and blue water lines
- **Bubbles**: Rise from fish in blue color

### Animation Features

- **Smooth Animation**: 30 FPS for fluid motion
- **Z-depth Layering**: Proper entity overlapping
- **Color Masking**: Detailed multi-color ASCII art
- **Frame Animation**: Multi-frame animations for complex entities
- **Collision Detection**: Sharks interact with small fish
- **Auto Cleanup**: Off-screen entities are automatically removed

## 📁 Project Structure

```
asciiquarium-python/
├── asciiquarium/
│   ├── __init__.py
│   ├── main.py              # Entry point
│   ├── entity.py            # Base entity class
│   ├── animation.py         # Animation engine
│   └── entities/
│       ├── __init__.py
│       ├── fish.py          # Fish entities
│       ├── environment.py   # Environment entities
│       └── special.py       # Special entities (sharks, whales, etc.)
├── pyproject.toml
├── uv.lock
└── README.md
```

## 🎨 Customization

You can easily add new entities by creating them in the appropriate module:

```python
from asciiquarium.entity import Entity

def add_my_entity(old_ent, anim):
    anim.new_entity(
        entity_type='my_type',
        shape=my_ascii_art,
        color=my_color_mask,
        position=[x, y, z],
        callback_args=[dx, dy, dz, frame_speed],
        die_offscreen=True,
        death_cb=add_my_entity,
    )
```

## 🐛 Troubleshooting

### Command Not Found

If `asciiquarium` command is not found after installation:

**On Windows:**

```powershell
# Add Python Scripts to PATH
python -m asciiquarium.main
```

**On Linux/macOS:**

```bash
# Make sure ~/.local/bin is in PATH
export PATH="$HOME/.local/bin:$PATH"
asciiquarium
```

### Windows Issues

The `windows-curses` package is automatically installed on Windows. If you encounter issues:

```bash
pip install --upgrade windows-curses
```

### Terminal Size

Minimum terminal size: **80 columns × 24 rows**

Check your terminal size and resize if needed.

### Color Support

Most modern terminals support colors. If colors don't appear:

- Ensure your terminal emulator supports ANSI colors
- Try a different terminal (Windows Terminal, iTerm2, GNOME Terminal, etc.)

### Python Version

Make sure you're using Python 3.7 or higher:

```bash
python --version
```

## 💡 Tips

- **Full Screen**: Press `F11` in most terminals for fullscreen mode
- **Better Experience**: Use a larger terminal window for more entities
- **Dark Theme**: Works best with dark terminal backgrounds
- **Font**: Use a monospace font for best ASCII art rendering

## 📜 License

**GPL-3.0-or-later**

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

## 🙏 Credits

### Original Asciiquarium

- **Author**: Kirk Baucom
- **Website**: http://robobunny.com/projects/asciiquarium
- **Language**: Perl

### Python Port

- **Author**: Mohammad Abu Mattar
- **Email**: info@mkabumattar.com
- **Website**: https://mkabumattar.com/
- **Repository**: https://github.com/MKAbuMattar/asciiquarium-python

All ASCII art designs and animation concepts are credited to the original author, Kirk Baucom. This Python port maintains the spirit and fun of the original while providing modern cross-platform compatibility.

## 🔗 Links

- 📦 [PyPI Package](https://pypi.org/project/asciiquarium/)
- 🐙 [GitHub Repository](https://github.com/MKAbuMattar/asciiquarium-python)
- 🌐 [Author Website](https://mkabumattar.com/)
- � [Original Perl Version](http://robobunny.com/projects/asciiquarium)

## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## 📊 Package Information

- **Package Name**: `asciiquarium`
- **Version**: `2.0.0`
- **Python**: `>=3.7`
- **License**: `GPL-3.0-or-later`
- **Size**: ~50KB
- **Dependencies**: `windows-curses` (Windows only)

## 🎉 Enjoy!

Relax and enjoy your ASCII aquarium! 🐠🐟🦈🐋🚢🏰🌊

```bash
pip install asciiquarium
asciiquarium
```

---

Made with ❤️ by [Mohammad Abu Mattar](https://mkabumattar.com/)  
Based on the original Perl ASCIIQuarium by Kirk Baucom

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "asciiquarium",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "terminal, ascii, animation, aquarium, cli",
    "author": null,
    "author_email": "Mohammad Abu Mattar <info@mkabumattar.com>",
    "download_url": "https://files.pythonhosted.org/packages/fd/64/af51362a7685afe1e8799a013d9fa432bba93fe8e0e1d92463157d693394/asciiquarium-2.0.1.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\r\n\r\n# \ud83d\udc20 Asciiquarium - Python Edition\r\n\r\n<div align=\"center\">\r\n  <a href=\"https://github.com/MKAbuMattar/asciiquarium-python\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img src=\"https://img.shields.io/badge/github-%23181717.svg?style=for-the-badge&logo=github&logoColor=white\" alt=\"GitHub Repository\"/>\r\n  </a>\r\n\r\n  <a href=\"https://github.com/MKAbuMattar/asciiquarium-python/releases\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img alt=\"GitHub Release\" src=\"https://img.shields.io/github/v/release/MKAbuMattar/asciiquarium-python?color=%232563eb&label=Latest%20Release&style=for-the-badge&logo=github\" />\r\n  </a>\r\n\r\n  <a href=\"https://pypi.org/project/asciiquarium/\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img src=\"https://img.shields.io/pypi/v/asciiquarium?style=for-the-badge&logo=pypi&logoColor=white&color=2563eb&label=PyPI\" alt=\"PyPI Version\"/>\r\n  </a>\r\n\r\n  <a href=\"https://pypi.org/project/asciiquarium/\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img src=\"https://img.shields.io/pypi/pyversions/asciiquarium?style=for-the-badge&logo=python&logoColor=white&color=2563eb&label=Python\" alt=\"Python Versions\"/>\r\n  </a>\r\n\r\n  <a href=\"/LICENSE\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img alt=\"GPL-3.0 License\" src=\"https://img.shields.io/github/license/MKAbuMattar/asciiquarium-python?color=%232563eb&style=for-the-badge&label=License\">\r\n  </a>\r\n\r\n  <a href=\"https://github.com/MKAbuMattar/asciiquarium-python/stargazers\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/MKAbuMattar/asciiquarium-python?color=%232563eb&label=Stars&style=for-the-badge&logo=github\">\r\n  </a>\r\n\r\n  <a href=\"https://pypi.org/project/asciiquarium/\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img alt=\"PyPI Downloads\" src=\"https://img.shields.io/pypi/dm/asciiquarium?color=%232563eb&style=for-the-badge&logo=pypi&label=Downloads\">\r\n  </a>\r\n\r\n  <a href=\"https://github.com/MKAbuMattar/asciiquarium-python/issues\" target=\"_blank\" rel=\"noreferrer\">\r\n    <img alt=\"GitHub Issues\" src=\"https://img.shields.io/github/issues/MKAbuMattar/asciiquarium-python?color=%232563eb&style=for-the-badge&logo=github&label=Issues\">\r\n  </a>\r\n</div>\r\n\r\n<br/>\r\n\r\n[\ud83c\udf10 Website](https://mkabumattar.com/) \u2022 [\ud83d\udce6 PyPI](https://pypi.org/project/asciiquarium/) \u2022 [\ud83d\ude80 Quick Start](#-installation) \u2022 [\ud83d\udcac Support](https://github.com/MKAbuMattar/asciiquarium-python/issues)\r\n\r\n<br/>\r\n\r\n---\r\n\r\nAn aquarium/sea animation in ASCII art for your terminal! This is a Python reimplementation of the classic Perl asciiquarium, designed to work cross-platform on Windows, Linux, and macOS.\r\n\r\n<!-- ![Asciiquarium Demo](https://raw.githubusercontent.com/MKAbuMattar/asciiquarium-python/master/demo.gif) -->\r\n\r\n</div>\r\n\r\n## \u2728 Features\r\n\r\n- \ud83d\udc1f Multiple fish species with different sizes and colors\r\n- \ud83e\udd88 Sharks that hunt small fish\r\n- \ud83d\udc0b Whales with animated water spouts\r\n- \ud83d\udea2 Ships sailing on the surface\r\n- \ud83d\udc19 Sea monsters lurking in the depths\r\n- \ud83c\udf0a Animated blue water lines and seaweed\r\n- \ud83c\udff0 Castle decoration\r\n- \ufffd Blue bubbles rising from fish\r\n- \ud83c\udfa8 Full color support\r\n- \u2328\ufe0f Interactive controls\r\n- \ud83c\udf0d Cross-platform (Windows, Linux, macOS)\r\n\r\n## \ud83d\ude80 Installation\r\n\r\n### Using pip (Standard)\r\n\r\n```bash\r\npip install asciiquarium\r\n```\r\n\r\n### Using pipx (Isolated)\r\n\r\n[pipx](https://pipx.pypa.io/) installs the package in an isolated environment:\r\n\r\n```bash\r\npipx install asciiquarium\r\n```\r\n\r\n### Using uv (Modern & Fast)\r\n\r\n[uv](https://github.com/astral-sh/uv) is a fast Python package installer:\r\n\r\n```bash\r\n# Install with uv\r\nuv pip install asciiquarium\r\n\r\n# Or run directly without installing\r\nuvx asciiquarium\r\n```\r\n\r\n### Using Poetry (Project Management)\r\n\r\nAdd to your `pyproject.toml`:\r\n\r\n```toml\r\n[tool.poetry.dependencies]\r\nasciiquarium = \"^2.0.0\"\r\n```\r\n\r\nThen install:\r\n\r\n```bash\r\npoetry add asciiquarium\r\n```\r\n\r\n## \ud83c\udfaf Usage\r\n\r\nAfter installation, simply run:\r\n\r\n```bash\r\nasciiquarium\r\n```\r\n\r\nThat's it! Enjoy your ASCII aquarium! \ud83d\udc20\r\n\r\n## \ud83c\udfae Controls\r\n\r\n- **`Q`** or **`q`** - Quit the aquarium\r\n- **`P`** or **`p`** - Pause/unpause the animation\r\n- **`R`** or **`r`** - Redraw and respawn all entities\r\n\r\n## \ufffd Requirements\r\n\r\n- **Python 3.7+** - Works with Python 3.7 through 3.13\r\n- **Terminal** - Any terminal with color support\r\n- **Dependencies** - Automatically handled:\r\n  - `windows-curses` - Auto-installed on Windows only\r\n  - `curses` - Built-in on Linux/macOS\r\n\r\n## \ud83c\udf0d Platform Support\r\n\r\n| Platform   | Status             | Notes                          |\r\n| ---------- | ------------------ | ------------------------------ |\r\n| \ud83e\ude9f Windows | \u2705 Fully Supported | Auto-installs `windows-curses` |\r\n| \ud83d\udc27 Linux   | \u2705 Fully Supported | Uses built-in `curses`         |\r\n| \ud83c\udf4e macOS   | \u2705 Fully Supported | Uses built-in `curses`         |\r\n\r\n## \ud83d\udce6 What Gets Installed\r\n\r\nThe package includes:\r\n\r\n- Main application and animation engine\r\n- All entity types (fish, sharks, whales, ships, etc.)\r\n- ASCII art designs and color schemes\r\n- Cross-platform terminal handling\r\n\r\n**Size:** ~50KB (minimal footprint!)\r\n\r\n## \ud83d\udee0\ufe0f Development Installation\r\n\r\nIf you want to contribute or modify the code:\r\n\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/MKAbuMattar/asciiquarium-python.git\r\ncd asciiquarium-python\r\n\r\n# Install in editable mode with development dependencies\r\nuv pip install -e \".[dev]\"\r\n\r\n# Run from source\r\npython -m asciiquarium.main\r\n```\r\n\r\n### Development Requirements\r\n\r\nBefore submitting any changes, ensure your code passes all checks:\r\n\r\n```bash\r\n# Run the formatter\r\nuv run hatch run fmt\r\n\r\n# Run linters (must pass without errors)\r\nuv run hatch run lint\r\n```\r\n\r\nAll contributions must pass both formatting and linting checks before being merged.\r\n\r\n## \ud83c\udf1f Features Details\r\n\r\n### Cross-Platform Support\r\n\r\nThis implementation uses Python's `curses` library and automatically installs `windows-curses` on Windows systems, making it truly cross-platform.\r\n\r\n### Entity Types\r\n\r\n- **Fish**: 7 different species with unique ASCII art designs and swimming patterns\r\n- **Sharks**: Predators that hunt and eat smaller fish with collision detection\r\n- **Whales**: Large creatures with animated water spout effects\r\n- **Ships**: Sail across the surface of the water\r\n- **Sea Monsters**: Mysterious creatures lurking in the depths\r\n- **Big Fish**: Large colorful fish with randomized color schemes\r\n- **Environment**: Seaweed, castle decorations, and blue water lines\r\n- **Bubbles**: Rise from fish in blue color\r\n\r\n### Animation Features\r\n\r\n- **Smooth Animation**: 30 FPS for fluid motion\r\n- **Z-depth Layering**: Proper entity overlapping\r\n- **Color Masking**: Detailed multi-color ASCII art\r\n- **Frame Animation**: Multi-frame animations for complex entities\r\n- **Collision Detection**: Sharks interact with small fish\r\n- **Auto Cleanup**: Off-screen entities are automatically removed\r\n\r\n## \ud83d\udcc1 Project Structure\r\n\r\n```\r\nasciiquarium-python/\r\n\u251c\u2500\u2500 asciiquarium/\r\n\u2502   \u251c\u2500\u2500 __init__.py\r\n\u2502   \u251c\u2500\u2500 main.py              # Entry point\r\n\u2502   \u251c\u2500\u2500 entity.py            # Base entity class\r\n\u2502   \u251c\u2500\u2500 animation.py         # Animation engine\r\n\u2502   \u2514\u2500\u2500 entities/\r\n\u2502       \u251c\u2500\u2500 __init__.py\r\n\u2502       \u251c\u2500\u2500 fish.py          # Fish entities\r\n\u2502       \u251c\u2500\u2500 environment.py   # Environment entities\r\n\u2502       \u2514\u2500\u2500 special.py       # Special entities (sharks, whales, etc.)\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 uv.lock\r\n\u2514\u2500\u2500 README.md\r\n```\r\n\r\n## \ud83c\udfa8 Customization\r\n\r\nYou can easily add new entities by creating them in the appropriate module:\r\n\r\n```python\r\nfrom asciiquarium.entity import Entity\r\n\r\ndef add_my_entity(old_ent, anim):\r\n    anim.new_entity(\r\n        entity_type='my_type',\r\n        shape=my_ascii_art,\r\n        color=my_color_mask,\r\n        position=[x, y, z],\r\n        callback_args=[dx, dy, dz, frame_speed],\r\n        die_offscreen=True,\r\n        death_cb=add_my_entity,\r\n    )\r\n```\r\n\r\n## \ud83d\udc1b Troubleshooting\r\n\r\n### Command Not Found\r\n\r\nIf `asciiquarium` command is not found after installation:\r\n\r\n**On Windows:**\r\n\r\n```powershell\r\n# Add Python Scripts to PATH\r\npython -m asciiquarium.main\r\n```\r\n\r\n**On Linux/macOS:**\r\n\r\n```bash\r\n# Make sure ~/.local/bin is in PATH\r\nexport PATH=\"$HOME/.local/bin:$PATH\"\r\nasciiquarium\r\n```\r\n\r\n### Windows Issues\r\n\r\nThe `windows-curses` package is automatically installed on Windows. If you encounter issues:\r\n\r\n```bash\r\npip install --upgrade windows-curses\r\n```\r\n\r\n### Terminal Size\r\n\r\nMinimum terminal size: **80 columns \u00d7 24 rows**\r\n\r\nCheck your terminal size and resize if needed.\r\n\r\n### Color Support\r\n\r\nMost modern terminals support colors. If colors don't appear:\r\n\r\n- Ensure your terminal emulator supports ANSI colors\r\n- Try a different terminal (Windows Terminal, iTerm2, GNOME Terminal, etc.)\r\n\r\n### Python Version\r\n\r\nMake sure you're using Python 3.7 or higher:\r\n\r\n```bash\r\npython --version\r\n```\r\n\r\n## \ud83d\udca1 Tips\r\n\r\n- **Full Screen**: Press `F11` in most terminals for fullscreen mode\r\n- **Better Experience**: Use a larger terminal window for more entities\r\n- **Dark Theme**: Works best with dark terminal backgrounds\r\n- **Font**: Use a monospace font for best ASCII art rendering\r\n\r\n## \ud83d\udcdc License\r\n\r\n**GPL-3.0-or-later**\r\n\r\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r\n\r\n## \ud83d\ude4f Credits\r\n\r\n### Original Asciiquarium\r\n\r\n- **Author**: Kirk Baucom\r\n- **Website**: http://robobunny.com/projects/asciiquarium\r\n- **Language**: Perl\r\n\r\n### Python Port\r\n\r\n- **Author**: Mohammad Abu Mattar\r\n- **Email**: info@mkabumattar.com\r\n- **Website**: https://mkabumattar.com/\r\n- **Repository**: https://github.com/MKAbuMattar/asciiquarium-python\r\n\r\nAll ASCII art designs and animation concepts are credited to the original author, Kirk Baucom. This Python port maintains the spirit and fun of the original while providing modern cross-platform compatibility.\r\n\r\n## \ud83d\udd17 Links\r\n\r\n- \ud83d\udce6 [PyPI Package](https://pypi.org/project/asciiquarium/)\r\n- \ud83d\udc19 [GitHub Repository](https://github.com/MKAbuMattar/asciiquarium-python)\r\n- \ud83c\udf10 [Author Website](https://mkabumattar.com/)\r\n- \ufffd [Original Perl Version](http://robobunny.com/projects/asciiquarium)\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\n1. Fork the repository\r\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push to the branch (`git push origin feature/AmazingFeature`)\r\n5. Open a Pull Request\r\n\r\n## \ud83d\udcca Package Information\r\n\r\n- **Package Name**: `asciiquarium`\r\n- **Version**: `2.0.0`\r\n- **Python**: `>=3.7`\r\n- **License**: `GPL-3.0-or-later`\r\n- **Size**: ~50KB\r\n- **Dependencies**: `windows-curses` (Windows only)\r\n\r\n## \ud83c\udf89 Enjoy!\r\n\r\nRelax and enjoy your ASCII aquarium! \ud83d\udc20\ud83d\udc1f\ud83e\udd88\ud83d\udc0b\ud83d\udea2\ud83c\udff0\ud83c\udf0a\r\n\r\n```bash\r\npip install asciiquarium\r\nasciiquarium\r\n```\r\n\r\n---\r\n\r\nMade with \u2764\ufe0f by [Mohammad Abu Mattar](https://mkabumattar.com/)  \r\nBased on the original Perl ASCIIQuarium by Kirk Baucom\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An aquarium/sea animation in ASCII art for your terminal",
    "version": "2.0.1",
    "project_urls": {
        "Author Website": "https://mkabumattar.com/",
        "Homepage": "https://mkabumattar.com/",
        "Original Project": "http://robobunny.com/projects/asciiquarium",
        "Repository": "https://github.com/MKAbuMattar/asciiquarium-python"
    },
    "split_keywords": [
        "terminal",
        " ascii",
        " animation",
        " aquarium",
        " cli"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7f43b6db2de363ca130db77991270d6a716ec094ff2fb67910bd9230d12201b4",
                "md5": "8886f22c8eeab0c0e5c51b48f6bb3306",
                "sha256": "379392319ccc5a4efa137e02c02c2f21329bd99bd7bdfdd03d5ff2bed84b1a3a"
            },
            "downloads": -1,
            "filename": "asciiquarium-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8886f22c8eeab0c0e5c51b48f6bb3306",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 31545,
            "upload_time": "2025-10-06T20:47:20",
            "upload_time_iso_8601": "2025-10-06T20:47:20.367449Z",
            "url": "https://files.pythonhosted.org/packages/7f/43/b6db2de363ca130db77991270d6a716ec094ff2fb67910bd9230d12201b4/asciiquarium-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fd64af51362a7685afe1e8799a013d9fa432bba93fe8e0e1d92463157d693394",
                "md5": "d5a0e6ef3ec3027332abaa047323c6f2",
                "sha256": "b8acb5a7d55d944ead7a66f4a5f488dcdc662830207adbdef6884755f7d39940"
            },
            "downloads": -1,
            "filename": "asciiquarium-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d5a0e6ef3ec3027332abaa047323c6f2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 33611,
            "upload_time": "2025-10-06T20:47:21",
            "upload_time_iso_8601": "2025-10-06T20:47:21.660395Z",
            "url": "https://files.pythonhosted.org/packages/fd/64/af51362a7685afe1e8799a013d9fa432bba93fe8e0e1d92463157d693394/asciiquarium-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-06 20:47:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MKAbuMattar",
    "github_project": "asciiquarium-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "asciiquarium"
}