Skip to main content

Command line animations built with clanimtk.

Project description

Copyright (c) 2017, Simon Larsén

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Download-URL: https://github.com/slarse/clanim/archive/v0.3.0.tar.gz
Description: # clanim - Command Line Animations

[![Build Status](https://travis-ci.org/slarse/clanim.svg?branch=master)](https://travis-ci.org/slarse/clanim)
[![Code Coverage](https://codecov.io/gh/slarse/clanim/branch/master/graph/badge.svg)](https://codecov.io/gh/slarse/clanim)
[![Documentation Status](https://readthedocs.org/projects/clanim/badge/?version=latest)](https://clanim.readthedocs.io/en/latest/)
[![PyPi Version](https://badge.fury.io/py/clanim.svg)](https://badge.fury.io/py/clanim)
[![Supported Python Verstions](https://img.shields.io/badge/python-3.5%2C%203.6-blue.svg)](https://badge.fury.io/py/clanim)

![Scrolling text animation example](docs/images/hello_world.gif)

### Overview
`clanim` is a collection of made command line animations that can easily
be applied to pretty much any (non-recursive) function. The animations are
built with the [`clanimtk`](https://github.com/slarse/clanimtk) package, and
are mostly meant to serve as examples of how to use it.

### Requirements

Python 3.6 or higher and the `clanimtk` package.

### Quickstart

Here are som minimal examples of using `clanim`:

```python
import time
from clanimtk import animate
from clanim import 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)

# this recursive function must be wrapped in a non-recursive function
# before it can be animated
def fibo_recursive(n):
if n == 0 or n == 1:
return n
return fibo(n-1) + fibo(n-2)
```

### Install

#### Option 1: Install from PyPi with `pip`

The latest release of `clanim` is on PyPi, and can thus be installed as with
`pip install clanim` (with your own preferred options, of course).

#### Option 2: Clone the repo and the install with `pip`

If you want the dev version, you will need to clone the repo, as only release
versions are uploaded to PyPi. Unless you are planning to work on this
yourself, I suggest going with the release version.

1. Clone the repo with `git`:
- `git clone https://github.com/slarse/clanim`
2. `cd` into the project root directory and install with `pip`.
- `pip install --user .`, this will create a local install for the current user.
- Or just `pip install .` if you use `virtualenv`.
- For development, use `pip install -e .` in a `virtualenv`.

### Wanted improvements

* Add more animations

### License

This software is licensed under the MIT License. See the [LICENSE](LICENSE)
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!

Platform: UNKNOWN
Description-Content-Type: text/markdown

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
clanim-0.3.0-py3-none-any.whl (17.1 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 16, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page