Skip to main content

ASCII Terminal Animation Package

Project description

bruhanimate

Downloads

Downloads

Downloads

snow fireworks

Supported Python versions

bruhanimate provides a set of tools for creating and rendering animations directly in the terminal. Designed for ease of use, this package enables developers to incorporate dynamic animations into command-line applications. While drawing inspiration from existing terminal animation libraries, bruhanimate brings a fresh approach and offers a unique set of features tailored for flexibility and creativity in terminal-based projects.

Inspired by the Asciimatics package.

Installation

From PyPI

pip install --upgrade bruhanimate

From source

git clone https://github.com/FNBBDevs/bruhanimate

cd bruhanimate

python -m pip install .

Quick Start

Use some of the built in demos to see what is possible. There are demos for each effect. Simply import <effect>_demo from bruhanimate and call the <effect>_demo.run() to run the demo!

  • static

  • offset

  • noise

  • stars

  • snow

  • rain

  • plasma

  • gol (Conway's Game of Life)

  • matrix

  • twinkle

# Import a demo

from bruhanimate import plasma_demo

# run the demo

plasma_demo.run()

Usage

Here are some examples on how bruhanimate might be used.

Pass in arguments through the show() command.

"""

Here is a simple program that uses the EffectRenderer passing in

the arguments to the main function

"""

from bruhanimate import Screen, CenterRenderer, images





def demo(screen, img, frames, time, effect_type, background, transparent):

    renderer = CenterRenderer(screen, frames, time, img, effect_type, background, transparent)

    renderer.update_smart_transparent(True)

    renderer.effect.update_color(True)

    renderer.effect.update_intensity(100)

    renderer.run()





def main():

    Screen.show(demo, args=(images.get_image("twopoint"), 300, 0, "noise", " ", False))





if __name__ == "__main__":

    main()

Set the arguments directly in the function invoked by show().

"""

Here is a simple program that uses the EffectRenderer setting the arguments

directly in the main function.

"""

from bruhanimate import Screen, EffectRenderer





def demo(screen: Screen):

    renderer = EffectRenderer(

        screen=screen,

        frames=float("inf"),

        frame_time=0.1,

        effect_type="snow",

        background=" ",

        transparent=False

    )

    renderer.run()





if __name__ == "__main__":

    Screen.show(main)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bruhanimate-0.2.80.tar.gz (66.2 kB view details)

Uploaded Source

File details

Details for the file bruhanimate-0.2.80.tar.gz.

File metadata

  • Download URL: bruhanimate-0.2.80.tar.gz
  • Upload date:
  • Size: 66.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for bruhanimate-0.2.80.tar.gz
Algorithm Hash digest
SHA256 300422d428ea2ab63b98c600df556bc2e27c73076fd3272d3113a9b12ee56405
MD5 ac35009f9201a7a788bba5b5d1e3c444
BLAKE2b-256 efcbead82d80bd2bac52485673d92134704f33d9808295af43fbdb8c420e4522

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page