clanim 0.2.0

Overview

This package contains decorators for printing a command line animation while the decorated function runs. It is very similar to the decorating package, which currently has way more features and probably serves you better then clanim. I wanted to create clanim anyway as a means of practicing with decorators and command line animations. It doesn’t seem like decorating currently supports async functions, so that’s the one area where clanim potentially is superior at this time.

Requirements

Python 3.6 or higher and the daiquiri package (used for development and will probably be removed in a final release).

Quickstart

The user API for clanim is contained wholly on the package level. That is to say, only the imports available from clanim is intended for non-developers. clanim works both for regular functions, as well as async functions. Most notably, there are the animate and annotate decorators. animate is the core decorator used to animate functions, and annotate is used to display messages before and/or after an animated function.

Here are som minimal examples:

import time
from clanim import animate, scrolling_text

# if no parameter is given, the default arrow animation is used
@animate
def slow(n):
    time.sleep(n)

# scrolling_text is a large, scrolling text animation
# step determines the time between frames
@animate(animation=scrolling_text("Crunching numbers ..."), step=0.05)
def fibo(n):
    if n < 0:
        raise ValueError("Undefined for n < 0")
    fibo_recursive(n)

def fibo_recursive(n):
    if n == 0 or n == 1:
        return n
    return fibo(n-1) + fibo(n-2)

The biggest new addition to the 0.2.0 release is the scrolling_text animation, which is demonstrated below.

Install

Wanted improvements

• Add more animations

• Decouple animation update from rendering

• Add support for recursive functions

License

This software is licensed under the MIT License. See the license file file for specifics.

Contributing

I will happily take contributions, especially in terms of new animations. Submit a pull request if you have an idea, and let me approve the idea before you put serious work into something I would not like in the project!