Package: clanimtk
Copyright (c) 2018, Simon LarsénPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 THESOFTWARE.Download-URL: https://github.com/slarse/clanimtk/archive/v0.1.0.tar.gzDescription: # clanimtk - Command Line Animation Toolkit[![Build Status](https://travis-ci.org/slarse/clanimtk.svg?branch=master)](https://travis-ci.org/slarse/clanimtk)[![Code Coverage](https://codecov.io/gh/slarse/clanimtk/branch/master/graph/badge.svg)](https://codecov.io/gh/slarse/clanimtk)[![Documentation Status](https://readthedocs.org/projects/clanimtk/badge/?version=latest)](https://clanimtk.readthedocs.io/en/latest/)[![PyPi Version](https://badge.fury.io/py/clanimtk.svg)](https://badge.fury.io/py/clanimtk)[![Supported Python Versions](https://img.shields.io/badge/python-3.5%2C%203.6-blue.svg)](https://badge.fury.io/py/clanimtk)![Scrolling text animation example](docs/images/hello_world.gif)> The `scrolling_text` animation can be found in the> [`clanim`](https://github.com/slarse/clanim) package, which contains some> examples of how one can use `clanimtk`.### Overview`clanimtk` (Command Line Animation Toolkit) is a toolkit for quickly creatingcustom command line animations. It is most suitable for long-running tasks thatare primarily I/O bound, as the animations themselves will require some CPUtime. It is strongly recommended to have a look at the brief introduction inthe [Docs](https://clanimtk.readthedocs.io/en/latest/) before using `clanimtk`.If you just want to dive right in without reading any documentation, here is aminimal example.```pythonimport timefrom clanimtk import animation, animate@animationdef hashes():return (("#" * i).ljust(4) for i in range(5))@animate(animation=hashes()) # note that the Animation is called to produce an AnimationGeneratordef sleep(duration):time.sleep(duration)return 42```which results in the folowing animation:![Simple animation](docs/images/example_animation.gif)The whole thing is explained in detail in the[Docs](https://clanimtk.readthedocs.io/en/latest/).### Requirements`clanimtk` is pure Python, so all you need is Python 3.6 or higher and aterminal emulator that supports[ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code)(which most terminal emulators do!).### Install#### Option 1: Install release version from PyPi with `pip`The latest release of `clanimtk` is on PyPi, and can thus be installed as with`pip install clanimtk` (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 uploadedto 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/clanimtk`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`.### LicenseThis software is licensed under the MIT License. See the [LICENSE](LICENSE)file for specifics.### ContributingI gladly accept contributions if they are in line with my vision for thetoolkit (which is hard to put into words). If you have an idea that you wantto discuss with me, don't hesitate to contact me! Most welcome additions aretests, documentation as well as overall improvements to the core animationloop (which is currently threaded and not particularly efficient).Platform: UNKNOWN